Package com.verisign.epp.codec.changepoll

Class EPPChangeCaseId

java.lang.Object
com.verisign.epp.codec.changepoll.EPPChangeCaseId
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPChangeCaseId extends Object implements EPPCodecComponent
Change Case Identifier that includes both the identifier as well as the case type.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    Constant for the phase local name
    static final String
    ELM_NAME
    Constant for the phase qualified name (prefix and local name)
    static final String
    TYPE_CUSTOM
    A custom case that is defined using the "name" attribute.
    static final String
    TYPE_UDRP
    A Uniform Domain-Name Dispute-Resolution Policy (UDRP) case.
    static final String
    TYPE_URS
    A Uniform Rapid Suspension (URS) case.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPChangeCaseId()
    Default constructor.
    EPPChangeCaseId(String aIdentifier, String aType)
    Create EPPChangeCaseId instance with the required identifier and type attributes.
    EPPChangeCaseId(String aIdentifier, String aType, String aName)
    Create EPPChangeCaseId instance all of the attributes including the identifier, type, and custom type name.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPChangeCaseId instance.
    void
    decode(Element aElement)
    Decode the EPPChangeCaseId element aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPChangeCaseId instance.
    boolean
    equals(Object aObject)
    Implements a deep EPPChangeCaseId compare.
    String
    getIdentifier()
    Gets the case identifier value.
    String
    getName()
    Gets the name of the case type, which is used when the type is set to the TYPE_CUSTOM value.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getType()
    Gets the case type.
    boolean
    hasName()
    Is the name defined?
    void
    setName(String aName)
    Sets the name of the case type, which is used when the type is set to the TYPE_CUSTOM value.
    void
    setType(String aType)
    Sets the case type.
    void
    setValue(String aIdentifier)
    Sets the case identifier value.
    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 Details

  • Constructor Details

    • EPPChangeCaseId

      public EPPChangeCaseId()
      Default constructor. The identifier value MUST be set using the setValue(String) method and the type MUST be set using the setType(String).

    • EPPChangeCaseId

      public EPPChangeCaseId(String aIdentifier, String aType)
      Create EPPChangeCaseId instance with the required identifier and type attributes.
      Parameters:
      aIdentifier - Case identifier value.
      aType - Case type using one of the TYPE constants.

    • EPPChangeCaseId

      public EPPChangeCaseId(String aIdentifier, String aType, String aName)
      Create EPPChangeCaseId instance all of the attributes including the identifier, type, and custom type name.
      Parameters:
      aIdentifier - Case identifier value.
      aType - Case type using one of the TYPE constants.
      aName - Name of the type when aType is set with the TYPE_CUSTOM value.

  • Method Details

    • getIdentifier

      public String getIdentifier()
      Gets the case identifier value.
      Returns:
      Case identifier value if defined; null otherwise.

    • setValue

      public void setValue(String aIdentifier)
      Sets the case identifier value.
      Parameters:
      aIdentifier - Case identifier

    • getType

      public String getType()
      Gets the case type. The case type should use one of the TYPE constant values.
      Returns:
      Case type if defined; null otherwise.

    • setType

      public void setType(String aType)
      Sets the case type. The case type should use one of the TYPE constant values.
      Parameters:
      aType - One of the TYPE constant values.

    • hasName

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

    • getName

      public String getName()
      Gets the name of the case type, which is used when the type is set to the TYPE_CUSTOM value.
      Returns:
      The type name if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the name of the case type, which is used when the type is set to the TYPE_CUSTOM value.
      Parameters:
      aName - The custom type name.

    • clone

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

    • decode

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

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPChangeCaseId 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 EPPChangeCaseId instance.
      Throws:
      EPPEncodeException - - Unable to encode EPPChangeCaseId instance.

    • equals

      public boolean equals(Object aObject)
      Implements a deep EPPChangeCaseId compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPChangeCaseId 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.