Package com.verisign.epp.codec.orgext

Class EPPOrgExtAddRemChg

java.lang.Object
com.verisign.epp.codec.orgext.EPPOrgExtAddRemChg
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPOrgExtAddRemChg extends 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.
See Also:

  • Field Details

    • ELM_ADD_NAME

      public static final String ELM_ADD_NAME
      XML root tag for EPPOrgExtAddRemChg add action
      See Also:

    • ELM_REM_NAME

      public static final String ELM_REM_NAME
      XML root tag for EPPOrgExtAddRemChg remove action
      See Also:

    • ELM_CHG_NAME

      public static final String ELM_CHG_NAME
      XML root tag for EPPOrgExtAddRemChg change action
      See Also:

  • Constructor Details

    • EPPOrgExtAddRemChg

      public EPPOrgExtAddRemChg()
      Default constructor for EPPOrgExtAddRemChg.

    • EPPOrgExtAddRemChg

      public EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction)
      Constructor for EPPOrgExtAddRemChg that takes the action.
      Parameters:
      aAction - Update action to take using the Action enumerated values.

    • EPPOrgExtAddRemChg

      public EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction, EPPOrgExtId aOrgId)
      Constructor for EPPOrgExtAddRemChg that takes the action and a single organization id.
      Parameters:
      aAction - Update action to take using the Action enumerated values.
      aOrgId - Org identifier

    • EPPOrgExtAddRemChg

      public EPPOrgExtAddRemChg(EPPOrgExtAddRemChg.Action aAction, List<EPPOrgExtId> aOrgIds)
      Constructor for EPPOrgExtAddRemChg that takes the action and a list of organization ids.
      Parameters:
      aAction - Update action to take using the Action enumerated values.
      aOrgIds - Org identifiers

  • Method Details

    • getElmName

      public String getElmName()
      Gets the element name of the root element of the add, remove, or change.
      Returns:
      Root element with the appropriate XML namespace prefix if action is defined; "undefined" otherwise.

    • getAction

      public EPPOrgExtAddRemChg.Action getAction()
      Gets the update action to take.
      Returns:
      the update action using the Action enumerated values.

    • setAction

      public void setAction(EPPOrgExtAddRemChg.Action aAction)
      Sets the update action to take.
      Parameters:
      aAction - Update action using the Action enumerated values.

    • hasOrgIds

      public boolean hasOrgIds()
      Are there any organization ids?
      Returns:
      true if there organization ids; false otherwise.

    • getOrgIds

      public List<EPPOrgExtId> getOrgIds()
      Returns the list of organization ids. An empty list indicates that there are no organization ids.
      Returns:
      List of organization ids.

    • setOrgIds

      public void setOrgIds(List<EPPOrgExtId> aOrgIds)
      Sets the organization ids.
      Parameters:
      aOrgIds - The list of organization ids. Set to null or an empty list to indicate that there are no organization ids.

    • addOrgId

      public void addOrgId(EPPOrgExtId aOrgId)
      Add a organization id to the list of organization ids.
      Parameters:
      aOrgId - organization id to add to the list of organization ids.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPOrgExtAddRemChg

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • clone

      public Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPOrgExt
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • 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.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPOrgExt with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false 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.