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