com.highdeal.pnr.hci

Class ImportOp

java.lang.Object

com.highdeal.pnr.hci.ImportOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class ImportOp
extends java.lang.Object
implements MessageOperation

This operation allows to import a pnrObjectSet.

Implementation in Your Client Application

Options

If an object in the set contains some elements managed in chronology, it is possible to choose in the operation request to keep or not the chronologies. If the chronologies are kept, they will be fully stored in the back-end database. Otherwise, the behavior is the same than the modification operations. Elements will be put in their chronology, with a start period corresponding to the modification date set in this import operation request, and a stop period unbounded.

Note

Refer to the Export operation for more information details about what you can export/import in this version of SAP CC.

See Also:

ExportOp

Operation Result

ImportResult

Operation Failure Exceptions

• InvalidImportException
• InvalidCreationException
• InvalidModificationException
• ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="import">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="pnrObjectSet" minOccurs="1" maxOccurs="1"/>
    </xs:sequence>
     <xs:attribute name="chronologyKept" type="xs:boolean" default="false"/>
     <xs:attribute name="modificationDate" type="xs:dateTime" />
  </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 value of this constant is the XML tag name of this operation: "import".

Constructor Summary

Constructors

Constructor and Description
ImportOp() Creates an empty 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.util.Date	getModificationDate() Gets the modification date (used if chronologies are not kept).
java.lang.String	getName() Returns the name of the operation, that is "importPnrObject".
PnRObjectSet	getPnRObjectSet() Gets the PnRObjectSet.
boolean	isChronologyKept() Gets the flag that indicates if the chronologies are kept or not.
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	setChronologyKept(boolean chronologyKept) Sets the flag that indicates if the chronologies are kept or not.
void	setModificationDate(java.util.Date modificationDate) Sets the modification date (used if chronologies are not kept).
void	setPnRObjectSet(PnRObjectSet pnrObjectSet) Sets the PnRObjectSet.

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 value of this constant is the XML tag name of this operation: "import".

See Also:

Constant Field Values

Constructor Detail

ImportOp

public ImportOp()

Creates an empty operation.

Method Detail

getModificationDate

public java.util.Date getModificationDate()

Gets the modification date (used if chronologies are not kept).

Returns:

The date of the modification

setModificationDate

public void setModificationDate(java.util.Date modificationDate)

Sets the modification date (used if chronologies are not kept).

Parameters:

modificationDate - The modification date

isChronologyKept

public boolean isChronologyKept()

Gets the flag that indicates if the chronologies are kept or not.

Returns:

true if the chronologies are kept, else false

setChronologyKept

public void setChronologyKept(boolean chronologyKept)

Sets the flag that indicates if the chronologies are kept or not.

Parameters:

chronologyKept - The flag that indicates if the chronologies are kept or not

getName

public java.lang.String getName()

Returns the name of the operation, that is "importPnrObject".

Specified by:

getName in interface MessageOperation

Returns:

"importPnrObject"

getPnRObjectSet

public PnRObjectSet getPnRObjectSet()

Gets the PnRObjectSet.

Returns:

The pnr object set

setPnRObjectSet

public void setPnRObjectSet(PnRObjectSet pnrObjectSet)

Sets the PnRObjectSet.

Parameters:

pnrObjectSet - The pnr object set

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