com.highdeal.pnr.hci

Class ChargeExecutionContext

java.lang.Object

com.highdeal.pnr.hci.ChargeExecutionContext

public class ChargeExecutionContext
extends java.lang.Object

This Java class defines the conditions under which a charge operation is executed.

The conditions are defined as properties. The properties are grouped by domains. The list of the available domains is:

• ChargingResultContextDomain
• ChargingResultOnErrorContextDomain
• ChargingOutputContextDomain
• SenderContextDomain

Implementation in Your Client Application

Use the domains and related get methods to set up this class.

Setting up a Property in the Context

Code Snippet

The following snippet shows how to set up the value of a property of the charging result domain:

 ChargeExecutionContext context = new ChargeExecutionContext();
 context.getChargingResultDomain().setChargedItemReturned(true);
 

Viewing a Property in the Context

Code Snippet

The following snippet shows how to read the value of a property of the charging result domain:

 ChargeExecutionContext context = ...;
 ...
 boolean isChargedItemReturned = context.getChargingOutputDomain().isChargedItemReturned();
 

See the AsyncStatefulServiceClient.charge(...)

Constructor Summary

Constructors

Constructor and Description
ChargeExecutionContext() Creates a charge execution context with an empty OperationExecutionContext.
ChargeExecutionContext(OperationExecutionContext innerContext) Creates a charge execution context using the content of the specified OperationExecutionContext.

Method Summary

Modifier and Type	Method and Description
ChargeExecutionContext	duplicate() Returns a copy of this context, containing a copy of each of its properties.
ChargingOutputContextDomain	getChargingOutputDomain() Gets the domain used to configure the output of the charging operation.
ChargingResultContextDomain	getChargingResultDomain() Gets the domain used to configure the content of the result of the charging operation.
ChargingResultOnErrorContextDomain	getChargingResultOnErrorDomain() Gets the domain used to configure the content of the result of the charging operation when an error occurs.
OperationExecutionContext	getInnerContext() This method is reserved for SAP internal use only.
SenderContextDomain	getSenderDomain() Gets the domain used to specify information about the sender of the operation.
boolean	isNotificationPropertiesFormatted() Gets whether the properties of notification must be returned formatted in the result of the charging operation.
void	setNotificationPropertiesFormatted(boolean isNotificationPropertiesFormatted) Sets whether the properties of notification must be returned formatted in the result of the charging operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChargeExecutionContext

public ChargeExecutionContext()

Creates a charge execution context with an empty OperationExecutionContext.

ChargeExecutionContext

public ChargeExecutionContext(OperationExecutionContext innerContext)

Creates a charge execution context using the content of the specified OperationExecutionContext.

Parameters:

innerContext - The OperationExecutionContext to use

Method Detail

getInnerContext

public OperationExecutionContext getInnerContext()

This method is reserved for SAP internal use only.

getChargingResultDomain

public ChargingResultContextDomain getChargingResultDomain()

Gets the domain used to configure the content of the result of the charging operation.

Returns:

The domain used to configure the content of the result of the charging operation

getChargingResultOnErrorDomain

public ChargingResultOnErrorContextDomain getChargingResultOnErrorDomain()

Gets the domain used to configure the content of the result of the charging operation when an error occurs.

Returns:

The domain used to configure the content of the result of the charging operation when an error occurs

getChargingOutputDomain

public ChargingOutputContextDomain getChargingOutputDomain()

Gets the domain used to configure the output of the charging operation.

Returns:

The domain used to configure the output of the charging operation

getSenderDomain

public SenderContextDomain getSenderDomain()

Gets the domain used to specify information about the sender of the operation.

Returns:

The domain used to specify information about the sender of the operation

isNotificationPropertiesFormatted

public boolean isNotificationPropertiesFormatted()

Gets whether the properties of notification must be returned formatted in the result of the charging operation.

Returns:

true if the properties of notification must be returned formatted, false otherwise

setNotificationPropertiesFormatted

public void setNotificationPropertiesFormatted(boolean isNotificationPropertiesFormatted)

Sets whether the properties of notification must be returned formatted in the result of the charging operation.

Parameters:

isNotificationPropertiesFormatted - true to format the properties of notification returned, false otherwise

duplicate

public ChargeExecutionContext duplicate()

Returns a copy of this context, containing a copy of each of its properties.

Returns:

A copy of this context