com.highdeal.pnr.hci

Class ExportSubscriberDataOp

java.lang.Object

com.highdeal.hci.MessageOperationAdapter

com.highdeal.pnr.hci.ExportSubscriberDataOp

All Implemented Interfaces:

IXMLMarshallable, MessageOperation, XMLMarshallable

public class ExportSubscriberDataOp
extends MessageOperationAdapter

This operation enables to export consistently a subscriber account or a subscription from its identifier.

With this operation you can transport this customer master data from a development system to a quality assurance or production system.

This master data is grouped in a Subscriber Data object:

• The export of a subscriber account includes all its related subscriptions, accesses and counter snapshots.
  The owner of the subscriber account is mandatory and must be specified in the operation.
• The export of a Subscription includes all its related Accesses and Counter Snapshots.

Note

All the available chronologies are part of the export.

Operation Result

ExportSubscriberDataResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="exportSubscriberData">
  <xs:complexType>
    <xs:attribute name="id" type="xs:string" use="required" />
    <xs:attribute name="owner" type="xs:string" use="optional" />
    <xs:attribute name="type" type="ExportSubscriberDataType" use="required" />
  </xs:complexType>
 </xs:element>

 <xs:simpleType name="ExportSubscriberDataType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="subscription" />
     <xs:enumeration value="subscriberAccount" />
   </xs:restriction>
 </xs:simpleType>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

Edition	Final Target Instances
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	Yes	No	No	No	No

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExportSubscriberDataOp.ExportSubscriberDataType This enumeration represents the types of exportable objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The XML name of the operation: exportSubscriberData

Constructor Summary

Constructors

Constructor and Description
ExportSubscriberDataOp() Builds an empty ExportSubscriberDataOp operation.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getId() Gets the identifier of the object to export.
java.lang.String	getName() Gets the XML name of the service operation.
java.lang.String	getOwner() Gets the owner of the object to export.
ExportSubscriberDataOp.ExportSubscriberDataType	getType() Gets the type of the object to export.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setId(java.lang.String id) Sets the identifier of the object to export.
void	setOwner(java.lang.String owner) Sets the owner of the object to export.
void	setType(ExportSubscriberDataOp.ExportSubscriberDataType type) Sets the type of the object to export.

Methods inherited from class com.highdeal.hci.MessageOperationAdapter

marshal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME

The XML name of the operation: exportSubscriberData

See Also:

Constant Field Values

Constructor Detail

ExportSubscriberDataOp

public ExportSubscriberDataOp()

Builds an empty ExportSubscriberDataOp operation.

Method Detail

getName

public java.lang.String getName()

Description copied from interface: MessageOperation

Gets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal the Java object representing an HCI operation into an XML representation that can be exchanged via the HCI communication interface between your client application and the SAP CC system.

Example

• activateAll
• ping

Returns:

The technical name of the HCI operation

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into

getId

public java.lang.String getId()

Gets the identifier of the object to export.

Returns:

The identifier of the object to export

See Also:

SubscriberAccountModel.getCode(), SubscriptionModel.getCode()

setId

public void setId(java.lang.String id)

Sets the identifier of the object to export.

Parameters:

id - The identifier of the object to export

See Also:

SubscriberAccountModel.getCode(), SubscriptionModel.getCode()

getOwner

public java.lang.String getOwner()

Gets the owner of the object to export.

Returns:

The owner of the object to export

See Also:

SubscriberAccountModel.getServiceProvider()

setOwner

public void setOwner(java.lang.String owner)

Sets the owner of the object to export.

Parameters:

owner - The owner of the object to export

See Also:

SubscriberAccountModel.getServiceProvider()

getType

public ExportSubscriberDataOp.ExportSubscriberDataType getType()

Gets the type of the object to export.

Returns:

The type of the object to export

setType

public void setType(ExportSubscriberDataOp.ExportSubscriberDataType type)

Sets the type of the object to export.

Parameters:

type - The type of the object to export