Package com.verisign.epp.codec.nameWatch
Class EPPNameWatchStatus
- java.lang.Object
-
- com.verisign.epp.codec.nameWatch.EPPNameWatchStatus
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPNameWatchStatus extends java.lang.Object implements EPPCodecComponent
Represents a nameWatch Status. A nameWatch object MUST always have at least one associated status value. Status values MAY be set only by the client that sponsors a nameWatch object and by the server on which the object resides. A client MAY change the status of a nameWatch object using the EPP <update> command. Each status value MAY be accompanied by a string of human-readable text that describes the rationale for the status applied to the object.
A client MUST NOT alter status values set by the server. A server MAY alter or override status values set by a client subject to local server policies.
Status values that may be added or removed by a client are prefixed with "client". Corresponding status values that may be added or removed by a server are prefixed with "server". Status values that do not begin with either "client" or "server" are server-managed.
Status Value Descriptions:
- clientDeleteProhibited, serverDeleteProhibited: Requests to delete the object MUST be rejected.
- clientHold, serverHold: Delegation information MUST be withheld from publication in the object's nominal zone.
- clientRenewProhibited, serverRenewProhibited: Requests to renew the object MUST be rejected.
- clientTransferProhibited, serverTransferProhibited: Requests to transfer the object MUST be rejected.
- clientUpdateProhibited, serverUpdateProhibited: Requests to update the object (other than to remove this status) MUST be rejected.
- ok: This is the nominal status value for an object that has no pending perations or prohibitions.
- pendingDelete: A delete request has been received for the object, but the object has not yet been purged from the server database.
- pendingTransfer: A transfer request has been received for the object, and completion of the request is pending. Transform commands other than <transfer> MUST be rejected while an object is in this state.
-
ok
status MUST NOT be combined with any other status. -
pendingDelete
status MUST NOT be combined with either -
clientDeleteProhibited
orserverDeleteProhibited
status. -
pendingTransfer
status MUST NOT be combined with eitherclientTransferProhibited
orserverTransferProhibited
status. - Allother status value combinations are valid.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_DEFAULT_LANG
Default Language -- English "en"static java.lang.String
ELM_STATUS_CLIENT_DELETE_PROHIBITED
Value of the client delete prohibited status in nameWatch mappingstatic java.lang.String
ELM_STATUS_CLIENT_HOLD
Value of the client hold status in nameWatch mappingstatic java.lang.String
ELM_STATUS_CLIENT_RENEW_PROHIBITED
Value of the client renew prohibited status in nameWatch mappingstatic java.lang.String
ELM_STATUS_CLIENT_TRANSFER_PROHIBITED
Value of the client transfer prohibited status in nameWatch mappingstatic java.lang.String
ELM_STATUS_CLIENT_UPDATE_PROHIBITED
Value of the client update prohibited status in nameWatch mappingstatic java.lang.String
ELM_STATUS_OK
Value of the OK status in nameWatch mappingstatic java.lang.String
ELM_STATUS_PENDING_DELETE
Value of the pending delete status in nameWatch mappingstatic java.lang.String
ELM_STATUS_PENDING_TRANSFER
Value of the pending transfer status in nameWatch mappingstatic java.lang.String
ELM_STATUS_SERVER_DELETE_PROHIBITED
Value of the server delete prohibited status in nameWatch mappingstatic java.lang.String
ELM_STATUS_SERVER_HOLD
Value of the server hold status in nameWatch mappingstatic java.lang.String
ELM_STATUS_SERVER_RENEW_PROHIBITED
Value of the server renew prohibited status in nameWatch mappingstatic java.lang.String
ELM_STATUS_SERVER_TRANSFER_PROHIBITED
Value of the server transfer prohibited status in nameWatch mappingstatic java.lang.String
ELM_STATUS_SERVER_UPDATE_PROHIBITED
Value of the server update prohibited status in nameWatch mapping
-
Constructor Summary
Constructors Constructor Description EPPNameWatchStatus()
EPPNameWatchStatus
default constructor.EPPNameWatchStatus(java.lang.String aStatus)
EPPNameWatchStatus
constructor that takes the namewatch status as argument.EPPNameWatchStatus(java.lang.String aStatus, java.lang.String aDesc)
EPPNameWatchStatus
constructor that takes the namewatch status and a status description.EPPNameWatchStatus(java.lang.String aStatus, java.lang.String aDesc, java.lang.String aLang)
EPPNameWatchStatus
constructor that takes the namewatch status and the language as arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPNameWatchStatus
.void
decode(org.w3c.dom.Element aElement)
Decode the EPPNameWatchStatus attributes from the aElement DOM Element tree.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the EPPNameWatchStatus instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPNameWatchStatus
compare.java.lang.String
getDescription()
Gets the status description, which is free form text describing the rationale for the status.java.lang.String
getLang()
Get language of the status.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.lang.String
getStatus()
Get namewatch status.void
setDescription(java.lang.String aDesc)
Sets the status description, which is free form text describing the rationale for the status.void
setLang(java.lang.String newLang)
Set language of namewatch status.void
setStatus(java.lang.String newStatus)
Set namewatch status.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_STATUS_OK
public static final java.lang.String ELM_STATUS_OK
Value of the OK status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_SERVER_HOLD
public static final java.lang.String ELM_STATUS_SERVER_HOLD
Value of the server hold status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_SERVER_RENEW_PROHIBITED
public static final java.lang.String ELM_STATUS_SERVER_RENEW_PROHIBITED
Value of the server renew prohibited status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_SERVER_TRANSFER_PROHIBITED
public static final java.lang.String ELM_STATUS_SERVER_TRANSFER_PROHIBITED
Value of the server transfer prohibited status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_SERVER_UPDATE_PROHIBITED
public static final java.lang.String ELM_STATUS_SERVER_UPDATE_PROHIBITED
Value of the server update prohibited status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_SERVER_DELETE_PROHIBITED
public static final java.lang.String ELM_STATUS_SERVER_DELETE_PROHIBITED
Value of the server delete prohibited status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_PENDING_DELETE
public static final java.lang.String ELM_STATUS_PENDING_DELETE
Value of the pending delete status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_PENDING_TRANSFER
public static final java.lang.String ELM_STATUS_PENDING_TRANSFER
Value of the pending transfer status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_CLIENT_HOLD
public static final java.lang.String ELM_STATUS_CLIENT_HOLD
Value of the client hold status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_DEFAULT_LANG
public static final java.lang.String ELM_DEFAULT_LANG
Default Language -- English "en"- See Also:
- Constant Field Values
-
ELM_STATUS_CLIENT_TRANSFER_PROHIBITED
public static final java.lang.String ELM_STATUS_CLIENT_TRANSFER_PROHIBITED
Value of the client transfer prohibited status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_CLIENT_UPDATE_PROHIBITED
public static final java.lang.String ELM_STATUS_CLIENT_UPDATE_PROHIBITED
Value of the client update prohibited status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_CLIENT_RENEW_PROHIBITED
public static final java.lang.String ELM_STATUS_CLIENT_RENEW_PROHIBITED
Value of the client renew prohibited status in nameWatch mapping- See Also:
- Constant Field Values
-
ELM_STATUS_CLIENT_DELETE_PROHIBITED
public static final java.lang.String ELM_STATUS_CLIENT_DELETE_PROHIBITED
Value of the client delete prohibited status in nameWatch mapping- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPNameWatchStatus
public EPPNameWatchStatus()
EPPNameWatchStatus
default constructor.
-
EPPNameWatchStatus
public EPPNameWatchStatus(java.lang.String aStatus)
EPPNameWatchStatus
constructor that takes the namewatch status as argument.- Parameters:
aStatus
- String NameWatch staus
-
EPPNameWatchStatus
public EPPNameWatchStatus(java.lang.String aStatus, java.lang.String aDesc)
EPPNameWatchStatus
constructor that takes the namewatch status and a status description.- Parameters:
aStatus
- NameWatch status which should be one of theELM_STATUS
constants.aDesc
- A description of the status change
-
EPPNameWatchStatus
public EPPNameWatchStatus(java.lang.String aStatus, java.lang.String aDesc, java.lang.String aLang)
EPPNameWatchStatus
constructor that takes the namewatch status and the language as arguments.- Parameters:
aStatus
- NameWatch status which should be one of theELM_STATUS
constants.aDesc
- A description of the status changeaLang
- Language of the status description
-
-
Method Detail
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPNameWatchStatus
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPNameWatchStatus
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode the EPPNameWatchStatus attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- - Root DOM Element to decode EPPNameWatchStatus 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 the EPPNameWatchStatus 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 EPPNameWatchStatus instance.
- Throws:
EPPEncodeException
- - Unable to encode EPPNameWatchStatus instance.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPNameWatchStatus
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPNameWatchStatus
instance to compare with- Returns:
- DOCUMENT ME!
-
getLang
public java.lang.String getLang()
Get language of the status.- Returns:
- String Language
-
getStatus
public java.lang.String getStatus()
Get namewatch status.- Returns:
- String NameWatch Status
-
setLang
public void setLang(java.lang.String newLang)
Set language of namewatch status.- Parameters:
newLang
- String
-
setStatus
public void setStatus(java.lang.String newStatus)
Set namewatch status.- Parameters:
newStatus
- String
-
getDescription
public java.lang.String getDescription()
Gets the status description, which is free form text describing the rationale for the status.- Returns:
- DOCUMENT ME!
-
setDescription
public void setDescription(java.lang.String aDesc)
Sets the status description, which is free form text describing the rationale for the status.- Parameters:
aDesc
- status description
-
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
.
-
-