Package com.verisign.epp.codec.org
Class EPPOrgContact
java.lang.Object
com.verisign.epp.codec.org.EPPOrgContact
- All Implemented Interfaces:
EPPCodecComponent,Serializable,Cloneable
Represents an org contact. The valid contact types are defined by the
EPPOrgContact.Type enumeration.- See Also:
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor forEPPOrgContact.EPPOrgContact(String aContactId, EPPOrgContact.Type aType) EPPOrgContactthat takes all attributes as arguments (contactId and type).EPPOrgContact(String aContactId, EPPOrgContact.Type aType, String aTypeName) EPPOrgContactthat takes all attributes as arguments (contactId and type). -
Method Summary
Modifier and TypeMethodDescriptionclone()CloneEPPOrgContact.voidDecode theEPPOrgContactattributes from the aElement DOM Element tree.Encode a DOM Element tree from the attributes of theEPPOrgContactinstance.booleanimplements a deepEPPOrgContactcompare.Gets the contact identifier of the contact.Returns the XML namespace associated with theEPPCodecComponent.getType()Gets the contact type using theEPPOrgContact.Typeenumeration.Gets the optional type name for theCUSTOMtype.booleanIs the type name defined?voidsetContactId(String aContactId) Sets the contact identifier of the contact.voidsetType(EPPOrgContact.Type aType) Sets the contact type using theEPPOrgContact.Typeenumeration.voidsetTypeName(String aTypeName) Gets the optional type name for theCUSTOMtype.toString()Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.
-
Field Details
-
ELM_LOCALNAME
XML local name forEPPOrgContact.- See Also:
-
ELM_NAME
XML root tag forEPPOrgContact.- See Also:
-
-
Constructor Details
-
EPPOrgContact
public EPPOrgContact()Default constructor forEPPOrgContact. -
EPPOrgContact
EPPOrgContactthat takes all attributes as arguments (contactId and type).- Parameters:
aContactId- Contact IdentifieraType- Contact Type usingEPPOrgContact.Typeenumeration.
-
EPPOrgContact
EPPOrgContactthat takes all attributes as arguments (contactId and type).- Parameters:
aContactId- Contact IdentifieraType- Contact Type usingEPPOrgContact.Typeenumeration.aTypeName- Name of a "custom" type
-
-
Method Details
-
getType
Gets the contact type using theEPPOrgContact.Typeenumeration.- Returns:
- Contact type if defined;
nullotherwise.
-
setType
Sets the contact type using theEPPOrgContact.Typeenumeration.- Parameters:
aType- Contact type
-
getContactId
Gets the contact identifier of the contact.- Returns:
- Contact identifier if defined;
nullotherwise.
-
setContactId
Sets the contact identifier of the contact.- Parameters:
aContactId- Contact identifier of the contact
-
hasTypeName
public boolean hasTypeName()Is the type name defined?- Returns:
trueif the type name is defined;falseotherwise.
-
getTypeName
Gets the optional type name for theCUSTOMtype.- Returns:
- the parentId
-
setTypeName
Gets the optional type name for theCUSTOMtype.- Parameters:
aTypeName- the parentId to set
-
encode
Encode a DOM Element tree from the attributes of theEPPOrgContactinstance.- Specified by:
encodein interfaceEPPCodecComponent- Parameters:
aDocument- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPOrgContactinstance. - Throws:
EPPEncodeException- Unable to encodeEPPOrgContactinstance.
-
decode
Decode theEPPOrgContactattributes from the aElement DOM Element tree.- Specified by:
decodein interfaceEPPCodecComponent- Parameters:
aElement- Root DOM Element to decodeEPPOrgContactfrom.- Throws:
EPPDecodeException- Unable to decode aElement.
-
equals
implements a deepEPPOrgContactcompare. -
clone
CloneEPPOrgContact.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classObject- Returns:
- clone of
EPPOrgContact - Throws:
CloneNotSupportedException- standard Object.clone exception
-
toString
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent. -
getNamespace
Returns the XML namespace associated with theEPPCodecComponent.- Specified by:
getNamespacein interfaceEPPCodecComponent- Returns:
- XML namespace for the
EPPCodecComponent.
-