com.neulevel.epp.core
Class EppDataCollectionStatement

java.lang.Object
  com.neulevel.epp.core.EppEntity
      com.neulevel.epp.core.EppDataCollectionStatement

public class EppDataCollectionStatement
extends EppEntity

This EppDataCollectionStatement class implements EPP Data Collection Statement for the Data Collection Policy (DCP) entity.

An EPP Data Collection Statement object contains 3 components:

• Data collection purposes
• Data recipients
• Data retention pratices

Version:

$Revision: 1.2 $ $Date: 2006/03/01 01:35:38 $

Author:

Ning Zhang ning.zhang@neustar.com

Field Summary

static java.lang.String	PURPOSE_ADMIN DCP Statement Purpose Type - admin
static java.lang.String	PURPOSE_CONTACT DCP Statement Purpose Type - contact
static java.lang.String	PURPOSE_OTHER DCP Statement Purpose Type - other
static java.lang.String	PURPOSE_PROV DCP Statement Purpose Type - prov
static java.lang.String	RECIPIENT_OTHER DCP Statement Recipient Type - other
static java.lang.String	RECIPIENT_OURS DCP Statement Recipient Type - ours
static java.lang.String	RECIPIENT_PUBLIC DCP Statement Recipient Type - public
static java.lang.String	RECIPIENT_SAME DCP Statement Recipient Type - same
static java.lang.String	RECIPIENT_UNRELATED DCP Statement Recipient Type - unrelated
static java.lang.String	RETENTION_BUSINESS DCP Statement Retention Type - business
static java.lang.String	RETENTION_INDEFINITE DCP Statement Retention Type - indefinite
static java.lang.String	RETENTION_LEGAL DCP Statement Retention Type - legal
static java.lang.String	RETENTION_NONE DCP Statement Retention Type - none
static java.lang.String	RETENTION_STATED DCP Statement Retention Type - stated

Constructor Summary

EppDataCollectionStatement()
Creates an EppDataCollectionStatement object

Method Summary

static EppEntity	fromXML(org.w3c.dom.Node root) Converts an XML element into an EppDataCollectionStatement object.
java.lang.String	getOursReceiptientDesc() Gets the description of "ours" recipient, when the RECIPIENT_OURS flag is set.
boolean	getPurpose(java.lang.String purpose) Gets the flag of a statement purpose, for one of the following purpose types: PURPOSE_ADMIN PURPOSE_CONTACT PURPOSE_OTHER PURPOSE_PROV
boolean	getRecipient(java.lang.String recipient) Gets the flag of a statement recipient, for one of the following recipient types: RECIPIENT_OTHER RECIPIENT_OURS RECIPIENT_PUBLIC RECIPIENT_SAME RECIPIENT_UNRELATED
java.lang.String	getRetention() Gets the retention type, with one of the following values; RETENTION_BUSINESS RETENTION_INDEFINITE RETENTION_LEGAL RETENTION_NONE RETENTION_STATED
void	setOursRecipientDesc(java.lang.String desc) Sets the description of "ours" recipient, when the RECIPIENT_OURS flag is set.
void	setPurpose(java.lang.String purpose, boolean flag) Sets the flag of a statement purpose, for one of the following purpose types: PURPOSE_ADMIN PURPOSE_CONTACT PURPOSE_OTHER PURPOSE_PROV
void	setRecipient(java.lang.String recipient, boolean flag) Sets the flag of a statement recipient, for one of the following recipient types: RECIPIENT_OTHER RECIPIENT_OURS RECIPIENT_PUBLIC RECIPIENT_SAME RECIPIENT_UNRELATED
void	setRetention(java.lang.String type) Sets the retention type, with one of the following values: RETENTION_BUSINESS RETENTION_INDEFINITE RETENTION_LEGAL RETENTION_NONE RETENTION_STATED
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc, java.lang.String tag) Converts the EppDataCollectionStatement object into an XML element

Methods inherited from class com.neulevel.epp.core.EppEntity

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PURPOSE_ADMIN

public static final java.lang.String PURPOSE_ADMIN

DCP Statement Purpose Type - admin

Administrative purposes. Information can be used for administrative and technical support of the provisioning system.

See Also:

Constant Field Values

PURPOSE_CONTACT

public static final java.lang.String PURPOSE_CONTACT

DCP Statement Purpose Type - contact

Contact for marketing purposes. Information can be used to contact individuals, through a communications channel other than the protocol, for the promotion of a product or service.

See Also:

Constant Field Values

PURPOSE_PROV

public static final java.lang.String PURPOSE_PROV

DCP Statement Purpose Type - prov

Object provisioning purposes. Information can be used to identify objects and inter-object relationships.

See Also:

Constant Field Values

PURPOSE_OTHER

public static final java.lang.String PURPOSE_OTHER

DCP Statement Purpose Type - other

Other purposes. Information may be used in other ways not captured by the above definitions.

See Also:

Constant Field Values

RECIPIENT_OTHER

