com.highdeal.catalog.hci

Class CreateCatalogOp

java.lang.Object

com.highdeal.catalog.hci.CreateCatalogOp

All Implemented Interfaces:

CrossReferenceableOp, MessageOperation, XMLMarshallable

public class CreateCatalogOp
extends java.lang.Object
implements CrossReferenceableOp

This operation allows you to create a pricing catalog in the master data stored in SAP CC for a service provider; It triggers the creation of a tree catalog under the specified parent entry. If no parent is specified, then a root entry is created.

Operation Result

CreateCatalogResult

Operation Failure Exception

InvalidCreationException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="createCatalog">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="catalogEntry" minOccurs="1" maxOccurs="1"/>
     </xs:sequence>
     <xs:attribute name="opID" type="xs:string"/>
     <xs:attribute name="parent" type="xs:string"/>
     <xs:attribute name="parentID" type="xs:string"/>
   </xs:complexType>
 </xs:element>

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

Audit Domain

This operation is audited by the system as part of the audit domain: CATALOG. Consult the IT administrator.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The XML element name of this service operation: "createCatalog"

Constructor Summary

Constructors

Constructor and Description
CreateCatalogOp()

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.
CatalogEntryModel	getCatalogEntry() Gets the entry to be created.
java.lang.String	getName() Gets the name of operation.
java.lang.String	getOperationID() Gets the operation ID.
java.lang.String	getParentID() Gets the ID of the parent (as specified by a previous operation ID in the same message envelope).
java.lang.String	getParentRef() Gets the reference of the parent under which this entry should be created.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setCatalogEntry(CatalogEntryModel catalogEntry) Sets the catalog entry to be created.
void	setOperationID(java.lang.String id) Sets the operation ID.
void	setParentID(java.lang.String id) Sets the ID of the parent (as specified by a previous operation ID in the same message envelope).
void	setParentRef(java.lang.String ref) Sets the reference of the parent under which this entry should be created.

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 element name of this service operation: "createCatalog"

See Also:

Constant Field Values

Constructor Detail

CreateCatalogOp

public CreateCatalogOp()

Method Detail

getOperationID

public java.lang.String getOperationID()

Gets the operation ID.

Specified by:

getOperationID in interface CrossReferenceableOp

Returns:

The operation ID, or null if the operation has no ID

setOperationID

public void setOperationID(java.lang.String id)

Sets the operation ID.

Specified by:

setOperationID in interface CrossReferenceableOp

Parameters:

id - The operation ID

getName

public java.lang.String getName()

Gets the name of operation.

Specified by:

getName in interface MessageOperation

Returns:

"createCatalog"

getParentRef

public java.lang.String getParentRef()

Gets the reference of the parent under which this entry should be created.

Returns:

The reference of the parent, or null if if must be a root entry.

setParentRef

public void setParentRef(java.lang.String ref)

Sets the reference of the parent under which this entry should be created.

Parameters:

ref - The reference of the parent, or null if the new entry should be a root entry.

getParentID

public java.lang.String getParentID()

Gets the ID of the parent (as specified by a previous operation ID in the same message envelope).

Returns:

The identifier of the parent

setParentID

public void setParentID(java.lang.String id)

Sets the ID of the parent (as specified by a previous operation ID in the same message envelope).

Parameters:

id - The identifier of the parent

getCatalogEntry

public CatalogEntryModel getCatalogEntry()

Gets the entry to be created.

Returns:

The entry to be created

setCatalogEntry

public void setCatalogEntry(CatalogEntryModel catalogEntry)

Sets the catalog entry to be created. If creating a catalog root, parent AND type should be null. Otherwise, parent should not be null.

Parameters:

catalogEntry - The catalog entry to be created

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

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

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

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.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into