public interface PresentationSection extends PresentationPool
Modifier and Type | Method and Description |
---|---|
PresentationPool |
getActivePool()
Retrieves the active pool from this section
|
int |
getAgreementId()
Retrieves the id of this sections agreement.
|
AgreementInfo |
getAgreementInfo()
Retrieves this sections agreement.
|
boolean |
getApproveMessages()
Return the approve messages status of this section
|
int |
getArticleLayoutId()
The article layout id is the lyaout id that is used when displaying
articles is this section.
|
String |
getArticleLayoutName()
The article layout name is the name of the layout to be used when
displaying article in this section.
|
boolean |
getAskToJoin()
Return the ask-to-join status of this section
|
Date |
getCreationDate()
Creation date was the date this section was created.
|
String |
getDeclaredParameter(String parameterName)
Return the value of the specified parameter in this section, disregarding any
inherited value.
|
Set |
getDeclaredParameterNameSet()
Return java.util.Set containing the names of all paramters in this section, disregarding any
inherited parameters.
|
String |
getDirectoryName()
Return the directory name of this section.
|
String |
getDirectoryPath()
Return the absolute directory of this section on the local file system,
relative to the publication root.
|
Date |
getFirstPublishedDate()
First published date is the date this section was published the first time.
|
int[] |
getHomeArticleIds()
Return an array of integers containing the article Id's of each article
that has this section as its home section
|
boolean |
getHtmlCache()
Return the html caching status of this section
|
boolean |
getInheritAccess()
The section has the posibilty to inherit the access rights from the parent
section or not.
|
Date |
getLastModifiedDate()
Last modified is the date this section last was modified.
|
int |
getLayoutId()
The layout id is the id of the layout that is used on this section.
|
String |
getLayoutName()
Layout name is the name of the layout used on this section.
|
String |
getName()
Return the name of this section
|
String |
getParameter(String parameterName)
Return the value of the specified parameter, use the inherited value if it is
not specified in this section.
|
Set |
getParameterNameSet()
Return a java.util.Set containing the names of all parameters in this section,
included inherited parameters from parent sections.
|
PresentationSection |
getParent()
Return the parent section of this section
|
String |
getPath()
The local file system path to this section.
|
Collection |
getPools()
Return all of the pools related to this section in an Collection.
|
int |
getPriority()
Return the priority of this section
|
Date |
getPublishDate()
Publish date was the date when this section was published.
|
String |
getRelativePath()
The path name of the directory that represents the section in the file
system, relative to the Publication root.
|
String |
getSectionUrl()
Returns the url specifically configured for this section.
|
String |
getSource()
Returns the source of this section
|
String |
getSourceId()
Return the source id of this section
|
int |
getState()
Return the state of this section
|
Collection |
getSubSections()
Returns all subsections of this section
|
String |
getTypeName()
Return the typeName of this section
|
String |
getUniqueName()
Return the unique name of this Section
|
String |
getUrl()
Calcultate the url of this section, based on super-sections and the publication.
|
boolean |
isAgreementRequired()
Checks wether or not you need an agreement to publish this section.
|
boolean |
isVirtualSource()
Will return true if this section is a virtual source, else it will return
false
|
getActivateDate, getArticleCount, getChangedDate, getExpireDate, getPresentationArticles, getPublication, getPublicationId, getRootElement, getSection, getSectionId, inPool
getHashKey, getId
Collection getSubSections()
PresentationSection getParent()
String getName()
String getUniqueName()
String getTypeName()
String getDirectoryName()
Date getCreationDate()
getCreationDate
in interface PresentationPool
int getState()
Date getPublishDate()
Date getLastModifiedDate()
Date getFirstPublishedDate()
int getLayoutId()
String getLayoutName()
int getArticleLayoutId()
String getArticleLayoutName()
boolean getHtmlCache()
String getUrl()
String getSectionUrl()
String getPath()
String getRelativePath()
int getPriority()
boolean getApproveMessages()
true
if this section approve messages, else
false
boolean getAskToJoin()
PresentationPool getActivePool()
Collection getPools()
boolean getInheritAccess()
true
if this section inherrit access rights, else
false
String getParameter(String parameterName)
parameterName
- name of the parameter to retrieveSet getParameterNameSet()
String getDeclaredParameter(String parameterName)
Set getDeclaredParameterNameSet()
String getDirectoryPath()
int[] getHomeArticleIds()
String getSource()
String getSourceId()
boolean isVirtualSource()
true if this section is a virtual source, else
false
boolean isAgreementRequired()
int getAgreementId()
AgreementInfo getAgreementInfo()
© 1998- 2018 Stibo DX