com.solidstategroup.cms
Class DocumentAssets

java.lang.Object
  com.solidstategroup.cms.Assets
      com.solidstategroup.cms.DocumentAssets

public class DocumentAssets
extends Assets

Field Summary

static int

DEFAULTNUMBEROFDOCUMENTS

Fields inherited from class com.solidstategroup.cms.Assets

andTags

Constructor Summary

DocumentAssets()

Method Summary

protected void	clear()
void	execute()
ArticleType	getArticleType()
static java.lang.String	getDocumentBaseDirectory()
int	getDocumentsPerPage()
java.lang.String	getFirstSearchTerm() Retrieves the first search term in the search string.
int	getLiveSiteMajorVersion()
int	getLiveSiteMinorVersion()
int	getNumberOfDocuments()
int	getPageNumber()
java.lang.String	getQuery()
int	getRootArticleTypeId()
int	getRootDocumentAssetId()
java.lang.String	getSearchString()
java.lang.String	getSearchStringMySQL()
java.lang.String[]	getSearchTerms() Tokenizes the search string.
int	getSearchType()
WebUserTypeSecurityLevel	getSecurityLevel()
int	getSecurityLevelId()
int	getSessionTypeId()
int	getTotalNumberOfPages()
boolean	isIncludeDescendents()
boolean	isOrderByDate()
boolean	isOrderByNumberOfDownloads()
boolean	isRestrictToSSGObjects()
void	setArticleType(ArticleType articleType)
void	setArticleType(java.lang.String articleType)
void	setArticleTypeId(int articleTypeId)
static void	setDocumentBaseDirectory(java.lang.String documentBaseDirectory)
void	setDocumentsPerPage(int documentsPerPage)
void	setIncludeDescendents(boolean includeDescendents)
void	setLiveSiteMajorVersion(int liveSiteMajorVersion)
void	setLiveSiteMinorVersion(int liveSiteMinorVersion)
void	setNumberOfDocuments(int numberOfDocuments)
void	setOrderByDate(boolean orderByDate)
void	setOrderByNumberOfDownloads(boolean orderByNumberOfDownloads)
void	setPageNumber(int pageNumber)
void	setRestrictToSSGObjects(boolean restrictToSSGObjects)
void	setRootArticleTypeId(int rootArticleTypeId)
void	setRootDocumentAssetId(int rootDocumentAssetId)
void	setSearchString(java.lang.String searchString)
void	setSearchType(int searchType)
void	setSecurityLevel(WebUserTypeSecurityLevel securityLevel)
void	setSecurityLevelId(int securityLevelId)
void	setSessionTypeId(int sessionTypeId)
void	setTotalNumberOfPages(int totalNumberOfPages)

Methods inherited from class com.solidstategroup.cms.Assets

addAsset, delete, execute, getAsset, getAsset, getAsset, getAssetData, getAssets, getChunkId, getQuery, getRootChunkTypeId, getTags, isAndTags, setAndTags, setAssets, setChunkId, setRootChunkTypeId, setTags, store, store

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULTNUMBEROFDOCUMENTS

public static final int DEFAULTNUMBEROFDOCUMENTS

See Also:

Constant Field Values

Constructor Detail

DocumentAssets

public DocumentAssets()

Method Detail

clear

protected void clear()

Overrides:

clear in class Assets

getQuery

public java.lang.String getQuery()

execute

public void execute()

Overrides:

execute in class Assets

setRootArticleTypeId

public void setRootArticleTypeId(int rootArticleTypeId)

getRootArticleTypeId

public int getRootArticleTypeId()

getArticleType

public ArticleType getArticleType()

setArticleType

public void setArticleType(ArticleType articleType)

setArticleType

public void setArticleType(java.lang.String articleType)

setArticleTypeId

public void setArticleTypeId(int articleTypeId)

getDocumentBaseDirectory

public static java.lang.String getDocumentBaseDirectory()

setDocumentBaseDirectory

public static void setDocumentBaseDirectory(java.lang.String documentBaseDirectory)

isRestrictToSSGObjects

public boolean isRestrictToSSGObjects()

setRestrictToSSGObjects

public void setRestrictToSSGObjects(boolean restrictToSSGObjects)

isOrderByNumberOfDownloads

public boolean isOrderByNumberOfDownloads()

setOrderByNumberOfDownloads

public void setOrderByNumberOfDownloads(boolean orderByNumberOfDownloads)

getDocumentsPerPage

public int getDocumentsPerPage()

setDocumentsPerPage

public void setDocumentsPerPage(int documentsPerPage)

getPageNumber

public int getPageNumber()

setPageNumber

public void setPageNumber(int pageNumber)

getTotalNumberOfPages

public int getTotalNumberOfPages()

setTotalNumberOfPages

public void setTotalNumberOfPages(int totalNumberOfPages)

getNumberOfDocuments

public int getNumberOfDocuments()

setNumberOfDocuments

public void setNumberOfDocuments(int numberOfDocuments)

getLiveSiteMajorVersion

public int getLiveSiteMajorVersion()

setLiveSiteMajorVersion

public void setLiveSiteMajorVersion(int liveSiteMajorVersion)

getLiveSiteMinorVersion

public int getLiveSiteMinorVersion()

setLiveSiteMinorVersion

public void setLiveSiteMinorVersion(int liveSiteMinorVersion)

getRootDocumentAssetId

public int getRootDocumentAssetId()

setRootDocumentAssetId

public void setRootDocumentAssetId(int rootDocumentAssetId)

isIncludeDescendents

public boolean isIncludeDescendents()

setIncludeDescendents

public void setIncludeDescendents(boolean includeDescendents)

getSessionTypeId

public int getSessionTypeId()

setSessionTypeId

public void setSessionTypeId(int sessionTypeId)

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.

setSearchString

public void setSearchString(java.lang.String searchString)

getSearchType

public int getSearchType()

setSearchType

public void setSearchType(int searchType)

getSecurityLevel

public WebUserTypeSecurityLevel getSecurityLevel()

setSecurityLevel

public void setSecurityLevel(WebUserTypeSecurityLevel securityLevel)

getSecurityLevelId

public int getSecurityLevelId()

setSecurityLevelId

public void setSecurityLevelId(int securityLevelId)

isOrderByDate

public boolean isOrderByDate()

setOrderByDate

public void setOrderByDate(boolean orderByDate)