Class EPPChangeCaseId
- java.lang.Object
-
- com.verisign.epp.codec.changepoll.EPPChangeCaseId
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPChangeCaseId extends java.lang.Object implements EPPCodecComponent
Change Case Identifier that includes both the identifier as well as the case type.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
Constant for the phase local namestatic java.lang.String
ELM_NAME
Constant for the phase qualified name (prefix and local name)static java.lang.String
TYPE_CUSTOM
A custom case that is defined using the "name" attribute.static java.lang.String
TYPE_UDRP
A Uniform Domain-Name Dispute-Resolution Policy (UDRP) case.static java.lang.String
TYPE_URS
A Uniform Rapid Suspension (URS) case.
-
Constructor Summary
Constructors Constructor Description EPPChangeCaseId()
Default constructor.EPPChangeCaseId(java.lang.String aIdentifier, java.lang.String aType)
CreateEPPChangeCaseId
instance with the required identifier and type attributes.EPPChangeCaseId(java.lang.String aIdentifier, java.lang.String aType, java.lang.String aName)
CreateEPPChangeCaseId
instance all of the attributes including the identifier, type, and custom type name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPChangeCaseId
instance.void
decode(org.w3c.dom.Element aElement)
Decode theEPPChangeCaseId
element aElement DOM Element tree.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPChangeCaseId
instance.boolean
equals(java.lang.Object aObject)
Implements a deepEPPChangeCaseId
compare.java.lang.String
getIdentifier()
Gets the case identifier value.java.lang.String
getName()
Gets the name of the case type, which is used when the type is set to theTYPE_CUSTOM
value.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.lang.String
getType()
Gets the case type.boolean
hasName()
Is the name defined?void
setName(java.lang.String aName)
Sets the name of the case type, which is used when the type is set to theTYPE_CUSTOM
value.void
setType(java.lang.String aType)
Sets the case type.void
setValue(java.lang.String aIdentifier)
Sets the case identifier value.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
TYPE_UDRP
public static final java.lang.String TYPE_UDRP
A Uniform Domain-Name Dispute-Resolution Policy (UDRP) case.- See Also:
- Constant Field Values
-
TYPE_URS
public static final java.lang.String TYPE_URS
A Uniform Rapid Suspension (URS) case.- See Also:
- Constant Field Values
-
TYPE_CUSTOM
public static final java.lang.String TYPE_CUSTOM
A custom case that is defined using the "name" attribute.- See Also:
- Constant Field Values
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
Constant for the phase local name- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
Constant for the phase qualified name (prefix and local name)- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPChangeCaseId
public EPPChangeCaseId()
Default constructor. The identifier value MUST be set using thesetValue(String)
method and the type MUST be set using thesetType(String)
.
-
EPPChangeCaseId
public EPPChangeCaseId(java.lang.String aIdentifier, java.lang.String aType)
CreateEPPChangeCaseId
instance with the required identifier and type attributes.- Parameters:
aIdentifier
- Case identifier value.aType
- Case type using one of theTYPE
constants.
-
EPPChangeCaseId
public EPPChangeCaseId(java.lang.String aIdentifier, java.lang.String aType, java.lang.String aName)
CreateEPPChangeCaseId
instance all of the attributes including the identifier, type, and custom type name.- Parameters:
aIdentifier
- Case identifier value.aType
- Case type using one of theTYPE
constants.aName
- Name of the type whenaType
is set with theTYPE_CUSTOM
value.
-
-
Method Detail
-
getIdentifier
public java.lang.String getIdentifier()
Gets the case identifier value.- Returns:
- Case identifier value if defined;
null
otherwise.
-
setValue
public void setValue(java.lang.String aIdentifier)
Sets the case identifier value.- Parameters:
aIdentifier
- Case identifier
-
getType
public java.lang.String getType()
Gets the case type. The case type should use one of theTYPE
constant values.- Returns:
- Case type if defined;
null
otherwise.
-
setType
public void setType(java.lang.String aType)
Sets the case type. The case type should use one of theTYPE
constant values.- Parameters:
aType
- One of theTYPE
constant values.
-
hasName
public boolean hasName()
Is the name defined?- Returns:
true
if the name is defined;false
otherwise.
-
getName
public java.lang.String getName()
Gets the name of the case type, which is used when the type is set to theTYPE_CUSTOM
value.- Returns:
- The type name if defined;
null
otherwise.
-
setName
public void setName(java.lang.String aName)
Sets the name of the case type, which is used when the type is set to theTYPE_CUSTOM
value.- Parameters:
aName
- The custom type name.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPChangeCaseId
instance.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPChangeCaseId
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPChangeCaseId
element aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- - Root DOM Element to decodeEPPChangeCaseId
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPChangeCaseId
instance.- Specified by:
encode
in interfaceEPPCodecComponent
- 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 encodeEPPChangeCaseId
instance.
-
equals
public boolean equals(java.lang.Object aObject)
Implements a deepEPPChangeCaseId
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPChangeCaseId
instance to compare with- Returns:
true
if equal;false
otherwise
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-