public static final java.lang.String RECIPIENT_OTHER

DCP Statement Recipient Type - other

Other entities following unknown practices.

See Also:

Constant Field Values

RECIPIENT_OURS

public static final java.lang.String RECIPIENT_OURS

DCP Statement Recipient Type - ours

Server operator and/or entities acting as agents or entities for whom the server operator is acting as an agent. An agent in this instance is defined as a third party that processes data only on behalf of the service provider for the completion of the stated purposes. An optional description string can be used to describe the recipient.

See Also:

Constant Field Values

RECIPIENT_PUBLIC

public static final java.lang.String RECIPIENT_PUBLIC

DCP Statement Recipient Type - public

Public forums.

See Also:

Constant Field Values

RECIPIENT_SAME

public static final java.lang.String RECIPIENT_SAME

DCP Statement Recipient Type - same

Other entities following server practices.

See Also:

Constant Field Values

RECIPIENT_UNRELATED

public static final java.lang.String RECIPIENT_UNRELATED

DCP Statement Recipient Type - unrelated

Unrelated third parties.

See Also:

Constant Field Values

RETENTION_BUSINESS

public static final java.lang.String RETENTION_BUSINESS

DCP Statement Retention Type - business

Data persists per business practices.

See Also:

Constant Field Values

RETENTION_INDEFINITE

public static final java.lang.String RETENTION_INDEFINITE

DCP Statement Retention Type - indefinite

Data persists indefinitely.

See Also:

Constant Field Values

RETENTION_LEGAL

public static final java.lang.String RETENTION_LEGAL

DCP Statement Retention Type - legal

Data persists per legal requirements.

See Also:

Constant Field Values

RETENTION_NONE

public static final java.lang.String RETENTION_NONE

DCP Statement Retention Type - none

Data is not persistent, and is not retained for more than a brief period of time necessary to make use of it during the course of a single online interaction.

See Also:

Constant Field Values

RETENTION_STATED

public static final java.lang.String RETENTION_STATED

DCP Statement Retention Type - stated

Data persists to meet the stated purpose.

See Also:

Constant Field Values

Constructor Detail

EppDataCollectionStatement

public EppDataCollectionStatement()

Creates an EppDataCollectionStatement object

Method Detail

getPurpose

public boolean getPurpose(java.lang.String purpose)

Gets the flag of a statement purpose, for one of the following purpose types:

• PURPOSE_ADMIN
• PURPOSE_CONTACT
• PURPOSE_OTHER
• PURPOSE_PROV

setPurpose

public void setPurpose(java.lang.String purpose,
                       boolean flag)

Sets the flag of a statement purpose, for one of the following purpose types:

• PURPOSE_ADMIN
• PURPOSE_CONTACT
• PURPOSE_OTHER
• PURPOSE_PROV

getRecipient

public boolean getRecipient(java.lang.String recipient)

Gets the flag of a statement recipient, for one of the following recipient types:

• RECIPIENT_OTHER
• RECIPIENT_OURS
• RECIPIENT_PUBLIC
• RECIPIENT_SAME
• RECIPIENT_UNRELATED

setRecipient

public void setRecipient(java.lang.String recipient,
                         boolean flag)

Sets the flag of a statement recipient, for one of the following recipient types:

• RECIPIENT_OTHER
• RECIPIENT_OURS
• RECIPIENT_PUBLIC
• RECIPIENT_SAME
• RECIPIENT_UNRELATED

getOursReceiptientDesc

public java.lang.String getOursReceiptientDesc()

Gets the description of "ours" recipient, when the RECIPIENT_OURS flag is set.

setOursRecipientDesc

public void setOursRecipientDesc(java.lang.String desc)

Sets the description of "ours" recipient, when the RECIPIENT_OURS flag is set.

getRetention

public java.lang.String getRetention()

Gets the retention type, with one of the following values;

• RETENTION_BUSINESS
• RETENTION_INDEFINITE
• RETENTION_LEGAL
• RETENTION_NONE
• RETENTION_STATED

setRetention

public void setRetention(java.lang.String type)

Sets the retention type, with one of the following values:

• RETENTION_BUSINESS
• RETENTION_INDEFINITE
• RETENTION_LEGAL
• RETENTION_NONE
• RETENTION_STATED

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc,
                                 java.lang.String tag)

Converts the EppDataCollectionStatement object into an XML element

Specified by:

toXML in class EppEntity

Parameters:

doc - the XML Document object

tag - the tag/element name for the EppDataCollectionStatement object

Returns:

an Element object

fromXML

public static EppEntity fromXML(org.w3c.dom.Node root)

Converts an XML element into an EppDataCollectionStatement object. The caller of this method must make sure that the root node is of the EPP Data Collection Statment.type.

Parameters:

root - root node for an EppDataCollectionStatement object in XML format

Returns:

an EppDataCollectionStatement object, or null if the node is invalid

toString

public java.lang.String toString()

Specified by:

toString in class EppEntity