|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.solidstategroup.cms.ArticleType
public class ArticleType
Implements a type of Article. Each ArticleType is a node in the ArticleTypes tree. For further information on how to access and manipulate the tree, please refer to the ArticleTypes class in this package.
| Field Summary | |
|---|---|
static java.lang.String |
ARTICLE
|
static int |
ARTICLEID
|
static java.lang.String |
DOCUMENTREPOSITORY
|
static int |
DOCUMENTREPOSITORYID
|
static java.lang.String |
EMAIL
|
static int |
EMAILID
|
static java.lang.String |
FORUM
|
static int |
FORUMID
|
static java.lang.String |
IMAGEMETADATA
|
static int |
IMAGEMETADATAID
|
static int |
NUMBER_OF_ARTICLES_NONE
|
static int |
NUMBER_OF_ARTICLES_SINGLETON
|
static int |
NUMBER_OF_ARTICLES_UNLIMITED
|
static java.lang.String |
SMS
|
static int |
SMSID
|
| Constructor Summary | |
|---|---|
ArticleType()
|
|
ArticleType(int articleTypeId,
int rootArticleTypeId,
boolean currentVersion,
java.lang.String description,
java.lang.String articleMetaType,
java.lang.String metaDataDescription,
java.lang.String metaDataKeywords,
java.lang.String metaDataAuthor,
java.lang.String metaDataTitle,
boolean includeInNavigation,
boolean hideFromWebDeckUsers,
int priority,
int numberOfArticlesId,
boolean syndicated,
java.lang.String navigationDescription)
|
|
| Method Summary | |
|---|---|
boolean |
addChunkType(com.solidstategroup.cms.ChunkType newChunkType)
|
boolean |
addPermWebUserType(com.solidstategroup.user.WebUserType newObject)
|
boolean |
addSSGObject(com.solidstategroup.ssgobject.SSGObject newObject)
|
boolean |
chunkTypeExists(com.solidstategroup.cms.ChunkType newChunkType)
|
boolean |
chunkTypeExists(int newRootChunkTypeId)
|
void |
clear()
Clears all data from object. |
int |
compareTo(java.lang.Object o)
Compares two articleTypes. |
ArticleType |
copy()
|
boolean |
delete()
Removes the current ArticleType. |
ArticleType |
execute()
|
java.util.Vector |
getAllArticles()
Helper method |
java.util.Vector |
getAllChildren()
Retrieves the children of this articleType as a Vector. |
com.solidstategroup.cms.ChunkTypes |
getAllowedChunkTypes()
|
java.lang.String |
getArticleMetaType()
|
int |
getArticleMetaTypeId(java.lang.String articleMetaType)
|
int |
getArticleTypeId()
|
ArticleType |
getChildArticleType(java.lang.String description)
|
com.solidstategroup.cms.ArticleTemplate |
getDefaultArticleTemplate()
|
java.lang.String |
getDefaultArticleTemplateLocation()
|
com.solidstategroup.cms.ChunkType |
getDefaultChunkType()
|
int |
getDepth()
Calculates the number of descendents this artilcleType has. |
java.lang.String |
getDescription()
Returns the simple description of the ArticleType. |
java.lang.String |
getFullyQualifiedDescription()
Returns the fully qualified description of the current ArticleType. |
java.lang.String |
getHeaderImage()
Rewrites the ArticleType description of the Parent ArticleType to allow it to be easily referenced as an image. |
java.lang.String |
getMetaDataAuthor()
|
java.lang.String |
getMetaDataDescription()
|
java.lang.String |
getMetaDataKeywords()
|
java.lang.String |
getMetaDataTitle()
|
java.lang.String |
getNavigationDescription()
|
java.lang.String |
getNavigationDescriptionActual()
|
int |
getNumberOfArticlesId()
|
int |
getNumberOfArticlesThatExist(int browseType)
|
int |
getNumberOfLiveArticlesThatExist()
|
ArticleType |
getParentArticleType()
Retrieves the parent of this articleType. |
ArticleType |
getParentArticleTypeWithLevel(int level)
Retrieves the parent of this articleType. |
java.util.Vector |
getPermissableWebUserTypes()
|
java.util.Collection |
getPermittedWebUsers()
returns all the users that are in groups limited to this articleType |
int |
getPriority()
|
int |
getRootArticleTypeId()
|
com.solidstategroup.user.WebUserTypeSecurityLevel |
getSecurityLevel()
|
int |
getSecurityLevelId()
|
java.util.Vector |
getSsgObjects()
|
com.solidstategroup.ssgobject.SSGObjects |
getSsgObjectsObject()
|
java.lang.String |
getSubHeaderImage()
Rewrites the ArticleType description of the current ArticleType to allow it to be easily referenced as an image. |
java.lang.String |
getVanityURL(int startingLevel)
Returns the vanity URL of the current ArticleType. |
java.lang.String |
getVanityURLFromBottom(int heightToTraverse)
Returns the vanity URL of the current ArticleType. |
boolean |
grantPrivilege(int cmsUserId,
boolean includesChildren)
Applies access priveledges to this ArticleType, and all descendents of the ArticleType to the CMSUser provided. |
boolean |
isCurrentVersion()
|
boolean |
isHideFromWebDeckUsers()
|
boolean |
isIncludeInNavigation()
|
boolean |
isInheritArticleFunction()
|
boolean |
isInheritAssociatedGroups()
|
boolean |
isInheritAssociatedSections()
|
boolean |
isInheritDefaultFirstSection()
|
boolean |
isInheritDefaultTemplate()
|
boolean |
isInheritHideFromWebDeckUsers()
|
boolean |
isInheritIncludeInNavigation()
|
boolean |
isInheritLockTemplate()
|
boolean |
isInheritMaximumNumberOfArticles()
|
boolean |
isInheritMetaTagAuthor()
|
boolean |
isInheritMetaTagDescription()
|
boolean |
isInheritMetaTagKeywords()
|
boolean |
isInheritMetaTagTitle()
|
boolean |
isInheritPermissableWebUserTypes()
|
boolean |
isInheritRSSSyndicated()
|
boolean |
isInheritSecurityLevelId()
|
boolean |
isLeafNode()
|
boolean |
isLockTemplate()
|
boolean |
isNavigationChildren()
Determines whether or not this node has child nodes to display |
boolean |
isPreviewVersion()
|
boolean |
isSyndicated()
|
boolean |
permWebUserTypeExists(com.solidstategroup.user.WebUserType newObject)
|
boolean |
revokePrivilege(int cmsUserId)
Removes access priveledges to this ArticleType, and all descendents of the ArticleType to the CMSUser provided. |
void |
setAllowedChunkTypes(com.solidstategroup.cms.ChunkTypes allowedChunkTypes)
|
void |
setArticleMetaType(java.lang.String articleMetaType)
|
void |
setArticleTemplateId(int articleTemplateId)
|
void |
setArticleTypeId(int articleTypeId)
|
void |
setCurrentVersion(boolean currentVersion)
|
void |
setDefaultArticleTemplate(com.solidstategroup.cms.ArticleTemplate defaultArticleTemplate)
|
void |
setDefaultChunkType(com.solidstategroup.cms.ChunkType defaultChunkType)
|
void |
setDefaultChunkTypeId(int chunkTypeId)
|
void |
setDefaultRootChunkTypeId(int rootChunkTypeId)
|
void |
setDescription(java.lang.String description)
Sets the description of the ArticleType. |
void |
setDescriptionOnly(java.lang.String description)
|
void |
setDescriptionOnlyWithoutSanitisation(java.lang.String description)
|
boolean |
setFullyQualifiedDescription(java.lang.String description)
Sets the fully qualified description of the ArticleType. |
void |
setHideFromWebDeckUsers(boolean hideFromWebDeckUsers)
|
void |
setIncludeInNavigation(boolean includeInNavigation)
|
void |
setInheritArticleFunction(boolean inheritArticleFunction)
|
void |
setInheritAssociatedGroups(boolean inheritAssociatedGroups)
|
void |
setInheritAssociatedSections(boolean inheritAssociatedSections)
|
void |
setInheritDefaultFirstSection(boolean inheritDefaultFirstSection)
|
void |
setInheritDefaultTemplate(boolean inheritDefaultTemplate)
|
void |
setInheritHideFromWebDeckUsers(boolean inheritHideFromWebDeckUsers)
|
void |
setInheritIncludeInNavigation(boolean inheritIncludeInNavigation)
|
void |
setInheritLockTemplate(boolean inheritLockTemplate)
|
void |
setInheritMaximumNumberOfArticles(boolean inheritMaximumNumberOfArticles)
|
void |
setInheritMetaTagAuthor(boolean inheritMetaTagAuthor)
|
void |
setInheritMetaTagDescription(boolean inheritMetaTagDescription)
|
void |
setInheritMetaTagKeywords(boolean inheritMetaTagKeywords)
|
void |
setInheritMetaTagTitle(boolean inheritMetaTagTitle)
|
void |
setInheritPermissableWebUserTypes(boolean inheritPermissableWebUserTypes)
|
void |
setInheritRSSSyndicated(boolean inheritRSSSyndicated)
|
void |
setInheritSecurityLevelId(boolean inheritSecurityLevelId)
|
void |
setLockTemplate(boolean lockTemplate)
|
void |
setMetaDataAuthor(java.lang.String metaDataAuthor)
|
void |
setMetaDataDescription(java.lang.String metaDataDescription)
|
void |
setMetaDataKeywords(java.lang.String metaDataKeywords)
|
void |
setMetaDataTitle(java.lang.String metaDataTitle)
|
void |
setNavigationDescription(java.lang.String navigationDescription)
|
void |
setNumberOfArticlesId(int numberOfArticlesID)
|
void |
setPermissableWebUserTypes(java.util.Vector permissableWebUserTypes)
|
void |
setPreviewVersion(boolean previewVersion)
|
void |
setPriority(int priority)
|
void |
setRootArticleTypeId(int rootArticleTypeId)
|
void |
setSecurityLevel(com.solidstategroup.user.WebUserTypeSecurityLevel securityLevel)
|
void |
setSecurityLevelId(int securityLevelId)
|
void |
setSsgObjects(java.util.Vector ssgObjects)
|
void |
setSsgObjectsObject(com.solidstategroup.ssgobject.SSGObjects newObjects)
|
void |
setSyndicated(boolean syndicated)
|
boolean |
ssgObjectExists(com.solidstategroup.ssgobject.SSGObject newObject)
|
boolean |
store(int parentRootArticleTypeId)
Stores the current ArticleType in the database. |
boolean |
webUserAuthorised(com.solidstategroup.user.WebUser webUser)
|
boolean |
webUserTypeAuthorised(com.solidstategroup.user.WebUserTypes webUserTypes)
are any of these WebUserTypes authorised to view this ArticleType |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String ARTICLE
public static final java.lang.String EMAIL
public static final java.lang.String SMS
public static final java.lang.String FORUM
public static final java.lang.String IMAGEMETADATA
public static final java.lang.String DOCUMENTREPOSITORY
public static final int ARTICLEID
public static final int EMAILID
public static final int SMSID
public static final int FORUMID
public static final int IMAGEMETADATAID
public static final int DOCUMENTREPOSITORYID
public static final int NUMBER_OF_ARTICLES_UNLIMITED
public static final int NUMBER_OF_ARTICLES_SINGLETON
public static final int NUMBER_OF_ARTICLES_NONE
| Constructor Detail |
|---|
public ArticleType()
public ArticleType(int articleTypeId,
int rootArticleTypeId,
boolean currentVersion,
java.lang.String description,
java.lang.String articleMetaType,
java.lang.String metaDataDescription,
java.lang.String metaDataKeywords,
java.lang.String metaDataAuthor,
java.lang.String metaDataTitle,
boolean includeInNavigation,
boolean hideFromWebDeckUsers,
int priority,
int numberOfArticlesId,
boolean syndicated,
java.lang.String navigationDescription)
| Method Detail |
|---|
public void clear()
public java.util.Vector getAllArticles()
public ArticleType getParentArticleType()
public ArticleType getParentArticleTypeWithLevel(int level)
public java.util.Vector getAllChildren()
public boolean isNavigationChildren()
public int getDepth()
public int compareTo(java.lang.Object o)
compareTo in interface java.lang.Comparableo - The ArticleType to compare.
public ArticleType execute()
public ArticleType copy()
public boolean grantPrivilege(int cmsUserId,
boolean includesChildren)
cmsUserId - The CMSUserId to grant priveleges to.
public boolean revokePrivilege(int cmsUserId)
cmsUserId - The CMSUserId to revoke priveleges from.
public boolean store(int parentRootArticleTypeId)
parentRootArticleTypeId - The Parent ArticleType
public int getNumberOfLiveArticlesThatExist()
public int getNumberOfArticlesThatExist(int browseType)
public boolean delete()
public java.lang.String getHeaderImage()
public java.lang.String getSubHeaderImage()
public java.lang.String getFullyQualifiedDescription()
public java.lang.String getVanityURL(int startingLevel)
public java.lang.String getVanityURLFromBottom(int heightToTraverse)
public java.lang.String getDescription()
public boolean setFullyQualifiedDescription(java.lang.String description)
description - The fully qualified description of the ArticleType.
public void setDescription(java.lang.String description)
description - The description to set.public void setDescriptionOnly(java.lang.String description)
public void setDescriptionOnlyWithoutSanitisation(java.lang.String description)
public void setArticleTypeId(int articleTypeId)
public int getArticleTypeId()
public void setArticleMetaType(java.lang.String articleMetaType)
public java.lang.String getArticleMetaType()
public com.solidstategroup.cms.ChunkType getDefaultChunkType()
public void setDefaultChunkType(com.solidstategroup.cms.ChunkType defaultChunkType)
public void setDefaultChunkTypeId(int chunkTypeId)
public void setDefaultRootChunkTypeId(int rootChunkTypeId)
public java.lang.String getMetaDataDescription()
public void setMetaDataDescription(java.lang.String metaDataDescription)
public java.lang.String getMetaDataKeywords()
public void setMetaDataKeywords(java.lang.String metaDataKeywords)
public java.lang.String getMetaDataAuthor()
public void setMetaDataAuthor(java.lang.String metaDataAuthor)
public boolean isIncludeInNavigation()
public void setIncludeInNavigation(boolean includeInNavigation)
public com.solidstategroup.cms.ArticleTemplate getDefaultArticleTemplate()
public java.lang.String getDefaultArticleTemplateLocation()
public void setDefaultArticleTemplate(com.solidstategroup.cms.ArticleTemplate defaultArticleTemplate)
public void setArticleTemplateId(int articleTemplateId)
public int getPriority()
public void setPriority(int priority)
public java.util.Vector getSsgObjects()
public com.solidstategroup.ssgobject.SSGObjects getSsgObjectsObject()
public void setSsgObjects(java.util.Vector ssgObjects)
public void setSsgObjectsObject(com.solidstategroup.ssgobject.SSGObjects newObjects)
public boolean addSSGObject(com.solidstategroup.ssgobject.SSGObject newObject)
public boolean ssgObjectExists(com.solidstategroup.ssgobject.SSGObject newObject)
public boolean addPermWebUserType(com.solidstategroup.user.WebUserType newObject)
public boolean permWebUserTypeExists(com.solidstategroup.user.WebUserType newObject)
public int getArticleMetaTypeId(java.lang.String articleMetaType)
public boolean isLeafNode()
public boolean isHideFromWebDeckUsers()
public void setHideFromWebDeckUsers(boolean hideFromWebDeckUsers)
public int getNumberOfArticlesId()
public void setNumberOfArticlesId(int numberOfArticlesID)
public com.solidstategroup.cms.ChunkTypes getAllowedChunkTypes()
public void setAllowedChunkTypes(com.solidstategroup.cms.ChunkTypes allowedChunkTypes)
public boolean addChunkType(com.solidstategroup.cms.ChunkType newChunkType)
public boolean chunkTypeExists(com.solidstategroup.cms.ChunkType newChunkType)
public boolean chunkTypeExists(int newRootChunkTypeId)
public boolean isSyndicated()
public void setSyndicated(boolean syndicated)
public int getRootArticleTypeId()
public void setRootArticleTypeId(int rootArticleTypeId)
public boolean isCurrentVersion()
public void setCurrentVersion(boolean currentVersion)
public boolean isPreviewVersion()
public void setPreviewVersion(boolean previewVersion)
public boolean isLockTemplate()
public void setLockTemplate(boolean lockTemplate)
public boolean isInheritArticleFunction()
public void setInheritArticleFunction(boolean inheritArticleFunction)
public boolean isInheritDefaultTemplate()
public void setInheritDefaultTemplate(boolean inheritDefaultTemplate)
public boolean isInheritDefaultFirstSection()
public void setInheritDefaultFirstSection(boolean inheritDefaultFirstSection)
public boolean isInheritMaximumNumberOfArticles()
public void setInheritMaximumNumberOfArticles(boolean inheritMaximumNumberOfArticles)
public boolean isInheritIncludeInNavigation()
public void setInheritIncludeInNavigation(boolean inheritIncludeInNavigation)
public boolean isInheritHideFromWebDeckUsers()
public void setInheritHideFromWebDeckUsers(boolean inheritHideFromWebDeckUsers)
public boolean isInheritRSSSyndicated()
public void setInheritRSSSyndicated(boolean inheritRSSSyndicated)
public boolean isInheritMetaTagDescription()
public void setInheritMetaTagDescription(boolean inheritMetaTagDescription)
public boolean isInheritMetaTagKeywords()
public void setInheritMetaTagKeywords(boolean inheritMetaTagKeywords)
public boolean isInheritMetaTagAuthor()
public void setInheritMetaTagAuthor(boolean inheritMetaTagAuthor)
public boolean isInheritAssociatedSections()
public void setInheritAssociatedSections(boolean inheritAssociatedSections)
public boolean isInheritAssociatedGroups()
public void setInheritAssociatedGroups(boolean inheritAssociatedGroups)
public boolean isInheritLockTemplate()
public void setInheritLockTemplate(boolean inheritLockTemplate)
public boolean isInheritSecurityLevelId()
public void setInheritSecurityLevelId(boolean inheritSecurityLevelId)
public com.solidstategroup.user.WebUserTypeSecurityLevel getSecurityLevel()
public void setSecurityLevel(com.solidstategroup.user.WebUserTypeSecurityLevel securityLevel)
public int getSecurityLevelId()
public void setSecurityLevelId(int securityLevelId)
public java.util.Vector getPermissableWebUserTypes()
public void setPermissableWebUserTypes(java.util.Vector permissableWebUserTypes)
public boolean isInheritPermissableWebUserTypes()
public void setInheritPermissableWebUserTypes(boolean inheritPermissableWebUserTypes)
public boolean webUserAuthorised(com.solidstategroup.user.WebUser webUser)
public boolean webUserTypeAuthorised(com.solidstategroup.user.WebUserTypes webUserTypes)
webUserTypes - public java.util.Collection getPermittedWebUsers()
public java.lang.String getMetaDataTitle()
public void setMetaDataTitle(java.lang.String metaDataTitle)
public boolean isInheritMetaTagTitle()
public void setInheritMetaTagTitle(boolean inheritMetaTagTitle)
public java.lang.String getNavigationDescription()
public java.lang.String getNavigationDescriptionActual()
public void setNavigationDescription(java.lang.String navigationDescription)
public ArticleType getChildArticleType(java.lang.String description)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||