public class CSFeature extends CSArticle
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 CSFeature
class includes methods for the retrieval of a particular feature's details. This method
requires that certain database and key information (feature ID, for example) be specified via the set
methods provided, prior to its invocation.
All database access/connectivity is handled internally by the CSFeature
class.
DEFAULT_BLOCK_KEY, OWNERTYPE_GROUP, OWNERTYPE_USER
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 |
---|
CSFeature()
Creates an empty
CSFeature object. |
CSFeature(java.lang.String strPropertyFile)
Creates an empty
CSFeature 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
CSFeature . |
boolean |
exist()
Not currently implemented for
CSFeature . |
void |
get()
Retrieves the details of a feature from the database.
|
int |
getFeatureID()
Gets the ID of the feature.
|
int |
getGroupID()
Gets the ID of the feature group.
|
java.lang.String |
getGroupName()
Gets the name of the feature group.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setFeatureID(int nFeatureID)
Sets the ID of the feature.
|
void |
setGroupID(int nGroupID)
Sets the ID of the group in which the feature resides.
|
void |
setGroupName(java.lang.String strGroupName)
Sets the name of the group in which the feature resides.
|
void |
update()
Not currently implemented for
CSFeature . |
equals, extractTextBlocks, getArchiveable, getArchiveDate, getArchiveParentID, getArticleDisplay, getArticleHeading, getArticleID, getArticleIntroText, getArticleLevel, getArticleLinkText, getArticlePath, getArticlePathAsDelimList, getArticleSummary, getArticleText, getArticleTextAdditional, getBestLinkText, getBoostedKeywords, getBoostValue, getChildArticleIDs, getCreationDate, getEndDate, getExtensionDataReqd, getFriendlyURL, getGroupList, getLastModifiedByUserID, getLastModifiedDate, getMetaDataOptionalIDs, getObjExtensionData, getOverrideSecurity, getOwnerID, getOwnerType, getParentArticleID, getRelatedArticleIDs, getRelatedEventIDs, getRelatedFeatureIDs, getRelatedFormIDs, getRelatedForumIDs, getRelatedLinkIDs, getRelatedMediaIDs, getRelatedMetaDataIDs, getRelatedPollIDs, getRelatedProductIDs, getRelatedRackIDs, getReviewable, getReviewDate, getReviewInterval, getSecureUserGroupIDs, getStartDate, getSuggestedArticleIDs, getSuggestedRangeName, getTemplateID, getUserID, setArchiveable, setArchiveDate, setArchiveParentID, setArticleDisplay, setArticleHeading, setArticleID, setArticleIntroText, setArticleLevel, setArticleLinkText, setArticlePath, setArticleSummary, setArticleText, setArticleTextAdditional, setBoostedKeywords, setBoostValue, setChildArticleIDs, setCreationDate, setEndDate, setExtensionDataReqd, setFriendlyURL, setGroupList, setLastModifiedByUserID, setLastModifiedDate, setObjExtensionData, setOverrideSecurity, setOwnerID, setOwnerType, setParentArticleID, setReviewable, setReviewDate, setReviewInterval, setStartDate, setSuggestedRangeName, setTemplateID, setUserID, toString
getID, getStatus, hashCode, jsonString, serialiseWithTypes, setID, setStatus, 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 CSFeature()
CSFeature
object.
Use the various set methods provided to initialise the CSFeature
object prior to invoking any of
its query methods.
public CSFeature(java.lang.String strPropertyFile)
CSFeature
object, specifying a property file that contains all of the database
connection details.
Use the various set methods provided to initialise the CSFeature
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 are :
LEVEL_ID - the feature, group and article IDs
LEVEL_SUMMARY - the feature article's heading, intro text and template ID
LEVEL_DETAIL - the feature article's parent ID, creation date, user ID, display toggle, display start date, display end date, archive flag and last modified date
LEVEL_ALL - the feature article's text
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_DETAIL.
setDetailLevel
in class CSArticle
nDetailLevel
- the detail level to be used.CSParameterException
- if an invalid detail level is specified.public void setFeatureID(int nFeatureID)
setFeatureID
followed by a call to get
will populate this CSFeature
object with that feature's details.
nFeatureID
- the numeric identifier of the feature.public int getFeatureID()
public void setGroupID(int nGroupID)
nGroupID
- the numeric identifier of the feature group.public int getGroupID()
public void setGroupName(java.lang.String strGroupName)
strGroupName
- the name of the feature group.public java.lang.String getGroupName()
public boolean exist() throws CSException
CSFeature
.
exist
in class CSArticle
true
if the feature 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 setFeatureID
followed by get
to populate this
CSFeature
object with the details of the feature identified by the specified ID.
get
in class CSArticle
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if the specified feature 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
CSFeature
.
update
in class CSArticle
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if the specified feature cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSFeature
.
delete
in class CSArticle
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if the specified feature cannot be found on the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.