public class CSFeatureGroup extends CSItem
Features are used to highlight particular articles and are contained within a feature group. Typically, the FEATURES section of iCM is used to specify the featured articles and groups. One or more of these features (or feature groups) can be associated with an article within the ARTICLES section of iCM.
The CSFeatureGroup
class includes methods for the retrieval of a particular feature group's details.
This method requires that certain database and key information (feature group ID, for example) be specified via the
set
methods provided, prior to its invocation.
All database access/connectivity is handled internally by the CSFeatureGroup
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 |
---|
CSFeatureGroup()
Creates an empty
CSFeatureGroup object. |
CSFeatureGroup(java.lang.String strPropertyFile)
Creates an empty
CSFeatureGroup object, specifying a property file that contains all of the
database connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSFeatureGroup . |
boolean |
exist()
Not currently implemented for
CSFeatureGroup . |
void |
get()
Retrieves the details of a feature group from the database.
|
int |
getGroupID()
Gets the ID of the feature group.
|
java.lang.String |
getGroupName()
Gets the name of the feature group.
|
int |
getParentGroupID()
Gets the ID of the parent feature group.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setGroupID(int nGroupID)
Sets the ID of the feature group.
|
void |
setGroupName(java.lang.String strGroupName)
Sets the name of the feature group.
|
void |
setParentGroupID(int nParentGroupID)
Sets the ID of the parent feature group.
|
void |
update()
Not currently implemented for
CSFeatureGroup . |
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 CSFeatureGroup()
CSFeatureGroup
object.
Use the various set methods provided to initialise the CSFeatureGroup
object prior to invoking any
of its query methods.
public CSFeatureGroup(java.lang.String strPropertyFile)
CSFeatureGroup
object, specifying a property file that contains all of the
database connection details.
Use the various set methods provided to initialise the CSFeatureGroup
object prior to invoking any
of its query methods.
strPropertyFile
- the name of the property file from which the database connection details are to be read.public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method.
Valid detail levels for a feature group are :
LEVEL_ID - the group ID
LEVEL_ALL - the group name and parent group ID
Each detail level processes the information specified alongside it in addition to the information specified for all detail levels listed above it. The default detail level is LEVEL_ALL.
setDetailLevel
in class CSDatabaseItem
nDetailLevel
- the detail level to be used.CSParameterException
- if an invalid detail level is specified.public void setGroupID(int nGroupID)
setGroupID
followed by a call to get
will populate this CSFeatureGroup
object with that feature group's details.
nGroupID
- the numeric identifier of the feature group.public int getGroupID()
public void setGroupName(java.lang.String strGroupName)
setGroupName
followed by a call to get
will populate this
CSFeatureGroup
object with that feature group's details.
strGroupName
- the name of the feature group.public java.lang.String getGroupName()
public void setParentGroupID(int nParentGroupID)
nParentGroupID
- the numeric identifier of the parent feature group.public int getParentGroupID()
public boolean exist() throws CSException
CSFeatureGroup
.
exist
in class CSItem
true
if the feature group exists 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 setGroupID
followed by get
to populate this
CSFeatureGroup
object with the details of the feature group identified by the specified ID.
Use setGroupName
followed by get
to populate this
CSFeatureGroup
object with the details of the feature group 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 feature group 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
CSFeatureGroup
.
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 feature group cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSFeatureGroup
.
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 feature group cannot be found on the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.