com.highdeal.pnr.hci

Class CheckLimitResult

java.lang.Object

com.highdeal.pnr.hci.CheckLimitResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class CheckLimitResult
extends Object
implements OperationResult

The operation result that is returned by the SAP CC system in response to a check limit operation request.
Several operations are provided in the com.highdeal.cnd.message Java package that you can implement in your client application.

Operation Requests

• checkLimit (asynchronous)
• checkLimit (synchronous)

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="checkLimitResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="transac" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
    <xs:attribute name="prop" type="xs:string"/>
    <xs:attribute name="precision" type="xs:decimal"/>
    <xs:attribute name="limit" type="xs:decimal"/>
    <xs:attribute name="iterations" type="xs:integer"/>
    <xs:attribute name="isMaxLimit" type="xs:boolean"/>
   </xs:complexType>
  </xs:element>

Constructor Summary

Constructors

Constructor and Description
CheckLimitResult() Builds en empty check limit result

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
void	addTransaction(Transaction transaction) Adds a transaction to the result.
int	getIterations() Gets the iteration number
BigDecimal	getLimit() Returns the limit
String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
BigDecimal	getPrecision() Gets the precision
String	getPropertyName() Returns the name of the property that has been inversed; This method returns null if check limit has been done on a duration item.
Vector<Transaction>	getTransactions() Gets the list of returned transactions
List<Transaction>	getUnsynchronizedTransactions()
boolean	isMaxLimit() Checks if the limit is the maximum
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	setIterations(int iter) Sets the iteration number
void	setLimit(BigDecimal l) Sets the limit
void	setMaxLimit(boolean isMaxLimit) Sets the maximum limit flag
void	setPrecision(BigDecimal p) Sets the precision
void	setPropertyName(String name) Sets the property name that has been inversed

Methods inherited from class java.lang.Object

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

Constructor Detail

CheckLimitResult

public CheckLimitResult()

Builds en empty check limit result

Method Detail

getPropertyName

public String getPropertyName()

Returns the name of the property that has been inversed; This method returns null if check limit has been done on a duration item.

Returns:

The property name that has been inversed

setPropertyName

public void setPropertyName(String name)

Sets the property name that has been inversed

Parameters:

name - The property name that has been inversed

getLimit

public BigDecimal getLimit()

Returns the limit

Returns:

The limit

setLimit

public void setLimit(BigDecimal l)

Sets the limit

Parameters:

l - The limit

getPrecision

public BigDecimal getPrecision()

Gets the precision

Returns:

The precision

setPrecision

public void setPrecision(BigDecimal p)

Sets the precision

Parameters:

p - The precision

getIterations

public int getIterations()

Gets the iteration number

Returns:

The iteration number

setIterations

public void setIterations(int iter)

Sets the iteration number

Parameters:

iter - The iteration number

isMaxLimit

public boolean isMaxLimit()

Checks if the limit is the maximum

Returns:

true if the limit is the maximum

setMaxLimit

public void setMaxLimit(boolean isMaxLimit)

Sets the maximum limit flag

Parameters:

isMaxLimit - The maximum limit flag

getTransactions

public Vector<Transaction> getTransactions()

Gets the list of returned transactions

Returns:

The transaction list

getUnsynchronizedTransactions

public List<Transaction> getUnsynchronizedTransactions()

addTransaction

public void addTransaction(Transaction transaction)

Adds a transaction to the result.

Parameters:

transaction - the transaction to add to the result

getOperandReference

public String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the operation result

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(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

addCharacterData

public void addCharacterData(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

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