Package com.verisign.epp.codec.mark

Class EPPTrademark

java.lang.Object
com.verisign.epp.codec.mark.EPPTrademark
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPTrademark extends Object implements EPPCodecComponent
Class for a Trademark that can be included in the list of trademarks contained in the EPPMark.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    Constant for the trademark local name
    static final String
    ELM_NAME
    Constant for the trademark tag

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPTrademark()
    Create an EPPTrademark instance.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addClass(String aClass)
    Adds a Nice Classification class number to the list of classes.
    void
    addContact(EPPMarkContact aContact)
    Adds a contact to the list of contacts of the trademark.
    void
    addHolder(EPPMarkContact aHolder)
    Adds a holder to the list of holders of the trademark.
    void
    addLabel(String aLabel)
    Adds a domain name label to the domain name labels that corresponds to the trademark.
    Object
    clone()
    Clone EPPTrademark.
    void
    decode(byte[] aMarkArray)
    Decode the EPPTrademark attributes from the input byte[].
    void
    decode(Element aElement)
    Decode the EPPTrademark component
    byte[]
    encode()
    Encode the trademark to a byte[].
    Element
    encode(Document aDocument)
    Sets all this instance's data in the given XML document
    boolean
    equals(Object aObject)
    implements a deep EPPTrademark compare.
    Date
    getApDate()
    Gets the date the trademark was applied for.
    String
    getApId()
    Gets the application ID registered in the trademark office.
    List<String>
    getClasses()
    Gets list of Nice Classification class numbers.
    List<EPPMarkContact>
    getContacts()
    Gets contacts of the trademark.
    Date
    getExDate()
    Gets the date of expiration of the trademark.
    String
    getGoodsAndServices()
    Gets full description of the goods and services mentioned in the trademark registration document.
    List<EPPMarkContact>
    getHolders()
    Gets holders of the trademark.
    String
    getId()
    Gets the identifier for the trademark.
    String
    getJurisdiction()
    Gets the two-character code of the jurisdiction where the trademark was registered.
    List<String>
    getLabels()
    Gets the domain name labels that corresponds to the trademark.
    String
    getName()
    Gets the registered trademark text string.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    Date
    getRegDate()
    Gets the date the trademark was registered.
    String
    getRegNum()
    Gets the trademark registration ID (number) registered in the trademark office.
    void
    setApDate(Date aApDate)
    Sets the date the trademark was applied for.
    void
    setApId(String aApId)
    Sets the application ID registered in the trademark office.
    void
    setClasses(List<String> aClasses)
    Sets list of Nice Classification class numbers.
    void
    setContacts(List<EPPMarkContact> aContacts)
    Sets contacts of the trademark.
    void
    setExDate(Date aExDate)
    Sets the date of expiration of the trademark.
    void
    setGoodsAndServices(String aGoodsAndServices)
    Sets full description of the goods and services mentioned in the trademark registration document.
    void
    setHolders(List<EPPMarkContact> aHolders)
    Sets holders of the trademark.
    void
    setId(String aId)
    Sets the identifier for the trademark.
    void
    setJurisdiction(String aJurisdiction)
    Sets the two-character code of the jurisdiction where the trademark was registered.
    void
    setLabels(List<String> aLabels)
    Sets the domain name labels that corresponds to the trademark.
    void
    setName(String aName)
    Sets the registered trademark text string.
    void
    setRegDate(Date aRegDate)
    Sets the date the trademark was registered.
    void
    setRegNum(String aRegNum)
    Sets the trademark registration ID (number) registered in the trademark office.
    String
    toString()
    Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • EPPTrademark

      public EPPTrademark()
      Create an EPPTrademark instance. Use the setter methods to set the attributes of the instance.

  • Method Details

    • clone

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

    • encode

      public byte[] encode() throws EPPEncodeException
      Encode the trademark to a byte[].
      Returns:
      Encoded trademark
      Throws:
      EPPEncodeException - Error encoding the trademark

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Sets all this instance's data in the given XML document
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - a DOM Document to attach data to.
      Returns:
      The root element of this component.
      Throws:
      EPPEncodeException - Thrown if any errors prevent encoding.

    • decode

      public void decode(byte[] aMarkArray) throws EPPDecodeException
      Decode the EPPTrademark attributes from the input byte[].
      Parameters:
      aMarkArray - byte[] to decode the attribute values
      Throws:
      EPPDecodeException - Error decoding the byte[].

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPTrademark component
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root element of the EPPTrademark
      Throws:
      EPPDecodeException - Error decoding the EPPTrademark

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPTrademark compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPTrademark instance to compare with
      Returns:
      true if equal false otherwise

    • getId

      public String getId()
      Gets the identifier for the trademark.
      Returns:
      The identifier for the trademark if set; null otherwise.

    • setId

      public void setId(String aId)
      Sets the identifier for the trademark.
      Parameters:
      aId - Identifier for the trademark

    • getName

      public String getName()
      Gets the registered trademark text string.
      Returns:
      The registered trademark text string if set; null otherwise.

    • setName

      public void setName(String aName)
      Sets the registered trademark text string.
      Parameters:
      aName - the registered trademark text string

    • getHolders

      public List<EPPMarkContact> getHolders()
      Gets holders of the trademark.
      Returns:
      the holders of the trademark if set; Empty List otherwise.

    • setHolders

      public void setHolders(List<EPPMarkContact> aHolders)
      Sets holders of the trademark.
      Parameters:
      aHolders - the holders of the trademark

    • addHolder

      public void addHolder(EPPMarkContact aHolder)
      Adds a holder to the list of holders of the trademark.
      Parameters:
      aHolder - Holder to add to list of holders of the trademark.

    • getContacts

      public List<EPPMarkContact> getContacts()
      Gets contacts of the trademark.
      Returns:
      the contacts of the trademark if set; Empty List otherwise.

    • setContacts

      public void setContacts(List<EPPMarkContact> aContacts)
      Sets contacts of the trademark.
      Parameters:
      aContacts - the contacts of the trademark

    • addContact

      public void addContact(EPPMarkContact aContact)
      Adds a contact to the list of contacts of the trademark.
      Parameters:
      aContact - Contact to add to list of contacts of the trademark.

    • getJurisdiction

      public String getJurisdiction()
      Gets the two-character code of the jurisdiction where the trademark was registered. This is a two-character code from [WIPO.ST3].
      Returns:
      Jurisdiction if set; null otherwise.

    • setJurisdiction

      public void setJurisdiction(String aJurisdiction)
      Sets the two-character code of the jurisdiction where the trademark was registered. This is a two-character code from [WIPO.ST3].
      Parameters:
      aJurisdiction - Jurisdiction where trademark was registered.

    • getClasses

      public List<String> getClasses()
      Gets list of Nice Classification class numbers.
      Returns:
      list of Nice Classification class numbers if defined; empty list otherwise.

    • setClasses

      public void setClasses(List<String> aClasses)
      Sets list of Nice Classification class numbers.
      Parameters:
      aClasses - list of Nice Classification class numbers

    • addClass

      public void addClass(String aClass)
      Adds a Nice Classification class number to the list of classes.
      Parameters:
      aClass - Nice Classification class number to add

    • getLabels

      public List<String> getLabels()
      Gets the domain name labels that corresponds to the trademark.
      Returns:
      the domain name labels that corresponds to the trademark if set; Empty List otherwise.

    • setLabels

      public void setLabels(List<String> aLabels)
      Sets the domain name labels that corresponds to the trademark.
      Parameters:
      aLabels - the domain name labels that corresponds to the trademark

    • addLabel

      public void addLabel(String aLabel)
      Adds a domain name label to the domain name labels that corresponds to the trademark.
      Parameters:
      aLabel - Domain name label to add.

    • getGoodsAndServices

      public String getGoodsAndServices()
      Gets full description of the goods and services mentioned in the trademark registration document.
      Returns:
      The goods and services if set; null otherwise.

    • setGoodsAndServices

      public void setGoodsAndServices(String aGoodsAndServices)
      Sets full description of the goods and services mentioned in the trademark registration document.
      Parameters:
      aGoodsAndServices - The goods and services

    • getApId

      public String getApId()
      Gets the application ID registered in the trademark office.
      Returns:
      Application ID registered in the trademark office if defined; null otherwise.

    • setApId

      public void setApId(String aApId)
      Sets the application ID registered in the trademark office.
      Parameters:
      aApId - Application ID registered in the trademark office.

    • getApDate

      public Date getApDate()
      Gets the date the trademark was applied for.
      Returns:
      The date the trademark was applied for if defined; null otherwise.

    • setApDate

      public void setApDate(Date aApDate)
      Sets the date the trademark was applied for.
      Parameters:
      aApDate - The date the trademark was applied for.

    • getRegNum

      public String getRegNum()
      Gets the trademark registration ID (number) registered in the trademark office.
      Returns:
      The trademark registration ID (number) registered in the trademark office.

    • setRegNum

      public void setRegNum(String aRegNum)
      Sets the trademark registration ID (number) registered in the trademark office.
      Parameters:
      aRegNum - The trademark registration ID (number) registered in the trademark office.

    • getRegDate

      public Date getRegDate()
      Gets the date the trademark was registered.
      Returns:
      The date the trademark was registered if set; null otherwise.

    • setRegDate

      public void setRegDate(Date aRegDate)
      Sets the date the trademark was registered.
      Parameters:
      aRegDate - The date the trademark was registered

    • getExDate

      public Date getExDate()
      Gets the date of expiration of the trademark.
      Returns:
      the date of expiration of the trademark if set; null otherwise.

    • setExDate

      public void setExDate(Date aExDate)
      Sets the date of expiration of the trademark.
      Parameters:
      aExDate - The date of expiration of the trademark

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

    • getNamespace

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