Package com.verisign.epp.codec.mark

Class EPPProtection

  • All Implemented Interfaces:
    EPPCodecComponent, java.io.Serializable, java.lang.Cloneable
    public class EPPProtection
extends java.lang.Object
implements EPPCodecComponent
    Class that contains the countries and region of the country where the mark is protected and the OPTIONAL ruling, in case of statute protected marks, to identify the country where the statute was enacted. A list of EPPProtection instances is contained in a EPPTreatyOrStatute.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELM_LOCALNAME
      Constant for the local name
      static java.lang.String ELM_NAME
      Constant for the tag name

    • Constructor Summary

      Constructors 
      Constructor Description
      EPPProtection()
      Default constructor for EPPProtection.
      EPPProtection​(java.lang.String aCC, java.lang.String aRegion)
      Constructor that takes all of the EPPProtection required attributes.
      EPPProtection​(java.lang.String aCC, java.lang.String aRegion, java.lang.String aRuling)
      Constructor that takes all of the EPPProtection attributes with a single ruling country.
      EPPProtection​(java.lang.String aCC, java.lang.String aRegion, java.util.List<java.lang.String> aRulings)
      Constructor that takes all of the EPPProtection attributes.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addRuling​(java.lang.String aRuling)
      Adds a country for to the list of countries for the ruling.
      java.lang.Object clone()
      Clone EPPProtection.
      void decode​(org.w3c.dom.Element aElement)
      Decode the EPPMark component
      org.w3c.dom.Element encode​(org.w3c.dom.Document aDocument)
      Sets all this instance's data in the given XML document
      boolean equals​(java.lang.Object aObject)
      implements a deep EPPProtection compare.
      java.lang.String getCc()
      Gets two-character code of the country in which the mark is protected from [ISO3166-2].
      java.lang.String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      java.lang.String getRegion()
      Gets the name of the city, state, province or other geographic region in which the mark is protected.
      java.util.List<java.lang.String> getRulings()
      Gets the list of two-character country codes of the countries of the ruling.
      void setCc​(java.lang.String aCc)
      Sets two-character code of the country in which the mark is protected.
      void setRegion​(java.lang.String aRegion)
      Sets the name of the city, state, province or other geographic region in which the mark is protected.
      void setRulings​(java.util.List<java.lang.String> aRulings)
      Sets the list of two-character country codes of the countries of the ruling.
      java.lang.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 Detail

      • ELM_LOCALNAME

        public static final java.lang.String ELM_LOCALNAME
        Constant for the local name
        See Also:
        Constant Field Values

      • ELM_NAME

        public static final java.lang.String ELM_NAME
        Constant for the tag name
        See Also:
        Constant Field Values

    • Constructor Detail

      • EPPProtection

        public EPPProtection()
        Default constructor for EPPProtection.

      • EPPProtection

        public EPPProtection​(java.lang.String aCC,
                     java.lang.String aRegion)
        Constructor that takes all of the EPPProtection required attributes.
        Parameters:
        aCC - Two-character code of the country in which the mark is protected.
        aRegion - Name of the city, state, province or other geographic region in which the mark is protected.

      • EPPProtection

        public EPPProtection​(java.lang.String aCC,
                     java.lang.String aRegion,
                     java.lang.String aRuling)
        Constructor that takes all of the EPPProtection attributes with a single ruling country.
        Parameters:
        aCC - Two-character code of the country in which the mark is protected.
        aRegion - Name of the city, state, province or other geographic region in which the mark is protected.
        aRuling - Identify the country where the statute was enacted

      • EPPProtection

        public EPPProtection​(java.lang.String aCC,
                     java.lang.String aRegion,
                     java.util.List<java.lang.String> aRulings)
        Constructor that takes all of the EPPProtection attributes.
        Parameters:
        aCC - Two-character code of the country in which the mark is protected.
        aRegion - Name of the city, state, province or other geographic region in which the mark is protected.
        aRulings - List of two-character code of countries of the ruling.

    • Method Detail

      • clone

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

      • encode

        public org.w3c.dom.Element encode​(org.w3c.dom.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.

      • equals

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

      • getCc

        public java.lang.String getCc()
        Gets two-character code of the country in which the mark is protected from [ISO3166-2].
        Returns:
        Two-character code of the country in which the mark is protected if set; null otherwise.

      • setCc

        public void setCc​(java.lang.String aCc)
        Sets two-character code of the country in which the mark is protected. This is a two-character code from [ISO3166-2].
        Parameters:
        aCc - Two-character code of the country in which the mark is protected from [ISO3166-2].

      • getRegion

        public java.lang.String getRegion()
        Gets the name of the city, state, province or other geographic region in which the mark is protected.
        Returns:
        the name of the city, state, province or other geographic region in which the mark is protected if set; null otherwise.

      • setRegion

        public void setRegion​(java.lang.String aRegion)
        Sets the name of the city, state, province or other geographic region in which the mark is protected.
        Parameters:
        aRegion - Name of the city, state, province or other geographic region in which the mark is protected.

      • getRulings

        public java.util.List<java.lang.String> getRulings()
        Gets the list of two-character country codes of the countries of the ruling.
        Returns:
        The countries of the rulings if set; Empty List otherwise.

      • setRulings

        public void setRulings​(java.util.List<java.lang.String> aRulings)
        Sets the list of two-character country codes of the countries of the ruling.
        Parameters:
        aRulings - The countries of the ruling

      • addRuling

        public void addRuling​(java.lang.String aRuling)
        Adds a country for to the list of countries for the ruling.
        Parameters:
        aRuling - Two-character code of the countries of the ruling. This is a two-character code from [ISO3166-2].

      • toString

        public java.lang.String toString()
        Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
        Overrides:
        toString in class java.lang.Object
        Returns:
        Indented XML String if successful; ERROR otherwise.

      • getNamespace

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