public final class CSCreditCardInfoMultiple extends CSItemMultiple
The CSCreditCardInfoMultiple
class provides a method that retrieves all credit card information items
from the database.
All database access/connectivity is handled internally by the CSCreditCardInfoMultiple
class.
CSCreditCardInfo
,
Serialized FormLEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
Constructor and Description |
---|
CSCreditCardInfoMultiple()
Creates an empty
CSCreditCardInfoMultiple object. |
CSCreditCardInfoMultiple(java.lang.String strPropertyFile)
Creates a new
CSCreditCardInfoMultiple , specifying a properties file that contains all of the
database connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSCreditCardInfoMultiple . |
boolean |
exist()
Not currently implemented for
CSCreditCardInfoMultiple . |
void |
get()
Retrieves the details of all credit card information items from the database.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setSortOrder(java.lang.String strSortOrderList)
Sets the order in which the credit card information items are to be retrieved.
|
void |
update()
Not currently implemented for
CSCreditCardInfoMultiple . |
equals, getItems, getMaxRows, getSortOrder, getStartRow, iterator, setItems, setMaxRows, setStartRow, toString
clearRecordedGatewayMessages, clone, count, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache
public CSCreditCardInfoMultiple()
CSCreditCardInfoMultiple
object.
Use the various set
methods provided to initialise the CSCreditCardInfoMultiple
object prior to invoking any of its query methods.
public CSCreditCardInfoMultiple(java.lang.String strPropertyFile)
CSCreditCardInfoMultiple
, specifying a properties file that contains all of the
database connection details.
Use the various set methods provided to initialise the CSCreditCardInfoMultiple
object prior to
invoking any of its query methods.
strPropertyFile
- the property file that contains the connection details.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 void setSortOrder(java.lang.String strSortOrderList) throws CSParameterException
One or more of the available sort orders may be specified as a comma-delimited list. Use ASC or DESC to indicate the direction of ordering for a sort order. For example, "CardName DESC" would order in descending order of the credit card name. The default sort order in this instance is 'DisplayOrder ASC'.
Available sort orders are :
CardInfoID - order by the credit card information item ID
CardName - order by the credit card name
DisplayOrder - order by the display order
setSortOrder
in class CSItemMultiple
strSortOrderList
- a comma-separated list of one or more of the available sort orders.CSParameterException
- if an invalid sort order was specifiedpublic boolean exist() throws CSException
CSCreditCardInfoMultiple
.
exist
in class CSItemMultiple
true
if all credit card information items exist on the database.CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSException
- the base class for exceptions thrown by this method.public void get() throws CSException
Each retrieved credit card information item is stored as a CSCreditCardInfo
object within the item
ArrayList
member of CSCreditCardInfoMultiple
- use getItems
or
iterator
to access/navigate through them. These credit card information items will be stored
in the ArrayList
in the order specified using the setSortOrder
method, or the default sort order of 'DisplayOrder ASC'.
get
in class CSItemMultiple
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 update() throws CSException
CSCreditCardInfoMultiple
.
update
in class CSItemMultiple
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSCreditCardInfoMultiple
.
delete
in class CSItemMultiple
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.