public final class CSCreditCardInfo extends CSItem
The CSCreditCardInfo
class includes methods for the retrieval of a particular credit card information
item's details.
All such methods require that certain database and key information (credit card information item ID, for example) be
specified via the set
methods provided, prior to their invocation.
All database access/connectivity is handled internally by the CSCreditCardInfo
class.
ACCESS_GRANTED, DOES_NOT_EXIST, EMPTY, EXISTS, SECURE_ACCESS_DENIED, SECURE_ACCESS_GRANTED, UPDATE_ACTION_INSERTED, UPDATE_ACTION_UPDATED
LEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
Constructor and Description |
---|
CSCreditCardInfo()
Creates an empty
CSCreditCardInfo object. |
CSCreditCardInfo(CSCreditCardInfo objItem)
Creates an empty
CSCreditCardInfo object, and initialises it from the contents of the supplied
CSItem object. |
CSCreditCardInfo(java.lang.String strPropertyFile)
Creates a new
CSCreditCardInfo , specifying a property file that contains all of the database
connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSCreditCardInfo . |
boolean |
exist()
Determines whether a credit card information item exists on the database.
|
void |
get()
Retrieves the details of a credit card information item from the database.
|
java.lang.String |
getBinNumbers()
Gets the bin numbers of the credit card information item.
|
java.lang.String |
getCardName()
Gets the card name of the credit card information item to be used as key information.
|
int |
getCreditCardInfoID()
Gets the ID of the credit card information item to be used as key information.
|
int |
getDisplayOrder()
Gets the display order of the credit card information item.
|
java.lang.String |
getMediaIDs()
Gets the IDs of the media items that are related to the credit card information item.
|
java.lang.String |
getNumberLengths()
Gets the number lengths of the credit card information item.
|
void |
setBinNumbers(java.lang.String strBinNumbers)
Sets the bin numbers of the credit card information item.
|
void |
setCardName(java.lang.String strCardName)
Sets the card name of the credit card information item to be used as key information.
|
void |
setCreditCardInfoID(int nCreditCardInfoID)
Sets the credit card information item ID to be used as key information.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setDisplayOrder(int nDisplayOrder)
Sets the display order of the credit card information item.
|
void |
setMediaIDs(java.lang.String strMediaIDs)
Sets the IDs of the media items that are related to the credit card information item.
|
void |
setNumberLengths(java.lang.String strNumberLengths)
Sets the number lengths of the credit card information item.
|
void |
update()
Not currently implemented for
CSCreditCardInfo . |
equals, getID, getStatus, hashCode, jsonString, serialiseWithTypes, setID, setStatus, toString, unset
clearRecordedGatewayMessages, clone, count, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache
public CSCreditCardInfo()
CSCreditCardInfo
object.
Use the various set methods provided to initialise the CSCreditCardInfo
object prior to invoking
any of its query methods.
public CSCreditCardInfo(CSCreditCardInfo objItem)
CSCreditCardInfo
object, and initialises it from the contents of the supplied
CSItem object.
objItem
- the CSCreditCardInfo
object to be used to initialise the new onepublic CSCreditCardInfo(java.lang.String strPropertyFile)
CSCreditCardInfo
, specifying a property file that contains all of the database
connection details.
Use the various set methods provided to initialise the CSCreditCardInfo
object prior to invoking
any of its query methods.
strPropertyFile
- the property file that contains the connection details.public int getCreditCardInfoID()
public void setCreditCardInfoID(int nCreditCardInfoID)
setCreditCardInfoID
followed by a call to get
will return details of the credit
card information item with the specified ID.
nCreditCardInfoID
- the credit card information item's ID to be used as key information.public java.lang.String getCardName()
public void setCardName(java.lang.String strCardName)
setCardName
followed by a call to get
will return details of the credit card
information item with the specified card name.
strCardName
- the credit card information item's card name to be used as key information.public java.lang.String getBinNumbers()
Bin numbers are the Bank Identification numbers. These are the credit card number sequences one of which must be
present on a valid credit card of the type identified by CardName
.
public void setBinNumbers(java.lang.String strBinNumbers)
Bin numbers are the Bank Identification numbers. These are the credit card number sequences one of which must be
present on a valid credit card of the type identified by CardName
.
strBinNumbers
- the credit card information item's comma-separated list of bin numbers.public java.lang.String getNumberLengths()
Card number lengths are the count of numerical digits that make-up the complete credit card number for a credit
card of the type identified by CardName
.
public void setNumberLengths(java.lang.String strNumberLengths)
Card number lengths are the count of numerical digits that make-up the complete credit card number for a credit
card of the type identified by CardName
.
strNumberLengths
- the credit card information item's comma-separated list of number lengths.public int getDisplayOrder()
public void setDisplayOrder(int nDisplayOrder)
nDisplayOrder
- the credit card information item's display order.public void setMediaIDs(java.lang.String strMediaIDs)
strMediaIDs
- a credit card information item's comma-separated list of related media item IDs.public java.lang.String getMediaIDs()
public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method. Default is LEVEL_ALL.
Valid detail levels for a credit card information item are :
LEVEL_ID
Retrieves the CardInfoID.LEVEL_SUMMARY
Retrieves the CardInfoID and CardName.LEVEL_DETAIL
Retrieves all the credit card information data.LEVEL_ALL
Retrieves all the credit card information data and related media item IDs.setDetailLevel
in class CSDatabaseItem
nDetailLevel
- the detail level to be used.CSParameterException
- if an invalid detail level is specified.public boolean exist() throws CSException
Use setCreditCardInfoID
followed by exist
to ascertain if there
is a credit card information item with the specified ID on the database.
Use setCardName
followed by exist
to ascertain if there is a credit
card information item with the specified credit card name on the database.
exist
in class CSItem
true
if this credit card information item exists on the database.CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSSecurityException
- if security has been breached.CSException
- the base class for exceptions thrown by this method.public void get() throws CSException
If it is not necessary to retrieve all the details of the credit card information item then specify the amount of
detail required using the setDetailLevel
method before calling this method.
Use setCreditCardInfoID
followed by get
to populate this
CSCreditCardInfo
object with the details of the credit card information item identified by the
specified ID.
Use setCardName
followed by get
to populate this
CSCreditCardInfo
object with the details of the credit card information item identified by the
specified credit card name.
get
in class CSItem
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if the specified credit card information item cannot be found on the database.CSSecurityException
- if security has been breached.CSException
- the base class for exceptions thrown by this method.public void update() throws CSException
CSCreditCardInfo
.
update
in class CSItem
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if one of the specified credit card information items cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSCreditCardInfo
.
delete
in class CSItem
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if one of the specified credit card information items cannot be found on the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.