public final class CSCommerceSettingMultiple extends CSItemMultiple
The CSCommerceSettingMultiple
class provides a method that retrieves several commerce settings from
the database. This method requires that certain database and key information (setting name list, for example) be
specified via the set
methods provided, prior to its invocation.
All database access/connectivity is handled internally by the CSCommerceSettingMultiple
class.
CSCommerceSetting
,
Serialized FormLEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
Constructor and Description |
---|
CSCommerceSettingMultiple()
Creates an empty
CSCommerceSettingMultiple object. |
CSCommerceSettingMultiple(java.lang.String strPropertyFile)
Creates a new
CSCommerceSettingMultiple , specifying a properties file that contains all of the
database connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSCommerceSettingMultiple . |
boolean |
exist()
Not currently implemented for
CSCommerceSettingMultiple . |
void |
get()
Retrieves the details of several commerce settings from the database.
|
java.lang.String |
getSettingIDList()
Gets the list of setting IDs specified as key information.
|
java.lang.String |
getSettingNameList()
Gets the list of commerce setting names specified as key information.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setSettingIDList(java.lang.String strSettingIDList)
Specifies the IDs of the commerce settings that are to be retrieved.
|
void |
setSettingNameList(java.lang.String strSettingNameList)
Specifies the names of the commerce settings that are to be retrieved.
|
void |
update()
Not currently implemented for
CSCommerceSettingMultiple . |
equals, getItems, getMaxRows, getSortOrder, getStartRow, iterator, setItems, setMaxRows, setSortOrder, 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 CSCommerceSettingMultiple()
CSCommerceSettingMultiple
object.
Use the various set
methods provided to initialise the CSCommerceSettingMultiple
object prior to invoking any of its query methods.
public CSCommerceSettingMultiple(java.lang.String strPropertyFile)
CSCommerceSettingMultiple
, specifying a properties file that contains all of the
database connection details.
Use the various set methods provided to initialise the CSCommerceSettingMultiple
object prior to
invoking any of its query methods.
strPropertyFile
- the property file that contains the connection details.public java.lang.String getSettingIDList()
public void setSettingIDList(java.lang.String strSettingIDList)
setSettingIDList
followed by a call to get
returns details of all the specified
commerce settings.
strSettingIDList
- a comma-separated list of commerce setting IDs.public java.lang.String getSettingNameList()
public void setSettingNameList(java.lang.String strSettingNameList)
setSettingNameList
followed by a call to get
returns details of all the specified
commerce settings.
strSettingNameList
- a comma-separated list of commerce setting names.public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method. Default is LEVEL_ALL.
Valid detail levels for a commerce setting are :
LEVEL_ID
Retrieves the SettingID.LEVEL_ALL
Retrieves the SettingID, Name, Value and ValidateType.setDetailLevel
in class CSDatabaseItem
nDetailLevel
- the detail level to be used.CSParameterException
- if an invalid detail level is specified.public boolean exist() throws CSException
CSCommerceSettingMultiple
.
exist
in class CSItemMultiple
true
if all commerce settings 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
Use get
without any key information to populate this CSCommerceSettingMultiple
object with the details of all the commerce settings from the database.
Use setSettingIDList
followed by get
to populate this
CSCommerceSettingMultiple
object with the details of the commerce settings specified in the list.
The retrieved commerce settings will appear within CSCommerceSettingMultiple
in the order that
their IDs appear within the supplied list. Key information set using setMaxRows
and
setStartRow
is not valid in this instance.
Use setSettingNameList
followed by get
to populate this
CSCommerceSettingMultiple
object with the details of the commerce settings specified in the list.
The retrieved commerce settings will appear within CSCommerceSettingMultiple
in the order that
their names appear within the supplied list. Key information set using setMaxRows
and
setStartRow
is not valid in this instance.
Each retrieved commerce setting is stored as a CSCommerceSetting
object within the item
ArrayList
member of CSCommerceSettingMultiple
- use getItems
or
iterator
to access/navigate through them. These commerce settings will be stored in the
ArrayList
in the same order as in the specified list.
get
in class CSItemMultiple
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 commerce settings 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
CSCommerceSettingMultiple
.
update
in class CSItemMultiple
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 commerce settings cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSCommerceSettingMultiple
.
delete
in class CSItemMultiple
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 commerce settings cannot be found on the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.