Class EPPMaintenanceListItem
- java.lang.Object
-
- com.verisign.epp.codec.maintenance.v1_0.EPPMaintenanceListItem
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPMaintenanceListItem extends java.lang.Object implements EPPCodecComponent
Represents a maintenance list item that includes the following child elements:
- <maint:id> element that is the maintenance identifier.
- <maint:start> element that is the maintenance start date and time.
- <maint:end> element that is the maintenance end date and time.
- <maint:crDate> element that represents the created date and time for the maintenance.
- An OPTIONAL <maint:upDate> element that represents the updated date and time for the maintenance.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPMaintenanceItem
.static java.lang.String
ELM_NAME
XML root tag forEPPMaintenanceItem
.
-
Constructor Summary
Constructors Constructor Description EPPMaintenanceListItem()
Default constructor forEPPMaintenanceItem
.EPPMaintenanceListItem(EPPMaintenanceId aMaintenanceId, java.util.Date aStartDate, java.util.Date aEndDate, java.util.Date aCreatedDate)
Constructor forEPPMaintenanceItem
with all of the required attributes as parameters.EPPMaintenanceListItem(EPPMaintenanceId aMaintenanceId, java.util.Date aStartDate, java.util.Date aEndDate, java.util.Date aCreatedDate, java.util.Date aLastUpdatedDate)
Constructor forEPPMaintenanceItem
with all of the attributes as parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPMaintenanceItem
.void
decode(org.w3c.dom.Element aElement)
Decode theEPPMaintenanceItem
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 theEPPMaintenanceItem
instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPMaintenanceItem
compare.java.util.Date
getCreatedDate()
Gets the maintenance created date.java.util.Date
getEndDate()
Gets the optional maintenance end date and time.java.util.Date
getLastUpdatedDate()
Gets the optional maintenance last updated date.EPPMaintenanceId
getMaintenanceId()
Gets the maintenance identifier.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.util.Date
getStartDate()
Gets the optional maintenance start date and time.boolean
hasEndDate()
Is the end date defined?boolean
hasLastUpdatedDate()
Is the last updated date defined?boolean
hasStartdDate()
Is the start date defined?void
setCreatedDate(java.util.Date aCreatedDate)
Sets the maintenance created date.void
setEndDate(java.util.Date aEndDate)
Sets the optional maintenance end date and time.void
setLastUpdatedDate(java.util.Date aLastUpdatedDate)
Sets the maintenance last updated date.void
setMaintenanceId(EPPMaintenanceId aMaintenanceId)
Sets the maintenance identifier.void
setStartDate(java.util.Date aStartDate)
Sets the optional maintenance start date and time.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 forEPPMaintenanceItem
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPMaintenanceItem
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPMaintenanceListItem
public EPPMaintenanceListItem()
Default constructor forEPPMaintenanceItem
. All the the attributes default tonull
. Must call required setter methods before invokingencode(Document)
, which include:
- maintenance identifier -
setMaintenanceId(EPPMaintenanceId)
- maintenance created date -
setCreatedDate(Date)
- maintenance identifier -
-
EPPMaintenanceListItem
public EPPMaintenanceListItem(EPPMaintenanceId aMaintenanceId, java.util.Date aStartDate, java.util.Date aEndDate, java.util.Date aCreatedDate)
Constructor forEPPMaintenanceItem
with all of the required attributes as parameters.- Parameters:
aMaintenanceId
- Maintenance identifieraStartDate
- Maintenance start date and timeaEndDate
- Maintenance end date and timeaCreatedDate
- Maintenance created date
-
EPPMaintenanceListItem
public EPPMaintenanceListItem(EPPMaintenanceId aMaintenanceId, java.util.Date aStartDate, java.util.Date aEndDate, java.util.Date aCreatedDate, java.util.Date aLastUpdatedDate)
Constructor forEPPMaintenanceItem
with all of the attributes as parameters.- Parameters:
aMaintenanceId
- Maintenance identifieraStartDate
- Maintenance start date. Set tonull
if undefined.aEndDate
- Maintenance end date. Set tonull
if undefined.aCreatedDate
- Maintenance created dateaLastUpdatedDate
- Maintenance last updated date. Set tonull
if undefined.
-
-
Method Detail
-
getMaintenanceId
public EPPMaintenanceId getMaintenanceId()
Gets the maintenance identifier.- Returns:
- The maintenance identifier if defined;
null
otherwise.
-
setMaintenanceId
public void setMaintenanceId(EPPMaintenanceId aMaintenanceId)
Sets the maintenance identifier.- Parameters:
aMaintenanceId
- The maintenance identifier.
-
hasStartdDate
public boolean hasStartdDate()
Is the start date defined?- Returns:
true
if the start date is defined;false
otherwise.
-
getStartDate
public java.util.Date getStartDate()
Gets the optional maintenance start date and time.- Returns:
- start date and time if defined;
null
otherwise.
-
setStartDate
public void setStartDate(java.util.Date aStartDate)
Sets the optional maintenance start date and time.- Parameters:
aStartDate
- Maintenance start date and time. Set tonull
if undefined.
-
hasEndDate
public boolean hasEndDate()
Is the end date defined?- Returns:
true
if the end date is defined;false
otherwise.
-
getEndDate
public java.util.Date getEndDate()
Gets the optional maintenance end date and time.- Returns:
- end date and time if defined;
null
otherwise.
-
setEndDate
public void setEndDate(java.util.Date aEndDate)
Sets the optional maintenance end date and time.- Parameters:
aEndDate
- Maintenance end date and time. Set tonull
if undefined.
-
getCreatedDate
public java.util.Date getCreatedDate()
Gets the maintenance created date.- Returns:
- Maintenance created date if defined;
null
otherwise.
-
setCreatedDate
public void setCreatedDate(java.util.Date aCreatedDate)
Sets the maintenance created date.- Parameters:
aCreatedDate
- Maintenance created date
-
hasLastUpdatedDate
public boolean hasLastUpdatedDate()
Is the last updated date defined?- Returns:
true
if the last updated date is defined;false
otherwise.
-
getLastUpdatedDate
public java.util.Date getLastUpdatedDate()
Gets the optional maintenance last updated date.- Returns:
- Maintenance last updated date if defined;
null
otherwise.
-
setLastUpdatedDate
public void setLastUpdatedDate(java.util.Date aLastUpdatedDate)
Sets the maintenance last updated date.- Parameters:
aLastUpdatedDate
- Maintenance last updated date
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPMaintenanceItem
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPMaintenanceItem
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPMaintenanceItem
instance.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPMaintenanceItem
attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- Root DOM Element to decodeEPPMaintenanceItem
from.- Throws:
EPPDecodeException
- Unable to decode aElement.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPMaintenanceItem
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPMaintenanceItem
instance to compare with- Returns:
true
ofaObject
is equal to instance;false
otherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPMaintenanceItem
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPMaintenanceItem
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
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.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-