EPPHostStatus (verisign 1.12.0.12 API)

java.lang.Object
- com.verisign.epp.codec.host.EPPHostStatus

All Implemented Interfaces:

EPPCodecComponent, java.io.Serializable, java.lang.Cloneable
```
public class EPPHostStatus
extends java.lang.Object
implements EPPCodecComponent
```
Represents a host Status.

A host object MUST always have at least one associated status value. Status values MAY be set only by the client that sponsors a host object and by the server on which the object resides. A client can change the status of a host 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. The status of an object MAY change as a result of either a client-initiated transform command or an action performed by a server operator.

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.
- clientUpdateProhibited, serverUpdateProhibited: Requests to update the object (other than to remove this status) MUST be rejected.
- linked: The host object has at least one active association with another object, such as a domain object. Servers SHOULD provide services to determine existing object associations.
- ok: This is the nominal status value for an object that has no pending operations or prohibitions. This value is set and removed by the server as other status values are added or removed.
- pendingDelete: A delete request has been received for the object, but the object has not yet been purged from the server database.
- "ok" status MUST NOT be combined with any other status.
- pendingCreate: A create request has been received for a host object, and completion of the request is pending.
- pendingUpdate: An update request has been received for a host object, and completion of the request is pending.
- pendingTransfer: A transfer request has been received for the host object's superordinate domain object, and completion of the request is pending.
- pendingDelete An delete request has been received for a host object or superordinate domain object, and completion of the request is pending.
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and 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 host mapping
`static java.lang.String`	`ELM_STATUS_CLIENT_UPDATE_PROHIBITED` Value of the client update prohibited status in host mapping
`static java.lang.String`	`ELM_STATUS_LINKED` Value of the linked status in host mapping
`static java.lang.String`	`ELM_STATUS_OK` Value of the OK status in host mapping
`static java.lang.String`	`ELM_STATUS_PENDING_CREATE` Value of the pending create status in host mapping
`static java.lang.String`	`ELM_STATUS_PENDING_DELETE` Value of the pending delete status in host mapping
`static java.lang.String`	`ELM_STATUS_PENDING_TRANSFER` Value of the pending transfer status in host mapping
`static java.lang.String`	`ELM_STATUS_PENDING_UPDATE` Value of the pending update status in host mapping
`static java.lang.String`	`ELM_STATUS_SERVER_DELETE_PROHIBITED` Value of the server delete prohibited status in host mapping
`static java.lang.String`	`ELM_STATUS_SERVER_UPDATE_PROHIBITED` Value of the server update prohibited status in host mapping

Constructor Summary

Constructors
Constructor and Description
`EPPHostStatus()` `EPPHostStatus` default constructor.
`EPPHostStatus(java.lang.String aStatus)` `EPPHostStatus` constructor that takes the host status as argument.
`EPPHostStatus(java.lang.String aStatus, java.lang.String aDesc)` `EPPHostStatus` constructor that takes the host status and a status description.
`EPPHostStatus(java.lang.String aStatus, java.lang.String aDesc, java.lang.String aLang)` `EPPHostStatus` constructor that takes the host status and the language as arguments.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Clone `EPPHostStatus`.
`void`	`decode(org.w3c.dom.Element aElement)` Decode the EPPHostStatus 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 EPPHostStatus instance.
`boolean`	`equals(java.lang.Object aObject)` implements a deep `EPPHostStatus` 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 status description language.
`java.lang.String`	`getNamespace()` Returns the XML namespace associated with the `EPPCodecComponent`.
`java.lang.String`	`getStatus()` Gets host 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)` Sets status description language.
`void`	`setStatus(java.lang.String newStatus)` Sets host 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
  - ELM_STATUS_OK
```
public static final java.lang.String ELM_STATUS_OK
```
    Value of the OK status in host 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 host mapping
    
    See Also:
    
    Constant Field Values
  - ELM_STATUS_PENDING_CREATE
```
public static final java.lang.String ELM_STATUS_PENDING_CREATE
```
    Value of the pending create status in host mapping
    
    See Also:
    
    Constant Field Values
  - ELM_STATUS_PENDING_UPDATE
```
public static final java.lang.String ELM_STATUS_PENDING_UPDATE
```
    Value of the pending update status in host 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 host 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 host 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 host mapping
    
    See Also:
    
    Constant Field Values
  - ELM_STATUS_LINKED
```
public static final java.lang.String ELM_STATUS_LINKED
```
    Value of the linked status in host 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 host 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 host 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
- Constructor Detail
  - EPPHostStatus
```
public EPPHostStatus()
```
    EPPHostStatus default constructor.
  - EPPHostStatus
```
public EPPHostStatus(java.lang.String aStatus)
```
    EPPHostStatus constructor that takes the host status as argument.
    
    Parameters:
    
    aStatus - Domain status which should be one of the ELM_STATUS constants.
  - EPPHostStatus
```
public EPPHostStatus(java.lang.String aStatus,
                     java.lang.String aDesc)
