com.solidstategroup.cms
Class Articles

java.lang.Object
  com.solidstategroup.cms.query.ResultsQuery
      com.solidstategroup.cms.Articles

All Implemented Interfaces:

Query

public class Articles
extends ResultsQuery

Field Summary

static int	BROWSETYPEALL
static int	BROWSETYPEEDIT
static int	BROWSETYPEPREVIEW
static int	BROWSETYPEPUBLISH
static int	BROWSETYPEVERSION
static int	DEFAULTNUMBEROFARTICLES

Fields inherited from class com.solidstategroup.cms.query.ResultsQuery

INVALID_UNIQUE_ID

Constructor Summary

Articles()

Method Summary

void	clear()
boolean	delete(int uniqueId)
void	execute()
Article	getArticle(int thisArticleId)
Article	getArticleFromTitle(java.lang.String articleTitle)
java.util.Vector	getArticles()
int	getArticlesPerPage()
ArticleType	getArticleType()
java.lang.String	getArticleTypeDescription()
int	getArticleTypeId()
int[]	getCollectionElementIds()
int	getCountryId()
java.lang.String	getFirstSearchTerm() Retrieves the first search term in the search string.
static java.util.Vector	getLinkedArticles(int rootArticleId) Returns a collection of articles that are linking to the supplied article thouhg the articleAsset mechanism note - this doesn't call execute on the articles as a performance measure.
static java.util.Vector	getLinkingArticleToImage(int imageId)
int	getLockedById()
int	getNumberOfArticles()
int	getNumberOfArticlesLockedBy(User thisUser) Sums the number of articles in the collection locked by a certain user.
int	getPageNumber()
java.lang.String	getQuery()
Article	getRandomArticle()
java.util.Collection	getResults()
int	getRootArticleId()
int	getRootArticleTypeId()
java.lang.String	getSearchString()
java.lang.String	getSearchStringMySQL()
java.lang.String[]	getSearchTerms() Tokenizes the search string.
int	getSearchType()
int	getSecurityLevelId()
int	getSessionType()
int	getSize()
java.util.Vector	getTags()
WebUserTypeSecurityLevel	getThisUserSecurityLevel()
int	getTotalNumberOfPages()
boolean	isAndTags()
boolean	isHonourPublishDates()
boolean	isRestrictToSSGObjects()
boolean	isRetrieveAllRSSArticles()
Articles	putArticle(Article newArticle) Checks to see if the current Article is not present in the articles Vector.
void	setAndTags(boolean andTags)
void	setArticles(java.util.Vector articles)
void	setArticlesPerPage(int articlesPerPage)
void	setArticleType(ArticleType articleType)
void	setArticleTypeDescription(java.lang.String articleTypeDescription)
void	setArticleTypeId(int articleTypeId)
void	setCollectionElementIds(int[] collectionElementIds)
void	setCountryId(int countryId)
void	setHonourPublishDates(boolean honourPublishDates)
void	setLockedById(int lockedById)
void	setNumberOfArticles(int numberOfArticles)
void	setPageNumber(int pageNumber)
void	setRestrictToSSGObjects(boolean restrictToSSGObjects)
void	setRetrieveAllRSSArticles(boolean retrieveAllRSSArticles)
void	setRootArticleId(int rootArticleId)
void	setRootArticleTypeId(int rootArticleTypeId)
void	setSearchString(java.lang.String searchString)
void	setSearchType(int searchType)
void	setSecurityLevelId(int securityLevelId)
void	setSessionAll()
void	setSessionEditing()
void	setSessionPreviewing()
void	setSessionPublishing()
void	setSessionType(int sessionType)
void	setSessionVersion()
void	setTags(java.util.Vector tags)
void	setThisUserSecurityLevel(WebUserTypeSecurityLevel thisUserSecurityLevel)
boolean	store(java.lang.Object articleObj)
boolean	storeUpdateArticle(Article articleObj)

Methods inherited from class com.solidstategroup.cms.query.ResultsQuery

getSingularResult, getUniqueID, setUniqueID, validUniqueID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BROWSETYPEPUBLISH

public static final int BROWSETYPEPUBLISH

See Also:

Constant Field Values

BROWSETYPEPREVIEW

public static final int BROWSETYPEPREVIEW

See Also:

Constant Field Values

BROWSETYPEEDIT

public static final int BROWSETYPEEDIT

See Also:

Constant Field Values

BROWSETYPEALL

public static final int BROWSETYPEALL

See Also:

Constant Field Values

BROWSETYPEVERSION

public static final int BROWSETYPEVERSION

See Also:

Constant Field Values

DEFAULTNUMBEROFARTICLES

public static final int DEFAULTNUMBEROFARTICLES

See Also:

Constant Field Values

Constructor Detail

Articles

public Articles()

Method Detail

clear

public void clear()

getSize

public int getSize()

getResults

public java.util.Collection getResults()

Specified by:

getResults in class ResultsQuery

putArticle

public Articles putArticle(Article newArticle)

Checks to see if the current Article is not present in the articles Vector. If it is not present, the article is placed into the Vector of articles. The method checks both articleId or rootArticleId.

Parameters:

newArticle - The article to put into the articles vector.

Returns:

The Articles class.

execute

public void execute()

getRandomArticle

public Article getRandomArticle()

getQuery

public java.lang.String getQuery()

getTotalNumberOfPages

public int getTotalNumberOfPages()

storeUpdateArticle

public boolean storeUpdateArticle(Article articleObj)

store

public boolean store(java.lang.Object articleObj)

Specified by:

store in class ResultsQuery

setSessionEditing

public void setSessionEditing()

setSessionPreviewing

public void setSessionPreviewing()

setSessionPublishing

public void setSessionPublishing()

setSessionAll

public void setSessionAll()

setSessionVersion

public void setSessionVersion()

delete

public boolean delete(int uniqueId)

Specified by:

delete in class ResultsQuery

getArticle

public Article getArticle(int thisArticleId)

getArticleFromTitle

public Article getArticleFromTitle(java.lang.String articleTitle)

getArticles

public java.util.Vector getArticles()

setArticles

public void setArticles(java.util.Vector articles)

setArticleType

public void setArticleType(ArticleType articleType)

getArticleType

public ArticleType getArticleType()

setSessionType

public void setSessionType(int sessionType)

getSessionType

public int getSessionType()

setRootArticleTypeId

public void setRootArticleTypeId(int rootArticleTypeId)

setArticleTypeId

public void setArticleTypeId(int articleTypeId)

getArticleTypeId

public int getArticleTypeId()

getRootArticleTypeId

public int getRootArticleTypeId()

setCountryId

public void setCountryId(int countryId)

getCountryId

public int getCountryId()

setArticleTypeDescription

public void setArticleTypeDescription(java.lang.String articleTypeDescription)

getArticleTypeDescription

public java.lang.String getArticleTypeDescription()

getRootArticleId

public int getRootArticleId()

setRootArticleId

public void setRootArticleId(int rootArticleId)

getLockedById

public int getLockedById()

setLockedById

public void setLockedById(int lockedById)

getNumberOfArticlesLockedBy

public int getNumberOfArticlesLockedBy(User thisUser)

Sums the number of articles in the collection locked by a certain user.

Parameters:

thisUser - The user to check against.

Returns:

The number of articles locked by this user.

getSearchString

public java.lang.String getSearchString()

getSearchStringMySQL

public java.lang.String getSearchStringMySQL()

getSearchTerms

public java.lang.String[] getSearchTerms()

Tokenizes the search string. The token delimiter is a single space.

Returns:

A string array of search terms.

getFirstSearchTerm

public java.lang.String getFirstSearchTerm()

Retrieves the first search term in the search string.

Returns:

The first search term, or an empty string if none exist.

getLinkingArticleToImage

public static java.util.Vector getLinkingArticleToImage(int imageId)

getLinkedArticles

public static java.util.Vector getLinkedArticles(int rootArticleId)

Returns a collection of articles that are linking to the supplied article thouhg the articleAsset mechanism note - this doesn't call execute on the articles as a performance measure. If need be you can pull the article back yourself once you know what you want to do with it

setSearchString

public void setSearchString(java.lang.String searchString)

getSearchType

public int getSearchType()

setSearchType

public void setSearchType(int searchType)

getNumberOfArticles

public int getNumberOfArticles()

setNumberOfArticles

public void setNumberOfArticles(int numberOfArticles)

isHonourPublishDates

public boolean isHonourPublishDates()

setHonourPublishDates

public void setHonourPublishDates(boolean honourPublishDates)

isRestrictToSSGObjects

public boolean isRestrictToSSGObjects()

setRestrictToSSGObjects

public void setRestrictToSSGObjects(boolean restrictToSSGObjects)

getCollectionElementIds

public int[] getCollectionElementIds()

setCollectionElementIds

public void setCollectionElementIds(int[] collectionElementIds)

getPageNumber

public int getPageNumber()

setPageNumber

public void setPageNumber(int pageNumber)

getArticlesPerPage

public int getArticlesPerPage()

setArticlesPerPage

public void setArticlesPerPage(int articlesPerPage)

isRetrieveAllRSSArticles

public boolean isRetrieveAllRSSArticles()

setRetrieveAllRSSArticles

public void setRetrieveAllRSSArticles(boolean retrieveAllRSSArticles)

getThisUserSecurityLevel

public WebUserTypeSecurityLevel getThisUserSecurityLevel()

setThisUserSecurityLevel

public void setThisUserSecurityLevel(WebUserTypeSecurityLevel thisUserSecurityLevel)

getSecurityLevelId

public int getSecurityLevelId()

setSecurityLevelId

public void setSecurityLevelId(int securityLevelId)

getTags

public java.util.Vector getTags()

setTags

public void setTags(java.util.Vector tags)

isAndTags

public boolean isAndTags()

setAndTags

public void setAndTags(boolean andTags)