public final class CSAttributeTypeMultiple extends CSItemMultiple
The CSAttributeTypeMultiple
class provides a method that retrieves several attribute types from the
database. This method requires that certain database and key information (attribute type ID list, for example) be
specified via the set
methods provided, prior to its invocation.
All database access/connectivity is handled internally by the CSAttributeTypeMultiple
class.
CSAttributeType
,
Serialized FormLEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
Constructor and Description |
---|
CSAttributeTypeMultiple()
Creates an empty
CSAttributeTypeMultiple object. |
CSAttributeTypeMultiple(java.lang.String strPropertyFile)
Creates a new
CSAttributeTypeMultiple , specifying a properties file that contains all of the
database connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSAttributeTypeMultiple . |
boolean |
exist()
Not currently implemented for
CSAttributeTypeMultiple . |
void |
get()
Retrieves the details of several attribute types from the database.
|
java.lang.String |
getAttributeTypeIDList()
Gets the list of attribute type IDs specified as key information.
|
java.lang.String |
getAttributeTypeNameList()
Gets the list of attribute type names specified as key information.
|
int |
getProductTypeID()
Gets the product type ID specified as key information.
|
void |
setAttributeTypeIDList(java.lang.String strAttributeTypeIDList)
Specifies the IDs of the attribute types that are to be retrieved.
|
void |
setAttributeTypeNameList(java.lang.String strAttributeTypeNameList)
Specifies the names of the attribute types that are to be retrieved.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setProductTypeID(int nProductTypeID)
Specifies the ID of the product type for which its attribute types are to be retrieved.
|
void |
setSortOrder(java.lang.String strSortOrderList)
Sets the order in which the attribute types are to be retrieved.
|
void |
update()
Not currently implemented for
CSAttributeTypeMultiple . |
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 CSAttributeTypeMultiple()
CSAttributeTypeMultiple
object.
Use the various set
methods provided to initialise the CSAttributeTypeMultiple
object prior to invoking any of its query methods.
public CSAttributeTypeMultiple(java.lang.String strPropertyFile)
CSAttributeTypeMultiple
, specifying a properties file that contains all of the
database connection details.
Use the various set methods provided to initialise the CSAttributeTypeMultiple
object prior to
invoking any of its query methods.
strPropertyFile
- the property file that contains the connection details.public java.lang.String getAttributeTypeIDList()
public void setAttributeTypeIDList(java.lang.String strAttributeTypeIDList)
setAttributeTypeIDList
followed by a call to get
returns details of all the
specified attribute types.
strAttributeTypeIDList
- a comma-separated list of attribute type IDs.public java.lang.String getAttributeTypeNameList()
public void setAttributeTypeNameList(java.lang.String strAttributeTypeNameList)
setAttributeTypeNameList
followed by a call to get
returns details of all the
specified attribute types.
strAttributeTypeNameList
- a comma-separated list of attribute type names.public int getProductTypeID()
public void setProductTypeID(int nProductTypeID)
setProductTypeID
followed by a call to get
returns details of all the attributes
types of the specified product type.
nProductTypeID
- the product type ID.public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method. Default is LEVEL_ALL.
Valid detail levels for an attribute type are :
LEVEL_ID
Retrieves AttributeTypeID only.LEVEL_SUMMARY
Retrieves Name.LEVEL_ALL
Retrieves all attribute data.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
This method should not be used if either the setAttributeTypeIDList
or
the setAttributeTypeNameList
key information is being supplied. 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, "TypeName DESC" would order
in descending order of attribute type name.
If ProductTypeID is specified, the default ordering will be as specified in the product type section for its
associated attribute types, i.e. 'DisplayOrder ASC'
Otherwise, the default ordering will be by the ordering specified for the attribute types within the ATTRIBUTES
section of iCM, i.e. 'DisplayOrder ASC'
Available sort orders are :
TypeID - order by the attribute type ID
TypeName - order by the attribute type name
DisplayOrder - order by the display order of the attribute type, or by the display order of the product type with ProductTypeID key information
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
CSAttributeTypeMultiple
.
exist
in class CSItemMultiple
true
if all attribute types 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 CSAttributeTypeMultiple
object
with the details of all the attribute types from the database.
Use setAttributeTypeIDList
followed by get
to populate
this CSAttributeTypeMultiple
object with the details of the attribute types specified in the list.
The retrieved attribute types will appear within CSAttributeTypeMultiple
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 setAttributeTypeNameList
followed by get
to populate
this CSAttributeTypeMultiple
object with the details of the attribute types specified in the list.
The retrieved attribute types will appear within CSAttributeTypeMultiple
in the order that their
names appear within the supplied list. Key information set using setMaxRows
and
setStartRow
is not valid in this instance.
Use setProductTypeID
followed by get
to populate this
CSAttributeTypeMultiple
object with the details of the related attribute types of the specified
product type.
Each retrieved attribute type is stored as a CSAttributeType
object within the item
ArrayList
member of CSAttributeTypeMultiple
- use getItems
or
iterator
to access/navigate through them. These attribute types will be stored in the
ArrayList
in the order specified using the setSortOrder
method, or
the default order as configured within iCM i.e. by the product type's attribute type ordering if product type ID
is being used, or by the main attribute type ordering otherwise. However, if a list of attribute type IDs or
names was specified, the attribute types 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 attribute types 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
CSAttributeTypeMultiple
.
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 attribute types cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSAttributeTypeMultiple
.
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 attribute types cannot be found on the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.