```
    EPPHostStatus constructor that takes the host status and a status description.
    
    Parameters:
    
    aStatus - Domain status which should be one of the ELM_STATUS constants.
    
    aDesc - A description of the status change
  - EPPHostStatus
```
public EPPHostStatus(java.lang.String aStatus,
                     java.lang.String aDesc,
                     java.lang.String aLang)
```
    EPPHostStatus constructor that takes the host status and the language as arguments.
    
    Parameters:
    
    aStatus - Domain status which should be one of the ELM_STATUS constants.
    
    aDesc - A description of the status change
    
    aLang - Language of the status description
- Method Detail
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Clone EPPHostStatus.
    
    Specified by:
    
    clone in interface EPPCodecComponent
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    clone of EPPHostStatus
    
    Throws:
    
    java.lang.CloneNotSupportedException - standard Object.clone exception
  - decode
```
public void decode(org.w3c.dom.Element aElement)
            throws EPPDecodeException
```
    Decode the EPPHostStatus attributes from the aElement DOM Element tree.
    
    Specified by:
    
    decode in interface EPPCodecComponent
    
    Parameters:
    
    aElement - - Root DOM Element to decode EPPHostStatus 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 EPPHostStatus instance.
    
    Specified by:
    
    encode in interface EPPCodecComponent
    
    Parameters:
    
    aDocument - - DOM Document that is being built. Used as an Element factory.
    
    Returns:
    
    Element - Root DOM Element representing the EPPHostStatus instance.
    
    Throws:
    
    EPPEncodeException - - Unable to encode EPPHostStatus instance.
  - equals
```
public boolean equals(java.lang.Object aObject)
```
    implements a deep EPPHostStatus compare.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    aObject - EPPHostStatus instance to compare with
    
    Returns:
    
    DOCUMENT ME!
  - getLang
```
public java.lang.String getLang()
```
    Get status description language. The default is ELM_DEFAULT_LANG.
    
    Returns:
    
    Language
  - getStatus
```
public java.lang.String getStatus()
```
    Gets host status.
    
    Returns:
    
    Host Status
  - setStatus
```
public void setStatus(java.lang.String newStatus)
```
    Sets host status.
    
    Parameters:
    
    newStatus - String
  - toString
```
public java.lang.String toString()
```
    Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Indented XML String if successful; ERROR otherwise.
  - setLang
```
public void setLang(java.lang.String newLang)
```
    Sets status description language.
    
    Parameters:
    
    newLang - 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
  - getNamespace
```
public java.lang.String getNamespace()
```
    Returns the XML namespace associated with the EPPCodecComponent.
    
    Specified by:
    
    getNamespace in interface EPPCodecComponent
    
    Returns:
    
    XML namespace for the EPPCodecComponent.

Class EPPHostStatus

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ELM_STATUS_OK

ELM_STATUS_PENDING_DELETE

ELM_STATUS_PENDING_CREATE

ELM_STATUS_PENDING_UPDATE

ELM_STATUS_PENDING_TRANSFER

ELM_STATUS_CLIENT_DELETE_PROHIBITED

ELM_STATUS_CLIENT_UPDATE_PROHIBITED

ELM_STATUS_LINKED

ELM_STATUS_SERVER_DELETE_PROHIBITED

ELM_STATUS_SERVER_UPDATE_PROHIBITED

ELM_DEFAULT_LANG

Constructor Detail

EPPHostStatus

EPPHostStatus

EPPHostStatus

EPPHostStatus

Method Detail

clone

decode

encode

equals

getLang

getStatus

setStatus

toString

setLang

getDescription

setDescription

getNamespace