Package com.verisign.epp.codec.changepoll

Class EPPChangeData

java.lang.Object
com.verisign.epp.codec.changepoll.EPPChangeData
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPChangeData extends Object implements EPPCodecComponent
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.
See Also:

  • Field Details

  • Constructor Details

    • EPPChangeData

      public EPPChangeData()
      Default constructor for EPPChangePoll.

    • EPPChangeData

      public EPPChangeData(EPPChangeOperation aOperation, Date aDate, String aSvrTrid, String aWho)
      Constructor for EPPChangePoll that takes the required attributes.
      Parameters:
      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.

    • EPPChangeData

      public EPPChangeData(EPPChangeOperation aOperation, Date aDate, String aSvrTrid, String aWho, String aState, EPPChangeCaseId aCaseId, String aReason, String aReasonLang)
      Constructor for EPPChangePoll that takes the all attributes.
      Parameters:
      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 Details

    • getState

      public String getState()
      Gets whether the object reflects the state before or after the operation.
      Returns:
      Either STATE_BEFORE to indicate that the object reflects the before state or STATE_AFTER to indicate that the object reflects the after state.

    • setState

      public void setState(String aState)
      Sets whether the object reflects the state before or after the operation.
      Parameters:
      aState - STATE_BEFORE constant for before state and STATE_AFTER for after state.

    • getOperation

      public EPPChangeOperation getOperation()
      Gets the transform operation executed on the object.
      Returns:
      The transform operation if defined; null otherwise.

    • setOperation

      public void setOperation(EPPChangeOperation aOperation)
      Sets the transform operation executed on the object.
      Parameters:
      aOperation - The transform operation executed on the object..

    • getDate

      public Date getDate()
      Gets the date and time when the operation was executed.
      Returns:
      The date and time when the operation was executed if defined; null otherwise.

    • setDate

      public void setDate(Date aDate)
      Sets the date and time when the operation was executed.
      Parameters:
      aDate - The date and time when the operation was executed.

    • getSvrTrid

      public String getSvrTrid()
      Gets the server transaction identifier of the operation.
      Returns:
      the svrTrid Server transaction identifier of the operation if defined; null otherwise.

    • setSvrTrid

      public void setSvrTrid(String aSvrTrid)
      Sets the server transaction identifier of the operation.
      Parameters:
      aSvrTrid - The server transaction identifier of the operation.

    • getWho

      public String getWho()
      Gets who executed the operation.
      Returns:
      Who executed the operation if defined; null otherwise.

    • setWho

      public void setWho(String aWho)
      Sets who executed the operation.
      Parameters:
      aWho - Who executed the operation.

    • hasCaseId

      public boolean hasCaseId()
      Is the case identifier defined?
      Returns:
      true if the case identifier is defined; false otherwise.

    • getCaseId

      public EPPChangeCaseId getCaseId()
      Gets the case identifier for the change.
      Returns:
      Case identifier if defined; null otherwise.

    • setCaseId

      public void setCaseId(EPPChangeCaseId aCaseId)
      Sets the case identifier for the change.
      Parameters:
      aCaseId - The case identifier for the change.

    • hasReason

      public boolean hasReason()
      Is the reason defined?
      Returns:
      true if the reason is defined; false otherwise.

    • getReason

      public String getReason()
      Gets the reason value.
      Returns:
      Reason value if defined; null otherwise.

    • setReason

      public void setReason(String aReason)
      Sets the reason value.
      Parameters:
      aReason - Reason for executing the operation.

    • hasReasonLang

      public boolean hasReasonLang()
      Is the reason language defined?
      Returns:
      true if the reason language is defined; false otherwise.

    • getReasonLang

      public String getReasonLang()
      Gets the reason language value.
      Returns:
      Reason language if defined; null otherwise.

    • setReasonLang

      public void setReasonLang(String aReasonLang)
      Sets the reason language value.
      Parameters:
      aReasonLang - Reason language for reason value.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPChangePoll

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • clone

      public Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPChangePoll
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • toString

      public String toString()
      Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
      Overrides:
      toString in class Object
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPChangePoll with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.