Package com.verisign.epp.codec.defReg

Class EPPDefRegAddRemove

java.lang.Object
com.verisign.epp.codec.defReg.EPPDefRegAddRemove
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPDefRegAddRemove extends Object implements EPPCodecComponent
Represents attributes to add, remove or change with a EPPDefRegUpdateCmd. In EPPDefRegUpdateCmd, an instance of EPPDefRegAddRemove is used to specify the attributes to add; an instance of EPPDefRegAddRemove is used to specify the attributes to remove, and an instance of EPPDefRegAddRemove is used to specify the attributes to change.

The DefRegReg Mapping Specification describes the following attributes:
  • For add and remove only, zero or more <defReg:status> elements that contain status values to be applied to or removed from the defReg object, respectively. When specifying a value to be removed, only the attribute value is significant; element text is not required to match a value for removal.
  • For change only, A optional <defReg:registrant> element that contains the identifier for the human or organizational social information (contact) object to be associated with the defReg object as the object registrant. This object identifier MUST be known to the server before the contact object can be associated with the defReg object.
  • For change only, A optional <defReg:tm> element that contains trademark identifier (ID) associated with the defReg object.
  • For change only, A optional <defReg:tmCountry> element that indicates the country which issued the trademark associated with the defReg object.
  • For change only, A optional <defReg:tmDate> element that contains indicates the date when the trademark was issued for the defReg object.
  • For change only, An OPTIONAL <defReg:adminContact> element that contains the identifier for the administrator associated with the defReg object.
  • For change only, An OPTIONAL <defReg:authInfo> element that contains authorization information to be associated with the defReg object.

It is important to note that the maximum number of defReg attribute elements is subject to the number of values currently associated with the defReg object. EPPDefRegAddRemove will delegate the validation of the cardinality of the defReg attributes elements to the EPP Server.
See Also:

  • Constructor Details

    • EPPDefRegAddRemove

      public EPPDefRegAddRemove()
      Default constructor for EPPDefRegAddRemove. All of the attribute default to null to indicate no modification.

    • EPPDefRegAddRemove

      public EPPDefRegAddRemove(Vector aStatuses)
      Constructor for EPPDefRegAddRemove that includes the attributes as arguments.
      Parameters:
      aStatuses - Vector statuses

    • EPPDefRegAddRemove

      public EPPDefRegAddRemove(String aRegistrant, String aTm, String aTmCountry, Date aTmDate, String aAdminContact, EPPAuthInfo aAuthInfo)
      Constructor for EPPDefRegAddRemove that includes the attributes as arguments.
      Parameters:
      aRegistrant - String registrant for the change mode
      aTm - DefReg TradeMark
      aTmCountry - DefReg TradeMarkCountry
      aTmDate - DefReg TradeMarkDate
      aAdminContact - String registrant AdminContact
      aAuthInfo - EPPAuthInfo authorization information for the change mode

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPDefRegAddRemove instance.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Root DOM Element representing the EPPDefRegAddRemove instance.
      Throws:
      EPPEncodeException - Unable to encode EPPDefRegAddRemove instance.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPDefRegAddRemove attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPDefRegAddRemove from.
      Throws:
      EPPDecodeException - Unable to decode aElement.

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPDefRegAddRemove compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPDefRegAddRemove instance to compare with
      Returns:
      DOCUMENT ME!

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPDefRegAddRemove.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPDefRegAddRemove
      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.

    • getAuthInfo

      public EPPAuthInfo getAuthInfo()
      Get authorization information for the change mode
      Returns:
      com.verisign.epp.codec.defReg.EPPDefRegAuthInfo

    • getRegistrant

      public String getRegistrant()
      Get registrant for the change mode
      Returns:
      java.lang.String

    • getTm

      public String getTm()
      Get the trademark informnation.
      Returns:
      DefReg tradeMark

    • setTm

      public void setTm(String aTm)
      Set the trademark informnation.
      Parameters:
      aTm - DefReg registrant

    • getTmCountry

      public String getTmCountry()
      Get the trademark country informnation.
      Returns:
      DefReg trademark country

    • setTmCountry

      public void setTmCountry(String aTmCountry)
      Set the trademark country informnation.
      Parameters:
      aTmCountry - DefReg trademark country

    • getTmDate

      public Date getTmDate()
      Get the trademark date informnation.
      Returns:
      DefReg trademark date

    • setTmDate

      public void setTmDate(Date aTmDate)
      Set the trademark date informnation.
      Parameters:
      aTmDate - DefReg trademark date

    • getAdminContact

      public String getAdminContact()
      Get AdminContact Address
      Returns:
      java.lang.String

    • setAuthInfo

      public void setAuthInfo(EPPAuthInfo newAuthInfo)
      Set authorization information for the change mode
      Parameters:
      newAuthInfo - com.verisign.epp.codec.defReg.EPPDefRegAuthInfo

    • setRegistrant

      public void setRegistrant(String newRegistrant)
      Set registrant for the change mode
      Parameters:
      newRegistrant - java.lang.String

    • setAdminContact

      public void setAdminContact(String newAdminContact)
      Set forwardTo Address for the change mode
      Parameters:
      newAdminContact - java.lang.String

    • getStatuses

      public Vector getStatuses()
      Gets the statuses to add or remove. The EPPDefRegStatus.STATUS_ constants can be used for the statuses.
      Returns:
      Vector of status String instances.

    • setStatuses

      public void setStatuses(Vector aStatuses)
      Sets the statuses to add or remove. The EPPDefRegStatus.STATUS_ constants can be used for the statuses.
      Parameters:
      aStatuses - Vector of status String instances.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.