com.highdeal.guiding.common

Class GuidingRequest

java.lang.Object

com.highdeal.guiding.common.GuidingRequest

public class GuidingRequest
extends java.lang.Object

This Java class represents a guiding request.

A guiding request is composed of a service ID (SID), a user service ID (USID) and a consumption date (or usage date) of the digital service.

Implementation in Your Client Application

Depending on your requirements, you define the appropriate guiding requests.

See Also:

BatchServiceClient.guiderLookup(com.highdeal.guiding.common.GuidingRequest), BatchServiceClient.guiderLookup(com.highdeal.guiding.common.GuidingRequest[]), AsyncBatchServiceClient.guiderLookup(com.highdeal.guiding.common.GuidingRequest[], com.highdeal.guiding.GuidingServiceClientListener), AsyncBatchServiceClient.guiderLookup(com.highdeal.guiding.common.GuidingRequest, com.highdeal.guiding.GuidingServiceClientListener)

Constructor Summary

Constructors

Constructor and Description
GuidingRequest(java.lang.String userServiceId, java.lang.String serviceId, java.util.Date consumptionDate) Constructs a guiding request with its user service identifier (USID), service identifier (SID), and service consumption date.
GuidingRequest(java.lang.String userServiceId, java.lang.String serviceId, short partitionId, java.util.Date consumptionDate) Constructs a guiding request with its user service identifier (USID), service identifier (SID), service consumption date, and a database partition identifier.

Method Summary

Modifier and Type	Method and Description
java.util.Date	getConsumptionDate() Gets the consumption date defined in the guiding request; it relates to the usage of the digital service by an end customer of the service provider.
long	getDistributionId() Gets the distribution ID defined in the guiding request.
short	getPartitionId() Gets the partition ID defined in the guiding request.
java.lang.String	getServiceId() Gets the service ID (SID) defined in the guiding request.
java.lang.String	getUserServiceId() Gets the user service ID (USID) defined in the guiding request.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuidingRequest

public GuidingRequest(java.lang.String userServiceId,
                      java.lang.String serviceId,
                      java.util.Date consumptionDate)

Constructs a guiding request with its user service identifier (USID), service identifier (SID), and service consumption date.

Parameters:

userServiceId - The user service identifier (USID); a technical key that identifies an end-customer within the digital service

serviceId - The technical identifier of the consummed digital service

consumptionDate - The usage or consumption date of the digital service

GuidingRequest

public GuidingRequest(java.lang.String userServiceId,
                      java.lang.String serviceId,
                      short partitionId,
                      java.util.Date consumptionDate)

Constructs a guiding request with its user service identifier (USID), service identifier (SID), service consumption date, and a database partition identifier.

Parameters:

userServiceId - The user service identifier (USID); a technical key that identifies an end-customer within the digital service

serviceId - The technical identifier of the consummed digital service

partitionId - The partition identifier of customer master data stored in the back-end database

consumptionDate - The usage or consumption date of the digital service

Method Detail

getUserServiceId

public java.lang.String getUserServiceId()

Gets the user service ID (USID) defined in the guiding request.

Returns:

The user service ID of the guiding request

getServiceId

public java.lang.String getServiceId()

Gets the service ID (SID) defined in the guiding request.

Returns:

The service ID of the guiding request

getDistributionId

public long getDistributionId()

Gets the distribution ID defined in the guiding request.

Returns:

The distribution ID of the guiding request

getPartitionId

public short getPartitionId()

Gets the partition ID defined in the guiding request.

Returns:

The partition ID of the guiding request

getConsumptionDate

public java.util.Date getConsumptionDate()

Gets the consumption date defined in the guiding request; it relates to the usage of the digital service by an end customer of the service provider.

Returns:

The usage or consumption date of the digital service