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

Class EPPStatusSet

java.lang.Object
com.verisign.epp.codec.statusset.v02.EPPStatusSet
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPStatusSet extends Object implements EPPCodecComponent
EPPStatusSet is used to define Status Set assigned to domain and host objects in a command. This class is used in the EPPStatusSetCreate and EPPStatusSetCreate. The additional Status Set attribute populated by the server are available in EPPStatusSetData that is returned in the info response.
See Also:

  • Field Details

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      Constant for the "statusSet" local name
      See Also:

    • ELM_NAME

      public static final String ELM_NAME
      Constant for the phase qualified name (prefix and local name)
      See Also:

    • ATTR_STATUSSET_NAME

      public static final String ATTR_STATUSSET_NAME
      XML name for the status set name attribute
      See Also:

  • Constructor Details

    • EPPStatusSet

      public EPPStatusSet()
      Default constructor, where the required attributes must be set prior to calling encode(Document).

    • EPPStatusSet

      public EPPStatusSet(String aName)
      Constructor for EPPStatusSet that takes the required attributes.
      Parameters:
      aName - The unique name for the Status Set that is up to server policy.

  • Method Details

    • getName

      public String getName()
      Gets the unique name for the Status Set that is up to server policy.
      Returns:
      the unique name for the Status Set

    • setName

      public void setName(String aName)
      Sets the unique name for the Status Set that is up to server policy.
      Parameters:
      aName - Unique name for the Status Set

    • getReason

      public String getReason()
      Gets an OPTIONAL free-form text reason that Status Set was assigned to the object.
      Returns:
      the reason if set; null otherwise.

    • setReason

      public void setReason(String aReason)
      Sets an OPTIONAL free-form text reason that Status Set was assigned to the object.
      Parameters:
      aReason - The reason to set. Set to null to unset.

    • hasAttributes

      public boolean hasAttributes()
      Are the status set attributes defined?
      Returns:
      true if the status set attributes are defined; false otherwise.

    • getAttributes

      public List<EPPStatusSetAttribute> getAttributes()
      Gets the list of status set attributes if defined.
      Returns:
      List of status set attributes if defined; null otherwise.

    • addAttribute

      public void addAttribute(EPPStatusSetAttribute aAttribute)
      Adds a status set attribute to the list of status set attributes.
      Parameters:
      aAttribute - The status set attribute to add.

    • setAttributes

      public void setAttributes(List<EPPStatusSetAttribute> aAttributes)
      Sets the list of status set attributes.
      Parameters:
      aAttributes - The status set attributes to set. Set to null to unset.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPStatusSet instance.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPStatusSet
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPStatusSet instance.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element - Root DOM Element representing the EPPStatusSet instance.
      Throws:
      EPPEncodeException - - Unable to encode EPPStatusSet instance.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPStatusSet element aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - - Root DOM Element to decode EPPStatusSet from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPStatusSet compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPStatusSet instance to compare with
      Returns:
      true if equal; false otherwise

    • 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.

    • getNamespace

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