|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.changepoll.EPPChangeData
public class EPPChangeData
Change Data information that is added as an extension to a poll message containing the info response of the object that was changed to define the what, when, who, and why for the change.
Field Summary | |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for EPPChangePoll . |
static java.lang.String |
ELM_NAME
XML root tag for EPPChangePoll . |
static java.lang.String |
STATE_AFTER
Object reflects the state after the operation. |
static java.lang.String |
STATE_BEFORE
Object reflects the state before the operation. |
Constructor Summary | |
---|---|
EPPChangeData()
Default constructor for EPPChangePoll . |
|
EPPChangeData(EPPChangeOperation aOperation,
java.util.Date aDate,
java.lang.String aSvrTrid,
java.lang.String aWho)
Constructor for EPPChangePoll that takes the required
attributes. |
|
EPPChangeData(EPPChangeOperation aOperation,
java.util.Date aDate,
java.lang.String aSvrTrid,
java.lang.String aWho,
java.lang.String aState,
EPPChangeCaseId aCaseId,
java.lang.String aReason,
java.lang.String aReasonLang)
Constructor for EPPChangePoll that takes the all attributes. |
Method Summary | |
---|---|
java.lang.Object |
clone()
clone an EPPCodecComponent . |
void |
decode(org.w3c.dom.Element aElement)
decode a DOM element tree to initialize the instance attributes. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode instance into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of EPPChangePoll with this instance. |
EPPChangeCaseId |
getCaseId()
Gets the case identifier for the change. |
java.util.Date |
getDate()
Gets the date and time when the operation was executed. |
EPPChangeOperation |
getOperation()
Gets the transform operation executed on the object. |
java.lang.String |
getReason()
Gets the reason value. |
java.lang.String |
getReasonLang()
Gets the reason language value. |
java.lang.String |
getState()
Gets whether the object reflects the state before or after the operation. |
java.lang.String |
getSvrTrid()
Gets the server transaction identifier of the operation. |
java.lang.String |
getWho()
Gets who executed the operation. |
boolean |
hasCaseId()
Is the case identifier defined? |
boolean |
hasReason()
Is the reason defined? |
boolean |
hasReasonLang()
Is the reason language defined? |
void |
setCaseId(EPPChangeCaseId aCaseId)
Sets the case identifier for the change. |
void |
setDate(java.util.Date aDate)
Sets the date and time when the operation was executed. |
void |
setOperation(EPPChangeOperation aOperation)
Sets the transform operation executed on the object. |
void |
setReason(java.lang.String aReason)
Sets the reason value. |
void |
setReasonLang(java.lang.String aReasonLang)
Sets the reason language value. |
void |
setState(java.lang.String aState)
Sets whether the object reflects the state before or after the operation. |
void |
setSvrTrid(java.lang.String aSvrTrid)
Sets the server transaction identifier of the operation. |
void |
setWho(java.lang.String aWho)
Sets who executed the operation. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ELM_LOCALNAME
EPPChangePoll
.
public static final java.lang.String ELM_NAME
EPPChangePoll
.
public static final java.lang.String STATE_BEFORE
public static final java.lang.String STATE_AFTER
Constructor Detail |
---|
public EPPChangeData()
EPPChangePoll
.
public EPPChangeData(EPPChangeOperation aOperation, java.util.Date aDate, java.lang.String aSvrTrid, java.lang.String aWho)
EPPChangePoll
that takes the required
attributes.
aOperation
- Transform operation executed on the object.aDate
- Date and time when the operation was executed.aSvrTrid
- Server transaction identifier of the operation.aWho
- Who executed the operation.public EPPChangeData(EPPChangeOperation aOperation, java.util.Date aDate, java.lang.String aSvrTrid, java.lang.String aWho, java.lang.String aState, EPPChangeCaseId aCaseId, java.lang.String aReason, java.lang.String aReasonLang)
EPPChangePoll
that takes the all attributes.
aOperation
- Transform operation executed on the object.aDate
- Date and time when the operation was executed.aSvrTrid
- Server transaction identifier of the operation.aWho
- Who executed the operation.aState
- Does the object reflect the state before or after the
operation using STATE_BEFORE
and
STATE_AFTER
constants, respectively.aCaseId
- Optional case identifier for the change. Set to
null
if there is no case.aReason
- Reason for executing the operation. Set to null
for no reason.aReasonLang
- Language for the reason. Set to null
to use the
default value of "en".Method Detail |
---|
public java.lang.String getState()
STATE_BEFORE
to indicate that the object
reflects the before state or STATE_AFTER
to indicate
that the object reflects the after state.public void setState(java.lang.String aState)
aState
- STATE_BEFORE
constant for before state and
STATE_AFTER
for after state.public EPPChangeOperation getOperation()
null
otherwise.public void setOperation(EPPChangeOperation aOperation)
aOperation
- The transform operation executed on the object..public java.util.Date getDate()
null
otherwise.public void setDate(java.util.Date aDate)
aDate
- The date and time when the operation was executed.public java.lang.String getSvrTrid()
null
otherwise.public void setSvrTrid(java.lang.String aSvrTrid)
aSvrTrid
- The server transaction identifier of the operation.public java.lang.String getWho()
null
otherwise.public void setWho(java.lang.String aWho)
aWho
- Who executed the operation.public boolean hasCaseId()
true
if the case identifier is defined;
false
otherwise.public EPPChangeCaseId getCaseId()
null
otherwise.public void setCaseId(EPPChangeCaseId aCaseId)
aCaseId
- The case identifier for the change.public boolean hasReason()
true
if the reason is defined; false
otherwise.public java.lang.String getReason()
null
otherwise.public void setReason(java.lang.String aReason)
aReason
- Reason for executing the operation.public boolean hasReasonLang()
true
if the reason language is defined;
false
otherwise.public java.lang.String getReasonLang()
null
otherwise.public void setReasonLang(java.lang.String aReasonLang)
aReasonLang
- Reason language for reason value.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- DOM Document, which acts is an Element factory
EPPEncodeException
- Error encoding EPPChangePoll
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
aElement
argument represents the root DOM element and is
used to traverse the DOM nodes for instance attribute values.
decode
in interface EPPCodecComponent
aElement
- Element
to decode
EPPDecodeException
- Error decoding Element
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCodecComponent
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPChangePoll
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.public boolean equals(java.lang.Object aObject)
EPPChangePoll
with this instance.
equals
in class java.lang.Object
aObject
- Object to compare with.
true
if equal; false
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |