|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.nameWatch.EPPNameWatchStatus
public class EPPNameWatchStatus
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:
ok
status MUST NOT be combined with any other status.
pendingDelete
status MUST NOT be combined with either
clientDeleteProhibited
or serverDeleteProhibited
status.
pendingTransfer
status MUST NOT be combined with either
clientTransferProhibited
or
serverTransferProhibited
status.
Field Summary | |
---|---|
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 mapping |
static java.lang.String |
ELM_STATUS_CLIENT_HOLD
Value of the client hold status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_CLIENT_RENEW_PROHIBITED
Value of the client renew prohibited status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_CLIENT_TRANSFER_PROHIBITED
Value of the client transfer prohibited status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_CLIENT_UPDATE_PROHIBITED
Value of the client update prohibited status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_OK
Value of the OK status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_PENDING_DELETE
Value of the pending delete status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_PENDING_TRANSFER
Value of the pending transfer status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_SERVER_DELETE_PROHIBITED
Value of the server delete prohibited status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_SERVER_HOLD
Value of the server hold status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_SERVER_RENEW_PROHIBITED
Value of the server renew prohibited status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_SERVER_TRANSFER_PROHIBITED
Value of the server transfer prohibited status in nameWatch mapping |
static java.lang.String |
ELM_STATUS_SERVER_UPDATE_PROHIBITED
Value of the server update prohibited status in nameWatch mapping |
Constructor Summary | |
---|---|
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 | |
---|---|
java.lang.Object |
clone()
Clone EPPNameWatchStatus . |
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 deep EPPNameWatchStatus 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 |
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 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 Detail |
---|
public static final java.lang.String ELM_STATUS_OK
public static final java.lang.String ELM_STATUS_SERVER_HOLD
public static final java.lang.String ELM_STATUS_SERVER_RENEW_PROHIBITED
public static final java.lang.String ELM_STATUS_SERVER_TRANSFER_PROHIBITED
public static final java.lang.String ELM_STATUS_SERVER_UPDATE_PROHIBITED
public static final java.lang.String ELM_STATUS_SERVER_DELETE_PROHIBITED
public static final java.lang.String ELM_STATUS_PENDING_DELETE
public static final java.lang.String ELM_STATUS_PENDING_TRANSFER
public static final java.lang.String ELM_STATUS_CLIENT_HOLD
public static final java.lang.String ELM_DEFAULT_LANG
public static final java.lang.String ELM_STATUS_CLIENT_TRANSFER_PROHIBITED
public static final java.lang.String ELM_STATUS_CLIENT_UPDATE_PROHIBITED
public static final java.lang.String ELM_STATUS_CLIENT_RENEW_PROHIBITED
public static final java.lang.String ELM_STATUS_CLIENT_DELETE_PROHIBITED
Constructor Detail |
---|
public EPPNameWatchStatus()
EPPNameWatchStatus
default constructor.
public EPPNameWatchStatus(java.lang.String aStatus)
EPPNameWatchStatus
constructor that takes the namewatch
status as argument.
aStatus
- String NameWatch stauspublic EPPNameWatchStatus(java.lang.String aStatus, java.lang.String aDesc)
EPPNameWatchStatus
constructor that takes the namewatch
status and a status description.
aStatus
- NameWatch status which should be one of the
ELM_STATUS
constants.aDesc
- A description of the status changepublic 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.
aStatus
- NameWatch status which should be one of the
ELM_STATUS
constants.aDesc
- A description of the status changeaLang
- Language of the status descriptionMethod Detail |
---|
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPNameWatchStatus
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPNameWatchStatus
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode
in interface EPPCodecComponent
aElement
- - Root DOM Element to decode EPPNameWatchStatus from.
EPPDecodeException
- Unable to decode aElementpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- - DOM Document that is being built. Used as an Element
factory.
EPPEncodeException
- - Unable to encode EPPNameWatchStatus
instance.public boolean equals(java.lang.Object aObject)
EPPNameWatchStatus
compare.
equals
in class java.lang.Object
aObject
- EPPNameWatchStatus
instance to compare with
public java.lang.String getLang()
public java.lang.String getStatus()
public void setLang(java.lang.String newLang)
newLang
- Stringpublic void setStatus(java.lang.String newStatus)
newStatus
- Stringpublic java.lang.String getDescription()
public void setDescription(java.lang.String aDesc)
aDesc
- status descriptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |