public final class CSRackItem extends CSItem
The CSRackItem
class includes methods for the retrieval of a particular rack item's details.
All such methods require that certain database and key information (rack item ID, for example) be specified via the
set
methods provided, prior to their invocation.
All database access/connectivity is handled internally by the CSRackItem
class.
CSRackItemContent
,
CSRackItemMultiple
,
CSState
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
ITEM_TYPE_GROUP
A valid value that is used to indicate the type of item the
ItemID links to. |
static java.lang.String |
ITEM_TYPE_RACK
A valid value that is used to indicate the type of item the
ItemID links to. |
static java.lang.String |
ITEM_TYPE_TYPE
A valid value that is used to indicate the type of item the
ItemID links to. |
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 |
---|
CSRackItem()
Creates an empty
CSRackItem object. |
CSRackItem(CSRackItem objItem)
Creates an empty
CSRackItem object, and initialises it from the contents of the supplied CSItem
object. |
CSRackItem(java.lang.String strPropertyFile)
Creates a new
CSRackItem , specifying a property file that contains all of the database connection
details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSRackItem . |
boolean |
exist()
Determines whether a rack item exists on the database.
|
void |
get()
Retrieves the details of a rack item from the database.
|
java.lang.Integer |
getDecimalPlaces()
Gets the decimal places setting to be applied to the product type's price.
|
int |
getDisplayOrder()
Gets the display order of the rack item.
|
int |
getItemID()
Gets the item ID of the rack item.
|
java.lang.String |
getItemType()
Gets the item type of the rack item.
|
CSProductGroup |
getProductGroup()
Gets the
CSProductGroup object that the ItemID of this rack item refers to. |
CSProductType |
getProductType()
Gets the
CSProductType object that the ItemID of this rack item refers to. |
CSRack |
getRack()
Gets the
CSRack object that the ItemID of this rack item refers to. |
int |
getRackID()
Gets the parent rack ID of the rack item.
|
int |
getRackItemID()
Gets the ID of the rack item to be used as key information.
|
void |
setDecimalPlaces(java.lang.Integer nDecimalPlaces)
Sets the decimal places setting to be applied to the product type's price.
|
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 rack item.
|
void |
setItemID(int nItemID)
Sets the item ID of the rack item.
|
void |
setItemType(java.lang.String strItemType)
Sets the item type of the rack item.
|
void |
setProductGroup(CSProductGroup objProductGroup)
Sets the
CSProductGroup object that the ItemID of this rack item refers to. |
void |
setProductType(CSProductType objProductType)
Sets the
CSProductType object that the ItemID of this rack item refers to. |
void |
setRack(CSRack objRack)
Sets the
CSRack object that the ItemID of this rack item refers to. |
void |
setRackID(int nRackID)
Sets the parent rack ID of the rack item.
|
void |
setRackItemID(int nRackItemID)
Sets the rack item ID to be used as key information.
|
void |
update()
Not currently implemented for
CSRackItem . |
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 static final java.lang.String ITEM_TYPE_RACK
ItemID
links to.
ITEM_TYPE_RACK
indicates that the ID retrieved when calling getItemId
will be
for a CSRack
object.public static final java.lang.String ITEM_TYPE_GROUP
ItemID
links to.
ITEM_TYPE_GROUP
indicates that the ID retrieved when calling getItemId
will
be for a CSProductGroup
object.public static final java.lang.String ITEM_TYPE_TYPE
ItemID
links to.
ITEM_TYPE_TYPE
indicates that the ID retrieved when calling getItemId
will be
for a CSProductType
object.public CSRackItem()
CSRackItem
object.
Use the various set methods provided to initialise the CSRackItem
object prior to invoking any of
its query methods.
public CSRackItem(CSRackItem objItem)
CSRackItem
object, and initialises it from the contents of the supplied CSItem
object.
objItem
- the CSRackItem
object to be used to initialise the new onepublic CSRackItem(java.lang.String strPropertyFile)
CSRackItem
, specifying a property file that contains all of the database connection
details.
Use the various set methods provided to initialise the CSRackItem
object prior to invoking any of
its query methods.
strPropertyFile
- the property file that contains the connection details.public int getRackItemID()
public void setRackItemID(int nRackItemID)
setRackItemID
followed by a call to get
will return details of the rack item with
the specified ID.
nRackItemID
- the rack item's ID to be used as key information.public java.lang.Integer getDecimalPlaces()
If set to null then the decimal places as defined in the iCM Commerce Settings will be used.
public void setDecimalPlaces(java.lang.Integer nDecimalPlaces)
If set to null then the decimal places as defined in the iCM Commerce Settings will be used.
nDecimalPlaces
- the decimal places setting.public int getRackID()
public void setRackID(int nRackID)
nRackID
- the rack item's parent rack ID.public int getItemID()
When ItemType
is set to ITEM_TYPE_RACK
then this rack item is a rack and
ItemID
is its rack ID.
When ItemType
is set to ITEM_TYPE_GROUP
then this rack item is a product group and
ItemID
is its product group ID.
When ItemType
is set to ITEM_TYPE_TYPE
then this rack item is a product type and
ItemID
is its product type ID.
public void setItemID(int nItemID)
When ItemType
is set to ITEM_TYPE_RACK
then this rack item is a rack and
ItemID
is its rack ID.
When ItemType
is set to ITEM_TYPE_GROUP
then this rack item is a product group and
ItemID
is its product group ID.
When ItemType
is set to ITEM_TYPE_TYPE
then this rack item is a product type and
ItemID
is its product type ID.
nItemID
- the rack item's item ID.public java.lang.String getItemType()
public void setItemType(java.lang.String strItemType) throws CSParameterException
The valid item types are as follows :
Rack
Group
Type
strItemType
- the rack item's item type.CSParameterException
- if an invalid item type is specified.public int getDisplayOrder()
public void setDisplayOrder(int nDisplayOrder)
nDisplayOrder
- the rack item's display order.public CSRack getRack()
CSRack
object that the ItemID
of this rack item refers to.
CSRack
object that this rack item refers to when ItemType
is set to ITEM_TYPE_RACK
, or null when ItemType
is NOT set to ITEM_TYPE_RACK
.public void setRack(CSRack objRack)
CSRack
object that the ItemID
of this rack item refers to.
objRack
- the CSRack
object that this rack item refers to.public CSProductGroup getProductGroup()
CSProductGroup
object that the ItemID
of this rack item refers to.
CSProductGroup
object that this rack item refers to when ItemType
is set to
ITEM_TYPE_GROUP
, or null when ItemType
is NOT set to
ITEM_TYPE_GROUP
.public void setProductGroup(CSProductGroup objProductGroup)
CSProductGroup
object that the ItemID
of this rack item refers to.
objProductGroup
- the CSProductGroup
object that this rack item refers to.public CSProductType getProductType()
CSProductType
object that the ItemID
of this rack item refers to.
CSProductType
object that this rack item refers to when ItemType
is set to
ITEM_TYPE_TYPE
, or null when ItemType
is NOT set to ITEM_TYPE_TYPE
.public void setProductType(CSProductType objProductType)
CSProductType
object that the ItemID
of this rack item refers to.
objProductType
- the CSProductType
object that this rack item refers to.public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method. Default is LEVEL_ALL.
Valid detail levels for a rack item are :
LEVEL_ID
Retrieves the RackItemID.LEVEL_SUMMARY
Retrieves the RackItemID, RackID, ItemID, ItemType and the associated Rack,
ProductGroup or ProductType populated with LEVEL_SUMMARY detail.LEVEL_DETAIL
Retrieves all rack data and the associated Rack, ProductGroup or ProductType
populated with LEVEL_DETAIL detail.LEVEL_ALL
Retrieves all rack data and the associated Rack, ProductGroup or ProductType
populated with LEVEL_ALL detail.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 setRackItemID
followed by exist
to ascertain if there is a rack
item with the specified ID on the database.
exist
in class CSItem
true
if this rack 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 rack item then specify the amount of detail required
using the setDetailLevel
method before calling this method.
Use setRackItemID
followed by get
to populate this
CSRackItem
object with the details of the rack item identified by the specified ID.
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 rack 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
CSRackItem
.
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 rack items cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSRackItem
.
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 rack 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.