Package com.verisign.epp.codec.statusset.v01

Class EPPStatusSet

java.lang.Object

com.verisign.epp.codec.statusset.v01.EPPStatusSet

All Implemented Interfaces:

EPPCodecComponent, Serializable, Cloneable

public class EPPStatusSet
extends Object
implements EPPCodecComponent

EPPStatusSet is used to define Status Set assigned to domain and host objects.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EPPStatusSet.Type	Type attribute enumeration with the values: CLIENT - The Status Set is a Client Status Set. SERVER - The Status Set is a Server Status Set.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_LOCALNAME	Constant for the "statusSet" local name
static final String	ELM_NAME	Constant for the phase qualified name (prefix and local name)
static final String	ELM_STATUSSET_ASSIGNED	XML element name for the status set assigned element
static final String	ELM_STATUSSET_AUTHTOKEN_USED	XML element name for the status set authentication token used element
static final String	ELM_STATUSSET_INHERITED	XML element name for the status set inherited element
static final String	ELM_STATUSSET_NAME	XML element name for the status set name element
static final String	ELM_STATUSSET_TYPE	XML element name for the status set type element

Constructor Summary

Constructors

Constructor	Description
EPPStatusSet()	Default constructor, where the required attributes must be set prior to calling encode(Document).
EPPStatusSet(String aName, EPPStatusSet.Type aType)	Constructor for EPPStatusSet that takes the required attributes.

Method Summary

Modifier and Type	Method	Description
void	addStatus(String aStatus)	Adds a status to the list of statuses.
Object	clone()	Clone EPPStatusSet instance.
void	decode(Element aElement)	Decode the EPPStatusSet element aElement DOM Element tree.
Element	encode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPStatusSet instance.
boolean	equals(Object aObject)	implements a deep EPPStatusSet compare.
Date	getCreatedDate()	Gets an OPTIONAL date and time that the Status Set was assigned to the object.
String	getName()	Gets the unique name for the Status Set that is up to server policy.
String	getNamespace()	Returns the XML namespace associated with the EPPCodecComponent.
String	getReason()	Gets an OPTIONAL free-form text reason that Status Set was assigned to the object.
List<String>	getStatuses()	Gets an OPTIONAL list of zero or more Status Values mapped to the Status Set.
EPPStatusSet.Type	getType()	Gets whether the Status Set is a Client Status Set with a value of "client" or the Status Set is a Server Status Set with a value of "server".
boolean	hasStatuses()	Are the statuses defined?
boolean	isAssigned()	Gets an OPTIONAL boolean with a default value of "true" that indicates whether the Status Set is assigned to the EPP object.
boolean	isAuthTokenUsed()	Gets the OPTIONAL boolean with a default value of "false" that indicates whether the Status Set uses the Authentication Token.
boolean	isInherited()	Gets an OPTIONAL boolean with a default value of "false" that indicates whether the Status Set is inherited from the parent object (domain name), in the case of the EPP Host object in [RFC5732], and is inherited by the child objects (hosts), in the case of the EPP Domain Name object in [RFC5731].
void	setAssigned(boolean aAssigned)	Sets An OPTIONAL boolean with a default value of "true" that indicates whether the Status Set is assigned to the EPP object.
void	setAuthTokenUsed(boolean aAuthTokenUsed)	Sets the OPTIONAL boolean with a default value of "false" that indicates whether the Status Set uses the Authentication Token.
void	setCreatedDate(Date aCreatedDate)	Sets an OPTIONAL date and time that the Status Set was assigned to the object.
void	setInherited(boolean inherited)	Sets an OPTIONAL boolean with a default value of "false" that indicates whether the Status Set is inherited from the parent object (domain name), in the case of the EPP Host object in [RFC5732], and is inherited by the child objects (hosts), in the case of the EPP Domain Name object in [RFC5731].
void	setName(String aName)	Sets the unique name for the Status Set that is up to server policy.
void	setReason(String aReason)	Sets an OPTIONAL free-form text reason that Status Set was assigned to the object.
void	setStatuses(List<String> aStatuses)	Sets an OPTIONAL list of zero or more Status Values mapped to the Status Set.
void	setType(EPPStatusSet.Type aType)	Sets whether the Status Set is a Client Status Set with a value of "client" or the Status Set is a Server Status Set with a value of "server".
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 Details

ELM_LOCALNAME

public static final String ELM_LOCALNAME

Constant for the "statusSet" local name

See Also:

• Constant Field Values

ELM_NAME

public static final String ELM_NAME

Constant for the phase qualified name (prefix and local name)

See Also:

• Constant Field Values

ELM_STATUSSET_NAME

public static final String ELM_STATUSSET_NAME

XML element name for the status set name element

See Also:

• Constant Field Values

ELM_STATUSSET_TYPE

public static final String ELM_STATUSSET_TYPE

XML element name for the status set type element

See Also:

• Constant Field Values

ELM_STATUSSET_AUTHTOKEN_USED

public static final String ELM_STATUSSET_AUTHTOKEN_USED

XML element name for the status set authentication token used element

See Also:

• Constant Field Values

ELM_STATUSSET_INHERITED

public static final String ELM_STATUSSET_INHERITED

XML element name for the status set inherited element

See Also:

• Constant Field Values

