public class EPPOrgExtAddRemChg extends java.lang.Object implements EPPCodecComponent
EPPOrgExtAddRemChg
is used to define the organization ids to
either add, remove, or change. The EPPOrgextAddRemChg
can take
zero or more organization ids along with the action using the EPPOrgExtAddRemChg.Action
enumeration.Modifier and Type | Class and Description |
---|---|
static class |
EPPOrgExtAddRemChg.Action
Update action, which includes:
ADD - Add the org identifiers. REM - Remove the org identifiers. CHG - Change the org identifiers. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_ADD_NAME
XML root tag for
EPPOrgExtAddRemChg add action |
static java.lang.String |
ELM_CHG_NAME
XML root tag for
EPPOrgExtAddRemChg change action |
static java.lang.String |
ELM_REM_NAME
XML root tag for
EPPOrgExtAddRemChg remove action |
Constructor and Description |
---|
EPPOrgExtAddRemChg()
Default constructor for
EPPOrgExtAddRemChg . |
EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction)
Constructor for
EPPOrgExtAddRemChg that takes the action. |
EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction,
EPPOrgExtId aOrgId)
Constructor for
EPPOrgExtAddRemChg that takes the action and a
single organization id. |
EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction,
java.util.List<EPPOrgExtId> aOrgIds)
Constructor for
EPPOrgExtAddRemChg that takes the action and a
list of organization ids. |
Modifier and Type | Method and Description |
---|---|
void |
addOrgId(EPPOrgExtId aOrgId)
Add a organization id to the list of organization ids.
|
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. |
EPPOrgExtAddRemChg.Action |
getAction()
Gets the update action to take.
|
java.lang.String |
getElmName()
Gets the element name of the root element of the add, remove, or change.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.util.List<EPPOrgExtId> |
getOrgIds()
Returns the list of organization ids.
|
boolean |
hasOrgIds()
Are there any organization ids?
|
void |
setAction(EPPOrgExtAddRemChg.Action aAction)
Sets the update action to take.
|
void |
setOrgIds(java.util.List<EPPOrgExtId> aOrgIds)
Sets the organization ids.
|
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_ADD_NAME
EPPOrgExtAddRemChg
add actionpublic static final java.lang.String ELM_REM_NAME
EPPOrgExtAddRemChg
remove actionpublic static final java.lang.String ELM_CHG_NAME
EPPOrgExtAddRemChg
change actionpublic EPPOrgExtAddRemChg()
EPPOrgExtAddRemChg
.public EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction)
EPPOrgExtAddRemChg
that takes the action.aAction
- Update action to take using the Action
enumerated
values.public EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction, EPPOrgExtId aOrgId)
EPPOrgExtAddRemChg
that takes the action and a
single organization id.aAction
- Update action to take using the Action
enumerated
values.aOrgId
- Org identifierpublic EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction, java.util.List<EPPOrgExtId> aOrgIds)
EPPOrgExtAddRemChg
that takes the action and a
list of organization ids.aAction
- Update action to take using the Action
enumerated
values.aOrgIds
- Org identifierspublic java.lang.String getElmName()
public EPPOrgExtAddRemChg.Action getAction()
Action
enumerated values.public void setAction(EPPOrgExtAddRemChg.Action aAction)
aAction
- Update action using the Action
enumerated values.public boolean hasOrgIds()
true
if there organization ids; false
otherwise.public java.util.List<EPPOrgExtId> getOrgIds()
public void setOrgIds(java.util.List<EPPOrgExtId> aOrgIds)
aOrgIds
- The list of organization ids. Set to null
or an
empty list to indicate that there are no organization ids.public void addOrgId(EPPOrgExtId aOrgId)
aOrgId
- organization id to add to the list of organization ids.public 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 EPPOrgExtAddRemChg
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
.