|
||||||||||
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.UpdatePassExpiryDateRequest
public class UpdatePassExpiryDateRequest
Represents a request to update the expiry of the current pass of an ITSO TYP22 product on a CM
Nested Class Summary | |
---|---|
static class |
UpdatePassExpiryDateRequest.UpdatePassExpiryDateReason
|
Constructor Summary | |
---|---|
UpdatePassExpiryDateRequest()
Create a request with no initialised parameters. |
|
UpdatePassExpiryDateRequest(String cardId,
CardType cardType,
String identifier,
String productName,
Calendar passExpiry)
Sets all the required parameters with the provided values. |
Method Summary | |
---|---|
UpdatePassExpiryDateRequest |
addParam(String key,
Object value)
Add a parameter to the request. |
UpdatePassExpiryDateRequest |
setCardId(String cardId)
Set the ID of the card to modify |
UpdatePassExpiryDateRequest |
setCardType(CardType cardType)
Set the type of the card to modify |
UpdatePassExpiryDateRequest |
setIdentifierId(String identifier)
Set the details of the ISAM that created the product |
UpdatePassExpiryDateRequest |
setPassExpiryDate(Calendar passExpiry)
Set the new expiry date of the current pass |
UpdatePassExpiryDateRequest |
setProductName(String productName)
Set the name of the product to modify |
UpdatePassExpiryDateRequest |
setReason(UpdatePassExpiryDateRequest.UpdatePassExpiryDateReason reason)
Set the reason for the update taking place |
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 UpdatePassExpiryDateRequest()
setCardId(String)
,
setCardType(CardType)
,
setIdentifierId(String)
,
setProductName(String)
,
#setPassExpiry(Calendar)
public UpdatePassExpiryDateRequest(String cardId, CardType cardType, String identifier, String productName, Calendar passExpiry)
cardId
- ID of the card with the product for which the pass expiry
should be updatedcardType
- The type of the cardidentifier
- The identifier of the ISAM that created the productproductName
- The name of the productpassExpiry
- The new expiry date for the period passMethod Detail |
---|
public UpdatePassExpiryDateRequest setCardId(String cardId)
cardId
- ID of the card to modify
public UpdatePassExpiryDateRequest setCardType(CardType cardType)
cardType
- Type of the card to modify
public UpdatePassExpiryDateRequest setReason(UpdatePassExpiryDateRequest.UpdatePassExpiryDateReason reason)
reason
- Reason for the update taking place
public UpdatePassExpiryDateRequest setProductName(String productName)
productName
- Name of the product to modify
public UpdatePassExpiryDateRequest addParam(String key, Object value)
addParam
in class ModifyRequest
key
- The key for the parametervalue
- The value of the parameter
public UpdatePassExpiryDateRequest setIdentifierId(String identifier)
identifier
- The identifier of the ISAM that created the product to be updated.
public UpdatePassExpiryDateRequest setPassExpiryDate(Calendar passExpiry)
passExpiry
- The new expiry date of the pass
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 |