ELM_STATUSSET_ASSIGNED

public static final String ELM_STATUSSET_ASSIGNED

XML element name for the status set assigned element

See Also:

• Constant Field Values

Constructor Details

EPPStatusSet

public EPPStatusSet()

Default constructor, where the required attributes must be set prior to calling encode(Document).

EPPStatusSet

public EPPStatusSet(String aName,
 EPPStatusSet.Type aType)

Constructor for EPPStatusSet that takes the required attributes.

Parameters:

aName - The unique name for the Status Set that is up to server policy.

aType - Whether the Status Set is a Client Status Set with a value of "client" or the Status Set is a Server Status Set with a value of "server"

Method Details

getName

public String getName()

Gets the unique name for the Status Set that is up to server policy.

Returns:

the unique name for the Status Set

setName

public void setName(String aName)

Sets the unique name for the Status Set that is up to server policy.

Parameters:

aName - Unique name for the Status Set

getType

public EPPStatusSet.Type getType()

Gets whether the Status Set is a Client Status Set with a value of "client" or the Status Set is a Server Status Set with a value of "server".

Returns:

the type of the Status Set

setType

public void setType(EPPStatusSet.Type aType)

Sets whether the Status Set is a Client Status Set with a value of "client" or the Status Set is a Server Status Set with a value of "server".

Parameters:

aType - the type of the Status Set

isAuthTokenUsed

public boolean isAuthTokenUsed()

Gets the OPTIONAL boolean with a default value of "false" that indicates whether the Status Set uses the Authentication Token.

Returns:

the authentication token used boolean value

setAuthTokenUsed

public void setAuthTokenUsed(boolean aAuthTokenUsed)

Sets the OPTIONAL boolean with a default value of "false" that indicates whether the Status Set uses the Authentication Token.

Parameters:

aAuthTokenUsed - the authentication token used boolean value

isInherited

public boolean isInherited()

Gets an OPTIONAL boolean with a default value of "false" that indicates whether the Status Set is inherited from the parent object (domain name), in the case of the EPP Host object in [RFC5732], and is inherited by the child objects (hosts), in the case of the EPP Domain Name object in [RFC5731].

Returns:

The inherited boolean value

setInherited

public void setInherited(boolean inherited)

Sets an OPTIONAL boolean with a default value of "false" that indicates whether the Status Set is inherited from the parent object (domain name), in the case of the EPP Host object in [RFC5732], and is inherited by the child objects (hosts), in the case of the EPP Domain Name object in [RFC5731].

Parameters:

inherited - The inherited boolean to set

isAssigned

public boolean isAssigned()

Gets an OPTIONAL boolean with a default value of "true" that indicates whether the Status Set is assigned to the EPP object.

Returns:

The assigned boolean value

setAssigned

public void setAssigned(boolean aAssigned)

Sets An OPTIONAL boolean with a default value of "true" that indicates whether the Status Set is assigned to the EPP object.

Parameters:

aAssigned - The assigned boolean to set.

getCreatedDate

public Date getCreatedDate()

Gets an OPTIONAL date and time that the Status Set was assigned to the object.

Returns:

The created date if set; {null otherwise.

setCreatedDate

public void setCreatedDate(Date aCreatedDate)

Sets an OPTIONAL date and time that the Status Set was assigned to the object.

Parameters:

aCreatedDate - The created date to set. Set to null to unset.

hasStatuses

public boolean hasStatuses()

Are the statuses defined?

Returns:

true if the statuses are defined; false otherwise.

getStatuses

public List<String> getStatuses()

Gets an OPTIONAL list of zero or more Status Values mapped to the Status Set.

Returns:

List of Status Values if defined; null otherwise.

addStatus

public void addStatus(String aStatus)

Adds a status to the list of statuses.

Parameters:

aStatus - The status to add.

setStatuses

public void setStatuses(List<String> aStatuses)

Sets an OPTIONAL list of zero or more Status Values mapped to the Status Set.

Parameters:

aStatuses - The statuses to set. Set to null to unset.

getReason

public String getReason()

Gets an OPTIONAL free-form text reason that Status Set was assigned to the object.

Returns:

the reason if set; null otherwise.

setReason

public void setReason(String aReason)

Sets an OPTIONAL free-form text reason that Status Set was assigned to the object.

Parameters:

aReason - The reason to set. Set to null to unset.

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPStatusSet instance.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class Object

Returns:

clone of EPPStatusSet

Throws:

CloneNotSupportedException - standard Object.clone exception

encode

public Element encode(Document aDocument)
               throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPStatusSet 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 EPPStatusSet instance.

Throws:

EPPEncodeException - - Unable to encode EPPStatusSet instance.

decode

public void decode(Element aElement)
            throws EPPDecodeException

Decode the EPPStatusSet element aElement DOM Element tree.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - - Root DOM Element to decode EPPStatusSet from.

Throws:

EPPDecodeException - Unable to decode aElement

equals

public boolean equals(Object aObject)

implements a deep EPPStatusSet compare.

Overrides:

equals in class Object

Parameters:

aObject - EPPStatusSet instance to compare with

Returns:

true if equal; false otherwise

toString

public String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class Object

Returns:

Indented XML String if successful; ERROR otherwise.

getNamespace

public String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.