|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.defReg.EPPDefRegStatus
public class EPPDefRegStatus
Represents a defReg Status. A defReg object MUST always have at least one
associated status value. Status values MAY be set only by the client that
sponsors a defReg object and by the server on which the object resides. A
client MAY change the status of a defReg 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 defReg mapping |
static java.lang.String |
ELM_STATUS_CLIENT_RENEW_PROHIBITED
Value of the client renew prohibited status in defReg mapping |
static java.lang.String |
ELM_STATUS_CLIENT_TRANSFER_PROHIBITED
Value of the client transfer prohibited status in defReg mapping |
static java.lang.String |
ELM_STATUS_CLIENT_UPDATE_PROHIBITED
Value of the client update prohibited status in defReg mapping |
static java.lang.String |
ELM_STATUS_OK
Value of the OK status in defReg mapping |
static java.lang.String |
ELM_STATUS_PENDING_DELETE
Value of the pending delete status in defReg mapping |
static java.lang.String |
ELM_STATUS_PENDING_TRANSFER
Value of the pending transfer status in defReg mapping |
static java.lang.String |
ELM_STATUS_PENDING_VERIFICATION
Value of the pending verification status in defReg mapping |
static java.lang.String |
ELM_STATUS_SERVER_DELETE_PROHIBITED
Value of the server delete prohibited status in defReg mapping |
static java.lang.String |
ELM_STATUS_SERVER_RENEW_PROHIBITED
Value of the server renew prohibited status in defReg mapping |
static java.lang.String |
ELM_STATUS_SERVER_TRANSFER_PROHIBITED
Value of the server transfer prohibited status in defReg mapping |
static java.lang.String |
ELM_STATUS_SERVER_UPDATE_PROHIBITED
Value of the server update prohibited status in defReg mapping |
Constructor Summary | |
---|---|
EPPDefRegStatus()
EPPDefRegStatus default constructor. |
|
EPPDefRegStatus(java.lang.String aStatus)
EPPDefRegStatus constructor that takes the defReg status as
argument. |
|
EPPDefRegStatus(java.lang.String aStatus,
java.lang.String aDesc)
EPPDefRegStatus constructor that takes the defensive
registration status and a status description. |
|
EPPDefRegStatus(java.lang.String aStatus,
java.lang.String aDesc,
java.lang.String aLang)
EPPDefRegStatus constructor that takes the defensive
registration status and the language as arguments. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPDefRegStatus . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPDefRegStatus 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 EPPDefRegStatus instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPDefRegStatus 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 defReg 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 defReg status. |
void |
setStatus(java.lang.String newStatus)
Set defReg 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_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_PENDING_VERIFICATION
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
public static final java.lang.String ELM_DEFAULT_LANG
Constructor Detail |
---|
public EPPDefRegStatus()
EPPDefRegStatus
default constructor.
public EPPDefRegStatus(java.lang.String aStatus)
EPPDefRegStatus
constructor that takes the defReg status as
argument.
aStatus
- String DefReg stauspublic EPPDefRegStatus(java.lang.String aStatus, java.lang.String aDesc)
EPPDefRegStatus
constructor that takes the defensive
registration status and a status description.
aStatus
- Defensive Registration status which should be one of the
ELM_STATUS
constants.aDesc
- A description of the status changepublic EPPDefRegStatus(java.lang.String aStatus, java.lang.String aDesc, java.lang.String aLang)
EPPDefRegStatus
constructor that takes the defensive
registration status and the language as arguments.
aStatus
- Defensive Registration 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
EPPDefRegStatus
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPDefRegStatus
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 EPPDefRegStatus 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 EPPDefRegStatus
instance.public boolean equals(java.lang.Object aObject)
EPPDefRegStatus
compare.
equals
in class java.lang.Object
aObject
- EPPDefRegStatus
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 |