|
||||||||||
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.DeleteProductRequest
public class DeleteProductRequest
Represents a request to delete a product on a CM
Nested Class Summary | |
---|---|
static class |
DeleteProductRequest.DeleteProductReason
Used to define the reason for deleting the product |
Constructor Summary | |
---|---|
DeleteProductRequest()
Create a request with no intialised parameters. |
|
DeleteProductRequest(String cardId,
CardType cardType,
String productName)
Sets all the required parameters with the provided values, except a product instance ID, which must be added by calling addProductInstanceId(String, String) |
Method Summary | |
---|---|
DeleteProductRequest |
addParam(String key,
Object value)
Add a parameter to the request. |
DeleteProductRequest |
addProductInstanceId(IPEInstanceID instanceId)
Set the details of the ISAM that created a product to be deleted. |
DeleteProductRequest |
addProductInstanceId(String isamId,
String isamSeqNum)
Set the details of the ISAM that created a product to be deleted |
DeleteProductRequest |
setCardId(String cardId)
Set the ID of the card to modify |
DeleteProductRequest |
setCardType(CardType cardType)
Set the type of the card to modify |
DeleteProductRequest |
setIsRefund(boolean refund)
Deprecated. Replaced by DeleteProductRequest.DeleteProductReason . See setReason(DeleteProductReason) |
DeleteProductRequest |
setProductName(String productName)
Set the name of the product to deduct journeys from |
DeleteProductRequest |
setReason(DeleteProductRequest.DeleteProductReason reason)
Set the reason for deleting the product |
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 DeleteProductRequest()
setCardId(String)
,
setCardType(CardType)
,
addProductInstanceId(String, String)
,
setProductName(String)
public DeleteProductRequest(String cardId, CardType cardType, String productName)
addProductInstanceId(String, String)
cardId
- ID of the card with the product that should be deletedcardType
- The type of the cardproductName
- The name of the productMethod Detail |
---|
public DeleteProductRequest setCardId(String cardId)
cardId
- ID of the card to modify
public DeleteProductRequest setCardType(CardType cardType)
cardType
- Type of the card to modify
public DeleteProductRequest setProductName(String productName)
productName
- Name of the product to add journeys to
public DeleteProductRequest addProductInstanceId(IPEInstanceID instanceId)
addProductInstanceId(String, String)
with InstanceID.getISAMID()
and IPEInstanceID.getISAMSeqNum()
instanceId
- ID containing the creating ISAM's ID and sequence number
public DeleteProductRequest addProductInstanceId(String isamId, String isamSeqNum)
isamId
- ID of the ISAMisamSeqNum
- Sequence number of the ISAM
public DeleteProductRequest setIsRefund(boolean refund)
DeleteProductRequest.DeleteProductReason
. See setReason(DeleteProductReason)
refund
- Whether the product is being deleted as part of a refund
public DeleteProductRequest setReason(DeleteProductRequest.DeleteProductReason reason)
reason
- reason for deletion
public DeleteProductRequest addParam(String key, Object value)
ModifyRequest
value
will be converted by
calling Object.toString()
addParam
in class ModifyRequest
key
- The key for the parametervalue
- The value of the parameter
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 |