Class EPPRegistryBatchJob
- java.lang.Object
-
- com.verisign.epp.codec.registry.v02.EPPRegistryBatchJob
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPRegistryBatchJob extends java.lang.Object implements EPPCodecComponent
EPPRegistryBatchJob
contains the information for an individual batch job.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPRegistryBatchJob
.static java.lang.String
ELM_NAME
XML root tag forEPPRegistryBatchJob
.
-
Constructor Summary
Constructors Constructor Description EPPRegistryBatchJob()
Default constructor forEPPRegistryBatchJob
.EPPRegistryBatchJob(java.lang.String aName, EPPRegistryBatchSchedule aSchedule)
EPPRegistryBatchJob
constructor that the required name and an individual schedule.EPPRegistryBatchJob(java.lang.String aName, EPPRegistryBatchSchedule aSchedule, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the required name, an individual schedule, along with an optional description.EPPRegistryBatchJob(java.lang.String aName, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the name and the optional description.EPPRegistryBatchJob(java.lang.String aName, java.util.List<EPPRegistryBatchSchedule> aSchedules, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the required name, a list of schedules, along with an optional description.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addSchedule(EPPRegistryBatchSchedule aSchedule)
Adds a schedule to the list of batch job schedules.java.lang.Object
clone()
CloneEPPRegistryBatchJob
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPRegistryBatchJob
attributes from the aElement DOM Element tree.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPRegistryBatchJob
instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPRegistryBatchJob
compare.java.lang.String
getDescription()
Gets the OPTIONAL free-form description of batch job, like "Auto Renew Batch" or "Pending Delete Batch".java.lang.String
getName()
Gets the name of the batch job, like "autoRenew" or "pendingDelete".java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.util.List<EPPRegistryBatchSchedule>
getSchedules()
Gets theList
ofEPPRegistryBatchSchedule
instances containing the batch job schedules.boolean
hasDescription()
Is the description defined?boolean
hasName()
Is the name defined?boolean
hasSchedules()
Is the schedules defined?void
setDescription(java.lang.String aDescription)
Sets the OPTIONAL free-form description of batch job, like "Auto Renew Batch" or "Pending Delete Batch".void
setName(java.lang.String aName)
Sets the name of the batch job, like "autoRenew" or "pendingDelete".void
setSchedules(java.util.List<EPPRegistryBatchSchedule> aSchedules)
Sets theList
ofEPPRegistryBatchSchedule
instances containing the batch job schedules.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPRegistryBatchJob
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPRegistryBatchJob
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPRegistryBatchJob
public EPPRegistryBatchJob()
Default constructor forEPPRegistryBatchJob
.
-
EPPRegistryBatchJob
public EPPRegistryBatchJob(java.lang.String aName, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the name and the optional description. At least one schedule must be set. individual schedule.- Parameters:
aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aDescription
- Description of the batch job
-
EPPRegistryBatchJob
public EPPRegistryBatchJob(java.lang.String aName, EPPRegistryBatchSchedule aSchedule)
EPPRegistryBatchJob
constructor that the required name and an individual schedule.- Parameters:
aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedule
- An individual batch schedule using XML schema "time" type format
-
EPPRegistryBatchJob
public EPPRegistryBatchJob(java.lang.String aName, EPPRegistryBatchSchedule aSchedule, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the required name, an individual schedule, along with an optional description.- Parameters:
aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedule
- An individual batch schedule using the XML schema "time" type formataDescription
- Description of the batch job
-
EPPRegistryBatchJob
public EPPRegistryBatchJob(java.lang.String aName, java.util.List<EPPRegistryBatchSchedule> aSchedules, java.lang.String aDescription)
EPPRegistryBatchJob
constructor that the required name, a list of schedules, along with an optional description.- Parameters:
aName
- Name of the batch job, like "autoRenew" or "pendingDelete".aSchedules
- A list of schedules with each schedule using the XML schema "time" type formataDescription
- Description of the batch job
-
-
Method Detail
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPRegistryBatchJob
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPRegistryBatchJob
instance. - Throws:
EPPEncodeException
- - Unable to encodeEPPRegistryBatchJob
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPRegistryBatchJob
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPRegistryBatchJob
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPRegistryBatchJob
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPRegistryBatchJob
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPRegistryBatchJob
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPRegistryBatchJob
instance to compare with- Returns:
true
if this object is the same as the aObject argument;false
otherwise
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
hasName
public boolean hasName()
Is the name defined?- Returns:
true
if the name is defined;false
otherwise.
-
getName
public java.lang.String getName()
Gets the name of the batch job, like "autoRenew" or "pendingDelete".- Returns:
- Name of the batch job if defined;
null
otherwise.
-
setName
public void setName(java.lang.String aName)
Sets the name of the batch job, like "autoRenew" or "pendingDelete".- Parameters:
aName
- Name of the batch job
-
hasDescription
public boolean hasDescription()
Is the description defined?- Returns:
true
if the description is defined;false
otherwise.
-
getDescription
public java.lang.String getDescription()
Gets the OPTIONAL free-form description of batch job, like "Auto Renew Batch" or "Pending Delete Batch".- Returns:
- batch job description if defined;
null
otherwise.
-
setDescription
public void setDescription(java.lang.String aDescription)
Sets the OPTIONAL free-form description of batch job, like "Auto Renew Batch" or "Pending Delete Batch".- Parameters:
aDescription
- the description to set
-
hasSchedules
public boolean hasSchedules()
Is the schedules defined?- Returns:
true
if the schedules is defined;false
otherwise.
-
getSchedules
public java.util.List<EPPRegistryBatchSchedule> getSchedules()
Gets theList
ofEPPRegistryBatchSchedule
instances containing the batch job schedules.- Returns:
List
ofEPPRegistryBatchSchedule
instances if defined;null
otherwise.
-
setSchedules
public void setSchedules(java.util.List<EPPRegistryBatchSchedule> aSchedules)
Sets theList
ofEPPRegistryBatchSchedule
instances containing the batch job schedules.- Parameters:
aSchedules
-List
ofEPPRegistryBatchSchedule
instances
-
addSchedule
public void addSchedule(EPPRegistryBatchSchedule aSchedule)
Adds a schedule to the list of batch job schedules.- Parameters:
aSchedule
- Schedule to add to the list of batch job schedules
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-