|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ecebs.rtd.enabler.types.request.ModifyRequest
com.ecebs.rtd.enabler.types.request.DeductStoredUseRequest
public class DeductStoredUseRequest
Represents a request to deduct a number of stored uses from a product on a CM
Nested Class Summary | |
---|---|
static class |
DeductStoredUseRequest.DeductStoredUseReason
|
Constructor Summary | |
---|---|
DeductStoredUseRequest()
Create a request with no initialised parameters. |
|
DeductStoredUseRequest(String cardId,
CardType cardType,
String identifier,
String productName,
int numUses)
Sets all the required parameters with the provided values. |
Method Summary | |
---|---|
DeductStoredUseRequest |
addParam(String key,
Object value)
Add a parameter to the request. |
DeductStoredUseRequest |
setCardId(String cardId)
Set the ID of the card to modify |
DeductStoredUseRequest |
setCardType(CardType cardType)
Set the type of the card to modify |
DeductStoredUseRequest |
setIdentifierId(String identifier)
Set the details of the ISAM that created the product |
DeductStoredUseRequest |
setProductName(String productName)
Set the name of the product to deduct stored uses from |
DeductStoredUseRequest |
setReason(DeductStoredUseRequest.DeductStoredUseReason reason)
Set the reason for the debit taking place |
DeductStoredUseRequest |
setUses(int uses)
Set the number of stored uses to deduct |
Outcome |
validate()
Validate that the required fields have been set |
Methods inherited from class com.ecebs.rtd.enabler.types.request.ModifyRequest |
---|
getCardId, getCardType, getRequestId, setRequestId |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DeductStoredUseRequest()
setCardId(String)
,
setCardType(CardType)
,
setUses(int)
,
setIdentifierId(String)
,
setProductName(String)
public DeductStoredUseRequest(String cardId, CardType cardType, String identifier, String productName, int numUses)
cardId
- ID of the card with the product that stored uses should be deducted fromcardType
- The type of the cardidentifier
- The identifier of the ISAM that created the productproductName
- The name of the productnumUses
- The number of stored uses to be deductedMethod Detail |
---|
public DeductStoredUseRequest setCardId(String cardId)
cardId
- ID of the card to modify
public DeductStoredUseRequest setCardType(CardType cardType)
cardType
- Type of the card to modify
public DeductStoredUseRequest setProductName(String productName)
productName
- Name of the product to deduct stored uses from
public DeductStoredUseRequest setUses(int uses)
numUses
- Number of stored uses to deduct
public DeductStoredUseRequest setReason(DeductStoredUseRequest.DeductStoredUseReason reason)
reason
- Reason for the debit taking place
public DeductStoredUseRequest addParam(String key, Object value)
addParam
in class ModifyRequest
key
- The key for the parametervalue
- The value of the parameter
public DeductStoredUseRequest setIdentifierId(String identifier)
identifier
- The identifier of the ISAM that created the product to be updated.
public Outcome validate()
Request
validate
in interface Request
validate
in class ModifyRequest
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |