class EppStatus

This EppStatus class implements EPP Status entity.

Inheritance:


Public Methods

[more] EppStatus()
Creates an EppStatus object, with default status as "ok" and language as "en"
[more] EppStatus( DOMString status )
Creates an EppStatus object with a status code
[more] EppStatus( DOMString status, DOMString lang, DOMString message )
Creates an EppStatus object with a status code, and a descriptive message
[more] ~EppStatus()
Destructor
[more]DOMString getMessage()
Gets the description message associated with the EppStatus object
[more]void setMessage( DOMString message )
Sets the description message associated with the EppStatus object
[more]DOMString getStatus()
Gets the status code string
[more]void setStatus( DOMString status )
Sets the status code string
[more]DOMString getLanguage()
Gets the language for encoding the description message
[more]void setLanguage( DOMString language )
Sets the language for encoding the description message
[more]DOM_Element toXML( DOM_Document& doc, const DOMString& tag )
Converts the EppStatus object into an XML element
[more]static EppStatus* fromXML( const DOM_Node& root )
Converts an XML element into an EppStatus object.


Inherited from EppEntity:

Public Methods

ovirtual int getEntityType()
obool instanceOf( const int type )
ovirtual DOMString toString()

Protected Methods

oDOMString toString( const DOMString &tag )


Documentation

This EppStatus class implements EPP Status entity. Different EPP objects have different status values:

o EppStatus()
Creates an EppStatus object, with default status as "ok" and language as "en"

o EppStatus( DOMString status )
Creates an EppStatus object with a status code

o EppStatus( DOMString status, DOMString lang, DOMString message )
Creates an EppStatus object with a status code, and a descriptive message

o ~EppStatus()
Destructor

oDOMString getMessage()
Gets the description message associated with the EppStatus object

ovoid setMessage( DOMString message )
Sets the description message associated with the EppStatus object

oDOMString getStatus()
Gets the status code string

ovoid setStatus( DOMString status )
Sets the status code string

oDOMString getLanguage()
Gets the language for encoding the description message

ovoid setLanguage( DOMString language )
Sets the language for encoding the description message

oDOM_Element toXML( DOM_Document& doc, const DOMString& tag )
Converts the EppStatus object into an XML element

Parameters:
doc - the XML DOM_Element object
tag - the tag/element name for the EppStatus object
Returns:
an DOM_Element object

ostatic EppStatus* fromXML( const DOM_Node& root )
Converts an XML element into an EppStatus object. The caller of this method must make sure that the root node is of the EPP Status type.

Parameters:
root - root node for an EppStatus object in XML format
Returns:
an EppStatus object, or null if the node is invalid


This class has no child classes.
Author:
Ning Zhang ning.zhang@neustar.com
Version:
$Revision$ $Date$

Alphabetic index HTML hierarchy of classes or Java


Copyright © 2001 NeuStar, Inc. All Rights Reserved.