com.highdeal.pnr.hci
Class TransactionTemplateModel

java.lang.Object
  extended by com.highdeal.pnr.hci.TransactionTemplateModel
All Implemented Interfaces:
XMLMarshallable

public class TransactionTemplateModel
extends java.lang.Object
implements XMLMarshallable

A TransactionTemplateModel represents the required fields of the computed transactions. Each dispatch field contains the name of a rating context property. You configure this template in each charge customized in an offer.

See Also:
ChargeConditionModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="transactionTemplate">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="prepaidTransactionMapping" minOccurs="0" maxOccurs="1"/>
       <xs:element ref="detailTemplate" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="dispatch1" type="xs:string"/>
     <xs:attribute name="dispatch2" type="xs:string"/>
     <xs:attribute name="dispatch3" type="xs:string"/>
     <xs:attribute name="filtering" type="xs:boolean" default="true"/>
     <xs:attribute name="filterLabel" type="xs:boolean" default="false"/>
     <xs:attribute name="filterChargeCode" type="xs:boolean" default="false"/>
     <xs:attribute name="filterOfferCode" type="xs:boolean" default="false"/>
   </xs:complexType>
 </xs:element>


Constructor Summary
TransactionTemplateModel()
           
TransactionTemplateModel(java.lang.String dispatch1, java.lang.String dispatch2, java.lang.String dispatch3, boolean filtering, boolean filterLabel, boolean filterChargeCode, boolean filterOfferCode)
          Constructs a full transaction template.
 
Method Summary
 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.List<DetailTemplateModel> getDetailTemplates()
          Gets the details List.
 java.lang.String getDispatch1()
          Gets the dispatch property name number 1.
 java.lang.String getDispatch2()
          Gets the dispatch property name number 2.
 java.lang.String getDispatch3()
          Gets the dispatch property name number 3.
 PrepaidTransactionMappingModel getPrepaidTransactionMapping()
           
 boolean isFilterChargeCode()
          Checks if the main charge code field of transaction is filtered.
 boolean isFiltering()
          Checks if the transaction template is filtering.
 boolean isFilterLabel()
          Checks if the main label field of transaction is filtered.
 boolean isFilterOfferCode()
          Checks if the main offer code field of transaction is filtered.
 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 setDispatch1(java.lang.String name)
          Sets the dispatch property name number 1.
 void setDispatch2(java.lang.String name)
          Sets the dispatch property name number 2.
 void setDispatch3(java.lang.String name)
          Sets the dispatch property name number 3.
 void setFilterChargeCode(boolean filtering)
          Determines if the charge code main field of transaction must be filtered.
 void setFiltering(boolean filtering)
          Sets the filtering flag.
 void setFilterLabel(boolean filtering)
          Determines if the label main field of transaction must be filtered.
 void setFilterOfferCode(boolean filtering)
          Determines if the offer code main field of transaction must be filtered.
 void setPrepaidTransactionMappingModel(PrepaidTransactionMappingModel mapping)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TransactionTemplateModel

public TransactionTemplateModel()

TransactionTemplateModel

public TransactionTemplateModel(java.lang.String dispatch1,
                                java.lang.String dispatch2,
                                java.lang.String dispatch3,
                                boolean filtering,
                                boolean filterLabel,
                                boolean filterChargeCode,
                                boolean filterOfferCode)
Constructs a full transaction template.

Parameters:
dispatch1 - the property full name number 1.
dispatch2 - the property full name number 2.
dispatch3 - the property full name number 3.
filtering - the filtering mode.
filterLabel - the filtering transaction label flag.
filterChargeCode - the filetring transaction charge code flag.
filterOfferCode - the filtering transaction offer code flag.
Method Detail

getDispatch1

public java.lang.String getDispatch1()
Gets the dispatch property name number 1.

Returns:
the dispatch property name.

setDispatch1

public void setDispatch1(java.lang.String name)
Sets the dispatch property name number 1.

Parameters:
name - the dispatch property name.

getDispatch2

public java.lang.String getDispatch2()
Gets the dispatch property name number 2.

Returns:
the dispatch property name.

setDispatch2

public void setDispatch2(java.lang.String name)
Sets the dispatch property name number 2.

Parameters:
name - the dispatch property name.

getDispatch3

public java.lang.String getDispatch3()
Gets the dispatch property name number 3.

Returns:
the dispatch property name.

setDispatch3

public void setDispatch3(java.lang.String name)
Sets the dispatch property name number 3.

Parameters:
name - the dispatch property name.

getDetailTemplates

public java.util.List<DetailTemplateModel> getDetailTemplates()
Gets the details List.

Returns:
a List of Detail Template.

isFiltering

public boolean isFiltering()
Checks if the transaction template is filtering.

Returns:
true if filtering, false otherwise.

setFiltering

public void setFiltering(boolean filtering)
Sets the filtering flag.

Parameters:
filtering - true if filtering, false otherwise.

isFilterLabel

public boolean isFilterLabel()
Checks if the main label field of transaction is filtered.

Returns:
true if filtered, false otherwise.

setFilterLabel

public void setFilterLabel(boolean filtering)
Determines if the label main field of transaction must be filtered.

Parameters:
filtering - true if filtering, false otherwise.

isFilterChargeCode

public boolean isFilterChargeCode()
Checks if the main charge code field of transaction is filtered.

Returns:
true if filtered, false otherwise.

setFilterChargeCode

public void setFilterChargeCode(boolean filtering)
Determines if the charge code main field of transaction must be filtered.

Parameters:
filtering - true if filtering, false otherwise.

isFilterOfferCode

public boolean isFilterOfferCode()
Checks if the main offer code field of transaction is filtered.

Returns:
true if filtered, false otherwise.

setFilterOfferCode

public void setFilterOfferCode(boolean filtering)
Determines if the offer code main field of transaction must be filtered.

Parameters:
filtering - true if filtering, false otherwise.

getPrepaidTransactionMapping

public PrepaidTransactionMappingModel getPrepaidTransactionMapping()

setPrepaidTransactionMappingModel

public void setPrepaidTransactionMappingModel(PrepaidTransactionMappingModel mapping)

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

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

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

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)