public class EPPOrgRole extends java.lang.Object implements EPPCodecComponent
EPPOrgRole
contains the role type and optional role id of the
organization.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPOrgRole . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPOrgRole . |
Constructor and Description |
---|
EPPOrgRole()
Default constructor for
EPPOrgRole . |
EPPOrgRole(java.lang.String aType)
Constructor for
EPPOrgRole that takes the role type. |
EPPOrgRole(java.lang.String aRole,
EPPOrgRoleStatus aStatus,
java.lang.String aRoleId)
Constructor for
EPPOrgRole that takes the role, a single
status, and a role identifier. |
EPPOrgRole(java.lang.String aRole,
java.util.List<EPPOrgRoleStatus> aStatuses)
Constructor for
EPPOrgRole that takes the role with a list of
statuses. |
EPPOrgRole(java.lang.String aRole,
java.util.List<EPPOrgRoleStatus> aStatuses,
java.lang.String aRoleId)
Constructor for
EPPOrgRole that takes the role, a list of
statuses, and a role identifier. |
Modifier and Type | Method and Description |
---|---|
void |
addStatus(EPPOrgRoleStatus aStatus)
Add a role status to list of role statuses.
|
java.lang.Object |
clone()
clone an
EPPCodecComponent . |
void |
decode(org.w3c.dom.Element aElement)
decode a DOM element tree to initialize the instance attributes.
|
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode instance into a DOM element tree.
|
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPOrgExt with this instance. |
java.lang.String |
gerRoleId()
Gets the OPTIONAL organization role identifier such as IANA ID for
registrars..
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.util.List<EPPOrgRoleStatus> |
getStatuses()
Gets the role statuses of the role.
|
java.lang.String |
getType()
Gets the organization role type.
|
boolean |
hasRoleId()
Is the organization role identifier defined?
|
boolean |
hasStatus()
Is there at least one status?
|
void |
setRoleId(java.lang.String aRoleId)
Sets the OPTIONAL organization role identifier such as IANA ID for
registrars..
|
void |
setStatuses(java.util.List<EPPOrgRoleStatus> aStatuses)
Sets the role statuses of the role.
|
void |
setType(java.lang.String aType)
Sets the organization role type.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String ELM_LOCALNAME
EPPOrgRole
.public static final java.lang.String ELM_NAME
EPPOrgRole
.public EPPOrgRole()
EPPOrgRole
.public EPPOrgRole(java.lang.String aType)
EPPOrgRole
that takes the role type.aType
- Organization role typepublic EPPOrgRole(java.lang.String aRole, java.util.List<EPPOrgRoleStatus> aStatuses)
EPPOrgRole
that takes the role with a list of
statuses.aRole
- Organization roleaStatuses
- Organization role statusespublic EPPOrgRole(java.lang.String aRole, EPPOrgRoleStatus aStatus, java.lang.String aRoleId)
EPPOrgRole
that takes the role, a single
status, and a role identifier.aRole
- Organization roleaStatus
- Single organization role statusesaRoleId
- Role identifierpublic EPPOrgRole(java.lang.String aRole, java.util.List<EPPOrgRoleStatus> aStatuses, java.lang.String aRoleId)
EPPOrgRole
that takes the role, a list of
statuses, and a role identifier.aRole
- Organization roleaStatuses
- Organization role statusesaRoleId
- Role identifierpublic java.lang.String getType()
null
otherwise.public void setType(java.lang.String aType)
aType
- The organization role typepublic boolean hasStatus()
true
if there at least one status; false
otherwise.public java.util.List<EPPOrgRoleStatus> getStatuses()
public void setStatuses(java.util.List<EPPOrgRoleStatus> aStatuses)
aStatuses
- Role statusespublic void addStatus(EPPOrgRoleStatus aStatus)
aStatus
- Role status to add.public boolean hasRoleId()
true
if the organization role identifier is defined;
false
otherwise.public java.lang.String gerRoleId()
null
otherwise.public void setRoleId(java.lang.String aRoleId)
aRoleId
- The organization identifierpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- DOM Document, which acts is an Element factoryEPPEncodeException
- Error encoding EPPOrgRole
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
aElement
argument represents the root DOM element and is used
to traverse the DOM nodes for instance attribute values.decode
in interface EPPCodecComponent
aElement
- Element
to decodeEPPDecodeException
- Error decoding Element
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCodecComponent
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPOrgExt
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic 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 boolean equals(java.lang.Object aObject)
EPPOrgExt
with this instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if equal; false
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.