Package com.verisign.epp.codec.statusset.v02

Class EPPStatusSetUpdate

java.lang.Object
com.verisign.epp.codec.statusset.v02.EPPStatusSetAuthTokenList
com.verisign.epp.codec.statusset.v02.EPPStatusSetUpdate
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPStatusSetUpdate extends EPPStatusSetAuthTokenList
Status Set Update Extension that enables a client to update the status sets with the option of authorizing using authentication tokens.
See Also:

  • Field Details

  • Constructor Details

    • EPPStatusSetUpdate

      public EPPStatusSetUpdate()
      Default constructor for EPPStatusSetUpdate.

    • EPPStatusSetUpdate

      public EPPStatusSetUpdate(EPPAuthTokenData aAuthToken)
      Constructor for EPPStatusSetUpdate that takes a single authentication token.
      Parameters:
      aAuthToken - A single authentication token

    • EPPStatusSetUpdate

      public EPPStatusSetUpdate(List<EPPAuthTokenData> aAuthTokens)
      Constructor for EPPStatusSetUpdate that a list of authentication token.
      Parameters:
      aAuthTokens - A list of authentication tokens

  • Method Details

    • getLocalName

      protected String getLocalName()
      Returns the local name "update" for the update extension.
      Specified by:
      getLocalName in class EPPStatusSetAuthTokenList
      Returns:
      Local name "update" for the update extension.

    • hasAddStatusSets

      public boolean hasAddStatusSets()
      Are the add status sets defined?
      Returns:
      true if the add status sets are defined; false otherwise.

    • getAddStatusSets

      public List<EPPStatusSet> getAddStatusSets()
      Gets the list of add status sets if defined.
      Returns:
      List of add status sets if defined; null otherwise.

    • addAddStatusSet

      public void addAddStatusSet(String aAddStatusSetName)
      Adds a status set name to the list of add status sets.
      Parameters:
      aAddStatusSetName - The status set name to add to the add status sets.

    • addAddStatusSet

      public void addAddStatusSet(EPPStatusSet aAddStatusSet)
      Adds a status set to the list of add status sets.
      Parameters:
      aAddStatusSet - The status set to add to the add status sets.

    • setAddStatusSets

      public void setAddStatusSets(List<EPPStatusSet> aAddStatusSets)
      Sets the list of add status sets.
      Parameters:
      aAddStatusSets - The add status sets to set. Set to null to unset to add status sets.

    • hasRemStatusSets

      public boolean hasRemStatusSets()
      Are the remove status sets defined?
      Returns:
      true if the remove status sets are defined; false otherwise.

    • getRemStatusSets

      public List<EPPStatusSet> getRemStatusSets()
      Gets the list of remove status sets if defined.
      Returns:
      List of remove status sets if defined; null otherwise.

    • addRemStatusSet

      public void addRemStatusSet(String aRemStatusSetName)
      Adds a status set name to the list of remove status sets.
      Parameters:
      aRemStatusSetName - The status set name to add to the remove status sets.

    • addRemStatusSet

      public void addRemStatusSet(EPPStatusSet aRemStatusSet)
      Adds a status set to the list of remove status sets.
      Parameters:
      aRemStatusSet - The status set to add to the remove status sets.

    • hasChgStatusSets

      public boolean hasChgStatusSets()
      Are the change status sets defined?
      Returns:
      true if the change status sets are defined; false otherwise.

    • getChgStatusSets

      public List<EPPStatusSet> getChgStatusSets()
      Gets the list of change status sets if defined.
      Returns:
      List of change status sets if defined; null otherwise.

    • addChgStatusSet

      public void addChgStatusSet(String aChgStatusSetName)
      Adds a status set name to the list of change status sets.
      Parameters:
      aChgStatusSetName - The status set name to add to the change status sets.

    • addChgStatusSet

      public void addChgStatusSet(EPPStatusSet aChgStatusSet)
      Adds a status set to the list of change status sets.
      Parameters:
      aChgStatusSet - The status set to add to the change status sets.

    • setChgStatusSets

      public void setChgStatusSets(List<EPPStatusSet> aChgStatusSets)
      Sets the list of change status sets.
      Parameters:
      aChgStatusSets - The change status sets to set. Set to null to unset to remove status sets.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode of a EPPStatusSetUpdate instance
      Specified by:
      encode in interface EPPCodecComponent
      Overrides:
      encode in class EPPStatusSetAuthTokenList
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPStatusSetUpdate

    • 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
      Overrides:
      decode in class EPPStatusSetAuthTokenList
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • equals

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

    • clone

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

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Returns:
      XML namespace for the EPPCodecComponent.