public final class CSCommerceSetting extends CSItem
The CSCommerceSetting
class includes methods for the retrieval of a particular commerce setting.
All such methods require that certain database and key information (setting name, for example) be specified via the
set
methods provided, prior to their invocation.
All database access/connectivity is handled internally by the CSCommerceSetting
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 |
---|
CSCommerceSetting()
Creates an empty
CSCommerceSetting object. |
CSCommerceSetting(CSCommerceSetting objItem)
Creates an empty
CSCommerceSetting object, and initialises it from the contents of the supplied
CSItem object. |
CSCommerceSetting(java.lang.String strPropertyFile)
Creates a new
CSCommerceSetting , specifying a property file that contains all of the database
connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSCommerceSetting . |
boolean |
exist()
Determines whether a commerce setting exists on the database.
|
void |
get()
Retrieves the details of a commerce setting from the database.
|
int |
getCommerceSettingID()
Gets the ID of the commerce setting to be used as key information.
|
java.lang.String |
getName()
Gets the name of the commerce setting to be used as key information.
|
java.lang.String |
getValidateType()
Gets the validate type of the commerce setting.
|
java.lang.Object |
getValue()
Gets the value of the commerce setting.
|
void |
setCommerceSettingID(int nCommerceSettingID)
Sets the commerce setting ID to be used as key information.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setName(java.lang.String strName)
Sets the name of the commerce setting to be used as key information.
|
void |
setValidateType(java.lang.String strValidateType)
Sets the validate type of the commerce setting.
|
void |
setValue(java.lang.Object objValue)
Sets the value of the commerce setting.
|
void |
update()
Not currently implemented for
CSCommerceSetting . |
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 CSCommerceSetting()
CSCommerceSetting
object.
Use the various set methods provided to initialise the CSCommerceSetting
object prior to invoking
any of its query methods.
public CSCommerceSetting(CSCommerceSetting objItem)
CSCommerceSetting
object, and initialises it from the contents of the supplied
CSItem object.
objItem
- the CSCommerceSetting
object to be used to initialise the new onepublic CSCommerceSetting(java.lang.String strPropertyFile)
CSCommerceSetting
, specifying a property file that contains all of the database
connection details.
Use the various set methods provided to initialise the CSCommerceSetting
object prior to invoking
any of its query methods.
strPropertyFile
- the property file that contains the connection details.public int getCommerceSettingID()
public void setCommerceSettingID(int nCommerceSettingID)
setCommerceSettingID
followed by a call to get
will return details of the commerce
setting with the specified ID.
nCommerceSettingID
- the commerce setting's ID to be used as key information.public java.lang.String getName()
public void setName(java.lang.String strName)
setName
followed by a call to get
will return details of the commerce setting with
the specified name.
strName
- the commerce setting's name to be used as key information.public java.lang.Object getValue()
public void setValue(java.lang.Object objValue)
objValue
- the commerce setting's value.public java.lang.String getValidateType()
This indicates the type of Object
that is retrieved when calling
setValue
.
public void setValidateType(java.lang.String strValidateType)
This indicates the type of Object
that is retrieved when calling
setValue
.
strValidateType
- the commerce setting's value.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
Use setCommerceSettingID
followed by exist
to ascertain if
there is a commerce setting with the specified ID on the database.
Use setName
followed by exist
to ascertain if there is a commerce setting
with the specified name on the database.
exist
in class CSItem
true
if this commerce setting 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 commerce setting then specify the amount of detail
required using the setDetailLevel
method before calling this method.
Use setCommerceSettingID
followed by get
to populate this
CSCommerceSetting
object with the details of the commerce setting identified by the specified ID.
Use setName
followed by get
to populate this
CSCommerceSetting
object with the details of the commerce setting identified by the specified
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 commerce setting 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
CSCommerceSetting
.
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 the specified commerce setting cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSCommerceSetting
.
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 the specified commerce setting cannot be found on the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.