com.highdeal.guiding.common
Class GuidingEntry

java.lang.Object
  com.highdeal.guiding.common.GuidingEntry

public class GuidingEntry
extends java.lang.Object

This Java class represents a guiding entry in the guider instances of the connected SAP CC system; it identifies customer master data owned by the service provider and that relates to the USID, SID, and service consumption date.

A guiding entry contains:

• A target and unique ID of the identified provider contract (or com.highdeal.pnr.hci.SubscriptionModel subscription) in customer master data owned by the service provider
• A flag ({@link AccessibleChargeType type}) that indicates if the target object is either a charging contract or a subscription
• The unique ID of a charge activation
• The unique ID of the {@link com.highdeal.pnr.hci.SubscriberAccountModel subscriber account} that manages the contract
• A database partition ID
• A batch rating group ID
• A validation date
• An expiration date

Note

This entry is returned in response to an operation request containing a user service ID, service ID, and a consumption date. Usually, guiding entries have no public visibility, as they are part of the internal communication between {@link com.highdeal.cnd.message.StatefulServiceClient} and the SAP CC Core Server system. However, {@link com.highdeal.cnd.message.BatchServiceClient} can return a guiding entry through the guiderLookup API operation(s), to implement some batch charge operations without using guiding.

Related Business Operations

All the Guider Lookup operations include a guiding entry in their operation responses via the asynchronous or synchronous communications.

Implementation in Your Client Application

Consider all the guiderLookup(..) methods specified in the {@link com.highdeal.cnd.message.BatchServiceClient BatchServiceClient} and {@link com.highdeal.cnd.message.AsyncBatchServiceClient AsyncBatchServiceClient} classes.

See Also:

AsyncBatchServiceClient, BatchServiceClient

Constructor Summary

GuidingEntry()
Construct an empty guiding entry.

Method Summary

short	getBatchRatingGroupId() Gets the batch rating group ID of the guiding entry.
long	getChargeId() Gets the activation charge ID of the guiding entry.
java.util.Date	getExpiryDate() Gets the expiration date of the guiding entry.
short	getPartitionId() Gets the partition ID of the guiding entry.
long	getSubscriberAccountId() Gets the unique identifier of the subscriber account related to the charging contract or subscription that is referenced by this guiding entry.
AccessibleChargeType	getTargetType() Gets the target type (contract or subscription) that the guiding entry refers to.
long	getTargetUniqueId() Gets the target ID of the guiding entry.
java.util.Date	getValidationDate() Gets the validation date of the guiding entry.
void	setBatchRatingGroupId(short batchRatingGroupId) SAP CC sets the batch rating group ID of the guiding entry.
void	setChargeId(long chargeId) SAP CC sets the activation charge ID of the guiding entry.
void	setExpiryDate(java.util.Date expiryDate) Sets the expiry date of the guiding entry.
void	setPartitionId(short partitionId) Sets the partition ID of the guiding entry.
void	setSubscriberAccountUniqueId(long subscriberAccountUniqueId) Sets the unique identifier of the subscriber account related to the charging contract or subscription that is referenced by this guiding entry.
void	setTargetType(AccessibleChargeType targetType) SAP CC sets the target type.
void	setTargetUniqueId(long targetUniqueId) Sets the target ID of the guiding entry.
void	setValidationDate(java.util.Date validationDate) Sets the validation date of the guiding entry.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuidingEntry

public GuidingEntry()

Construct an empty guiding entry.

Method Detail

getChargeId

public long getChargeId()

Gets the activation charge ID of the guiding entry.

Returns:

The activation charge ID of the guiding entry

setChargeId

public void setChargeId(long chargeId)

SAP CC sets the activation charge ID of the guiding entry.

Parameters:

chargeId - The activation charge ID of the guiding entry

getPartitionId

public short getPartitionId()

Gets the partition ID of the guiding entry.

Returns:

The partition ID of the guiding entry

setPartitionId

public void setPartitionId(short partitionId)

Sets the partition ID of the guiding entry.

Parameters:

partitionId - The partition ID of the guiding entry

getTargetType

public AccessibleChargeType getTargetType()

Gets the target type (contract or subscription) that the guiding entry refers to.

Returns:

The target type

setTargetType

public void setTargetType(AccessibleChargeType targetType)

SAP CC sets the target type.

Parameters:

targetType - The target type

getTargetUniqueId

public long getTargetUniqueId()

Gets the target ID of the guiding entry.

Returns:

The target ID of the guiding entry

setTargetUniqueId

public void setTargetUniqueId(long targetUniqueId)

Sets the target ID of the guiding entry.

Parameters:

targetUniqueId - The subscription ID of the guiding entry

getValidationDate

public java.util.Date getValidationDate()

Gets the validation date of the guiding entry.

Returns:

The validation date of the guiding entry

setValidationDate

public void setValidationDate(java.util.Date validationDate)

Sets the validation date of the guiding entry.

Parameters:

validationDate - The validation date of the guiding entry

getExpiryDate

public java.util.Date getExpiryDate()

Gets the expiration date of the guiding entry.

Returns:

The expiration date of the guiding entry

setExpiryDate

public void setExpiryDate(java.util.Date expiryDate)

Sets the expiry date of the guiding entry.

Parameters:

expiryDate - The expiry date of the guiding entry

getBatchRatingGroupId

public short getBatchRatingGroupId()

Gets the batch rating group ID of the guiding entry.

Returns:

The batch rating group ID of the guiding entry

setBatchRatingGroupId

public void setBatchRatingGroupId(short batchRatingGroupId)

SAP CC sets the batch rating group ID of the guiding entry.

Parameters:

batchRatingGroupId - The batch rating group ID of the guiding entry

getSubscriberAccountId

public long getSubscriberAccountId()

Gets the unique identifier of the subscriber account related to the charging contract or subscription that is referenced by this guiding entry.

Returns:

The unique ID of the subscriber account related to the charging contract or subscription that is referenced by this guiding entry if available, -1 otherwise

setSubscriberAccountUniqueId

public void setSubscriberAccountUniqueId(long subscriberAccountUniqueId)

Sets the unique identifier of the subscriber account related to the charging contract or subscription that is referenced by this guiding entry.

Parameters:

subscriberAccountUniqueId - The unique identifier of the subscriber account related to the charging contract or subscription that is referenced by this guiding entry