Class EPPStatusSetUpdate
java.lang.Object
com.verisign.epp.codec.statusset.v01.EPPStatusSetAuthTokenList
com.verisign.epp.codec.statusset.v01.EPPStatusSetUpdate
- All Implemented Interfaces:
EPPCodecComponent,Serializable,Cloneable
Status Set Update Extension that enables a client to update the status sets
with the option of authorizing using authentication tokens.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringElement tag name for the addstatic final StringXML local name forEPPStatusSetUpdate.static final StringXML root tag forEPPStatusSetUpdate.static final StringElement tag name for the remstatic final StringXML element name for the "statusSet" element -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor forEPPStatusSetUpdate.EPPStatusSetUpdate(EPPAuthTokenData aAuthToken) Constructor forEPPStatusSetUpdatethat takes a single authentication token.EPPStatusSetUpdate(List<EPPAuthTokenData> aAuthTokens) Constructor forEPPStatusSetUpdatethat a list of authentication token. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddAddStatusSet(String aAddStatusSet) Adds a status set to the list of add status sets.voidaddRemStatusSet(String aRemStatusSet) Adds a status set to the list of remove status sets.clone()clone anEPPCodecComponent.voidDecode a DOM element tree to initialize the instance attributes.Encode of aEPPStatusSetUpdateinstancebooleanCompare an instance ofEPPStatusSetUpdatewith this instance.Gets the list of add status sets if defined.protected StringReturns the local name "update" for the update extension.Returns the XML namespace associated with theEPPCodecComponent.Gets the list of remove status sets if defined.booleanAre the add status sets defined?booleanAre the remove status sets defined?voidsetAddStatusSets(List<String> aAddStatusSets) Sets the list of add status sets.voidsetRemStatusSets(List<String> aRemStatusSets) Sets the list of remove status sets.Methods inherited from class com.verisign.epp.codec.statusset.v01.EPPStatusSetAuthTokenList
addAuthToken, getAuthTokens, hasAuthTokens, setAuthTokens, toString
-
Field Details
-
ELM_LOCALNAME
XML local name forEPPStatusSetUpdate.- See Also:
-
ELM_NAME
XML root tag forEPPStatusSetUpdate.- See Also:
-
ELM_ADD
Element tag name for the add- See Also:
-
ELM_REM
Element tag name for the rem- See Also:
-
ELM_STATUSSET
XML element name for the "statusSet" element- See Also:
-
-
Constructor Details
-
EPPStatusSetUpdate
public EPPStatusSetUpdate()Default constructor forEPPStatusSetUpdate. -
EPPStatusSetUpdate
Constructor forEPPStatusSetUpdatethat takes a single authentication token.- Parameters:
aAuthToken- A single authentication token
-
EPPStatusSetUpdate
Constructor forEPPStatusSetUpdatethat a list of authentication token.- Parameters:
aAuthTokens- A list of authentication tokens
-
-
Method Details
-
getLocalName
Returns the local name "update" for the update extension.- Specified by:
getLocalNamein classEPPStatusSetAuthTokenList- Returns:
- Local name "update" for the update extension.
-
hasAddStatusSets
public boolean hasAddStatusSets()Are the add status sets defined?- Returns:
trueif the add status sets are defined;falseotherwise.
-
getAddStatusSets
Gets the list of add status sets if defined.- Returns:
- List of add status sets if defined;
nullotherwise.
-
addAddStatusSet
Adds a status set to the list of add status sets.- Parameters:
aAddStatusSet- The status set to add to the add status sets.
-
setAddStatusSets
Sets the list of add status sets.- Parameters:
aAddStatusSets- The add status sets to set. Set tonullto unset to add status sets.
-
hasRemStatusSets
public boolean hasRemStatusSets()Are the remove status sets defined?- Returns:
trueif the remove status sets are defined;falseotherwise.
-
getRemStatusSets
Gets the list of remove status sets if defined.- Returns:
- List of remove status sets if defined;
nullotherwise.
-
addRemStatusSet
Adds a status set to the list of remove status sets.- Parameters:
aRemStatusSet- The status set to add to the remove status sets.
-
setRemStatusSets
Sets the list of remove status sets.- Parameters:
aRemStatusSets- The remove status sets to set. Set tonullto unset to remove status sets.
-
encode
Encode of aEPPStatusSetUpdateinstance- Specified by:
encodein interfaceEPPCodecComponent- Overrides:
encodein classEPPStatusSetAuthTokenList- Parameters:
aDocument- DOM Document, which acts is an Element factory- Returns:
- Element Root element associated with the object
- Throws:
EPPEncodeException- Error encodingEPPStatusSetUpdate
-
decode
Decode a DOM element tree to initialize the instance attributes. TheaElementargument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.- Specified by:
decodein interfaceEPPCodecComponent- Overrides:
decodein classEPPStatusSetAuthTokenList- Parameters:
aElement-Elementto decode- Throws:
EPPDecodeException- Error decodingElement
-
equals
Compare an instance ofEPPStatusSetUpdatewith this instance.- Overrides:
equalsin classEPPStatusSetAuthTokenList- Parameters:
aObject- Object to compare with.- Returns:
trueif equal;falseotherwise.
-
clone
clone anEPPCodecComponent.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classEPPStatusSetAuthTokenList- Returns:
- clone of concrete
EPPStatusSetExtension - Throws:
CloneNotSupportedException- standard Object.clone exception
-
getNamespace
Returns the XML namespace associated with theEPPCodecComponent.- Returns:
- XML namespace for the
EPPCodecComponent.
-