public final class CSOrderAddressMultiple extends CSItemMultiple
The CSOrderAddressMultiple
class provides a method that retrieves several order addresses from the
database. This method requires that certain database and key information (order ID, for example) be specified via the
set
methods provided, prior to its invocation.
All database access/connectivity is handled internally by the CSOrderAddressMultiple
class.
CSOrderAddress
,
Serialized FormLEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
Constructor and Description |
---|
CSOrderAddressMultiple()
Creates an empty
CSOrderAddressMultiple object. |
CSOrderAddressMultiple(java.lang.String strPropertyFile)
Creates a new
CSOrderAddressMultiple , specifying a properties file that contains all of the
database connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Removes several order addresses from the database.
|
boolean |
exist()
Not currently implemented for
CSOrderAddressMultiple . |
void |
get()
Retrieves the details of several order addresses from the database.
|
java.lang.String |
getOrderAddressIDList()
Gets the list of order address IDs specified as key information.
|
int |
getOrderID()
Gets the order ID specified as key information.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setOrderAddressIDList(java.lang.String strOrderAddressIDList)
Specifies the IDs of the order addresses that are to be retrieved.
|
void |
setOrderID(int nOrderID)
Specifies the ID of the order for which its order addresses are to be retrieved.
|
void |
update()
Updates the details of several order addresses on the database.
|
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 CSOrderAddressMultiple()
CSOrderAddressMultiple
object.
Use the various set
methods provided to initialise the CSOrderAddressMultiple
object prior to invoking any of its query methods.
public CSOrderAddressMultiple(java.lang.String strPropertyFile)
CSOrderAddressMultiple
, specifying a properties file that contains all of the
database connection details.
Use the various set methods provided to initialise the CSOrderAddressMultiple
object prior to
invoking any of its query methods.
strPropertyFile
- the property file that contains the connection details.public java.lang.String getOrderAddressIDList()
public void setOrderAddressIDList(java.lang.String strOrderAddressIDList)
setOrderAddressIDList
followed by a call to get
returns details of all the
specified order addresses.
strOrderAddressIDList
- a comma-separated list of order address IDs.public int getOrderID()
public void setOrderID(int nOrderID)
setOrderID
followed by a call to get
returns details of all the order addresses of
the specified order.
nOrderID
- the order ID.public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method. Default is LEVEL_ALL.
Valid detail levels for an order address are :
LEVEL_ALL
Retrieves all order address data.setDetailLevel
in class CSDatabaseItem
nDetailLevel
- the detail level to be used.CSParameterException
- if an invalid detail level is specified.public boolean exist() throws CSException
CSOrderAddressMultiple
.
exist
in class CSItemMultiple
true
if all order addresses 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 setOrderAddressIDList
followed by get
to populate this
CSOrderAddressMultiple
object with the details of the order addresses specified in the list. The
retrieved order addresses will appear within CSOrderAddressMultiple
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 setOrderID
followed by get
to populate this
CSOrderAddressMultiple
object with the details of the order addresses of the specified order.
Each retrieved order address is stored as a CSOrderAddress
object within the item ArrayList
member of CSOrderAddressMultiple
- use getItems
or
iterator
to access/navigate through them. These order addresses will be stored in the
ArrayList
in the default order of order ID ascending and then order address ID ascending. However,
if a list of order address IDs was specified, the order addresses are stored 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 order addresses 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
Use setItems
followed by update
to save the supplied order addresses
to the database.
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 order addresses cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
Use setOrderAddressIDList
followed by delete
to remove all
order addresses whose IDs are listed, from the database.
Use setOrderID
followed by delete
to remove all order addresses for the
specified order, from the database.
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 order addresses cannot be found on the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.