org.opennms.netmgt.config.provisiond

Class RequisitionDef

java.lang.Object

org.opennms.netmgt.config.provisiond.RequisitionDef

All Implemented Interfaces:

Serializable

public class RequisitionDef
extends Object
implements Serializable

Defines an import job with a cron expression http://quartz.sourceforge.net/javadoc/org/quartz/CronTrigger.html Field Name Allowed Values Allowed Special Characters Seconds 0-59 , - / Minutes 0-59 , - / Hours 0-23 , - / Day-of-month 1-31 , - ? / L W C Month 1-12 or JAN-DEC , - / Day-of-Week 1-7 or SUN-SAT , - ? / L C # Year (Opt) empty, 1970-2099 , - /

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RequisitionDef()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Overrides the java.lang.Object.equals method.
String	getCronSchedule() Returns the value of field 'cronSchedule'.
String	getImportName() Returns the value of field 'importName'.
String	getImportUrlResource() Returns the value of field 'importUrlResource'.
int	hashCode() Overrides the java.lang.Object.hashCode method.
boolean	isValid() Method isValid.
void	marshal(ContentHandler handler)
void	marshal(Writer out)
void	setCronSchedule(String cronSchedule) Sets the value of field 'cronSchedule'.
void	setImportName(String importName) Sets the value of field 'importName'.
void	setImportUrlResource(String importUrlResource) Sets the value of field 'importUrlResource'.
static RequisitionDef	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

RequisitionDef

public RequisitionDef()

Method Detail

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.

getCronSchedule

public String getCronSchedule()

Returns the value of field 'cronSchedule'.

Returns:

the value of field 'CronSchedule'.

getImportName

public String getImportName()

Returns the value of field 'importName'.

Returns:

the value of field 'ImportName'.

getImportUrlResource

public String getImportUrlResource()

Returns the value of field 'importUrlResource'.

Returns:

the value of field 'ImportUrlResource'.

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.

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

setCronSchedule

public void setCronSchedule(String cronSchedule)

Sets the value of field 'cronSchedule'.

Parameters:

cronSchedule - the value of field 'cronSchedule'.

setImportName

public void setImportName(String importName)

Sets the value of field 'importName'.

Parameters:

importName - the value of field 'importName'.

setImportUrlResource

public void setImportUrlResource(String importUrlResource)

Sets the value of field 'importUrlResource'.

Parameters:

importUrlResource - the value of field 'importUrlResource'.

unmarshal

public static RequisitionDef 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.provisiond.RequisitionDef

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