org.opennms.netmgt.config.vacuumd

Class Automation

java.lang.Object

org.opennms.netmgt.config.vacuumd.Automation

All Implemented Interfaces:

Serializable

public class Automation
extends Object
implements Serializable

Triggers and Actions hooked up and run by the Vacuumd schedule using interval for frequency

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Automation()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteActive()
void	deleteInterval()
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getActionEvent() Returns the value of field 'actionEvent'.
String	getActionName() Returns the value of field 'actionName'.
boolean	getActive() Returns the value of field 'active'.
String	getAutoEventName() Returns the value of field 'autoEventName'.
int	getInterval() Returns the value of field 'interval'.
String	getName() Returns the value of field 'name'.
String	getTriggerName() Returns the value of field 'triggerName'.
boolean	hasActive() Method hasActive.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	hasInterval() Method hasInterval.
boolean	isActive() Returns the value of field 'active'.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setActionEvent(String actionEvent) Sets the value of field 'actionEvent'.
void	setActionName(String actionName) Sets the value of field 'actionName'.
void	setActive(boolean active) Sets the value of field 'active'.
void	setAutoEventName(String autoEventName) Sets the value of field 'autoEventName'.
void	setInterval(int interval) Sets the value of field 'interval'.
void	setName(String name) Sets the value of field 'name'.
void	setTriggerName(String triggerName) Sets the value of field 'triggerName'.
static Automation	unmarshal(Reader reader) Method unmarshal.
void	validate()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Automation

public Automation()

Method Detail

deleteActive

public void deleteActive()

deleteInterval

public void deleteInterval()

equals

public boolean equals(Object obj)

Overrides the java.lang.Object.equals method.

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if the objects are equal.

getActionEvent

public String getActionEvent()

Returns the value of field 'actionEvent'. The field 'actionEvent' has the following description: Create an Event from Result of Trigger

Returns:

the value of field 'ActionEvent'.

getActionName

public String getActionName()

Returns the value of field 'actionName'. The field 'actionName' has the following description: reference an action from the collection of actions

Returns:

the value of field 'ActionName'.

getActive

public boolean getActive()

Returns the value of field 'active'. The field 'active' has the following description: enable/disable this automation

Returns:

the value of field 'Active'.

getAutoEventName

public String getAutoEventName()

Returns the value of field 'autoEventName'. The field 'autoEventName' has the following description: specify an event UEI to send

Returns:

the value of field 'AutoEventName'.

getInterval

public int getInterval()

Returns the value of field 'interval'. The field 'interval' has the following description: How ofter should this autmation run

Returns:

the value of field 'Interval'.

getName

public String getName()

Returns the value of field 'name'. The field 'name' has the following description: The name of this automation

Returns:

the value of field 'Name'.

getTriggerName

public String getTriggerName()

Returns the value of field 'triggerName'. The field 'triggerName' has the following description: reference a trigger from the collection of triggers

Returns:

the value of field 'TriggerName'.

hasActive

public boolean hasActive()

Method hasActive.

Returns:

true if at least one Active has been added

hasInterval

public boolean hasInterval()

Method hasInterval.

Returns:

true if at least one Interval has been added

hashCode

public int hashCode()

Overrides the java.lang.Object.hashCode method.

The following steps came from Effective Java Programming Language Guide by Joshua Bloch, Chapter 3

Overrides:

hashCode in class Object

Returns:

a hash code value for the object.

isActive

public boolean isActive()

Returns the value of field 'active'. The field 'active' has the following description: enable/disable this automation

Returns:

the value of field 'Active'.

isValid

public boolean isValid()

Method isValid.

Returns:

true if this object is valid according to the schema

marshal

public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Parameters:

handler -

Throws:

IOException - if an IOException occurs during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

setActionEvent

public void setActionEvent(String actionEvent)

Sets the value of field 'actionEvent'. The field 'actionEvent' has the following description: Create an Event from Result of Trigger

Parameters:

actionEvent - the value of field 'actionEvent'.

setActionName

public void setActionName(String actionName)

Sets the value of field 'actionName'. The field 'actionName' has the following description: reference an action from the collection of actions

Parameters:

actionName - the value of field 'actionName'.

setActive

public void setActive(boolean active)

Sets the value of field 'active'. The field 'active' has the following description: enable/disable this automation

Parameters:

active - the value of field 'active'.

setAutoEventName

public void setAutoEventName(String autoEventName)

Sets the value of field 'autoEventName'. The field 'autoEventName' has the following description: specify an event UEI to send

Parameters:

autoEventName - the value of field 'autoEventName'.

setInterval

public void setInterval(int interval)

Sets the value of field 'interval'. The field 'interval' has the following description: How ofter should this autmation run

Parameters:

interval - the value of field 'interval'.

setName

public void setName(String name)

Sets the value of field 'name'. The field 'name' has the following description: The name of this automation

Parameters:

name - the value of field 'name'.

setTriggerName

public void setTriggerName(String triggerName)

Sets the value of field 'triggerName'. The field 'triggerName' has the following description: reference a trigger from the collection of triggers

Parameters:

triggerName - the value of field 'triggerName'.

unmarshal

public static Automation unmarshal(Reader reader)
                            throws org.exolab.castor.xml.MarshalException,
                                   org.exolab.castor.xml.ValidationException

Method unmarshal.

Parameters:

reader -

Returns:

the unmarshaled org.opennms.netmgt.config.vacuumd.Automation

Throws:

org.exolab.castor.xml.MarshalException - if object is null or if any SAXException is thrown during marshaling

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Throws:

org.exolab.castor.xml.ValidationException - if this object is an invalid instance according to the schema