public interface Section extends IOObject
Section
objects in the
Escenic system. A SectionTransaction
must be retrieved when you need to modify this
object.
A
Examples:
It is possible to share sections between publications, where each publication uses its own presentation design on the shared content. This option is of little concern to template development, and will not be covered in this document: The templates are the same whether sections are shared or not.
Each section is associated with three templates:
Each section can have one or more index pages. For more information about index pages, see IndexPage
Each section can have one or more named inboxes. When a section is created, a default inbox is created. This inbox
does not have a name and can not be deleted. For more information about index pages, see IndexPage
SectionTransaction
,
LockManager
IOAtom.ObjectType
ID_INVALID, OBJECTTYPE_AGREEMENTINFO, OBJECTTYPE_ARTICLE, OBJECTTYPE_CATALOG, OBJECTTYPE_CATEGORY, OBJECTTYPE_ENTITY, OBJECTTYPE_FORUM, OBJECTTYPE_LAYOUT, OBJECTTYPE_MAX, OBJECTTYPE_MIN, OBJECTTYPE_PERSON, OBJECTTYPE_POOL, OBJECTTYPE_POSTING, OBJECTTYPE_PRESENTATION_FORUM, OBJECTTYPE_PRESENTATION_POSTING, OBJECTTYPE_PRESENTATION_THREAD, OBJECTTYPE_PROFILE, OBJECTTYPE_PUBLICATION, OBJECTTYPE_SECTION, OBJECTTYPE_THREAD, OBJECTTYPE_TOPIC, OBJECTTYPE_UNKNOWN, OBJECTTYPE_USERGROUP
Modifier and Type | Method and Description |
---|---|
IndexPage |
getActiveIndexPage()
Retrieves the active index page from this section.
|
Pool |
getActivePool()
Deprecated.
use getActiveIndexPage instead
|
int |
getAgreementId()
Retrieves the id of this section's agreement.
|
AgreementInfo |
getAgreementInfo()
Retrieves this sections agreement.
|
boolean |
getApproveMessages()
Deprecated.
not in use
|
int |
getArticleLayoutId()
Deprecated.
|
String |
getArticleLayoutName()
Deprecated.
|
boolean |
getAskToJoin()
Deprecated.
not in use
|
Timestamp |
getCreationDate()
Returns the time at which this section was created.
|
String |
getDeclaredParameter(String parameterName)
Retrieves the value of the specified parameter in this section, disregarding any
inherited value.
|
Set |
getDeclaredParameterNameSet()
Retrieves java.util.Set containing the names of all parameters in this section, disregarding any
inherited parameters.
|
Map |
getDeclaredParameters()
Retrieves a
java.util.Map containing all parameters specified in this section, disregarding any
inherited value. |
String |
getDirectoryName()
Returns the directory name of this section.
|
String |
getDirectoryPath()
Retrieves the absolute directory of this section on the local file system,
relative to the publication root.
|
int |
getEdition()
Retrieves the edition of this section.
|
Timestamp |
getFirstPublished()
Returns the time at which this section was published for the first time.
|
int[] |
getHomeArticleIds()
Deprecated.
Use
getHomeArticleIds(boolean) instead. |
int[] |
getHomeArticleIds(boolean excludeHidden)
Retrieves an array of integers containing the article Id's of each article
that has this section as its home section.
|
boolean |
getHtmlCache()
Deprecated.
|
Collection<ListPool> |
getInboxes()
Retrieves a collection of all inboxes related to this section.
|
Collection<IndexPage> |
getIndexPages()
Retrieves a collection of all index pages related to this section.
|
boolean |
getInheritAccess()
Checks whether or not this section inherits access rights from its parent.
|
boolean |
getIsVirtualSource()
Deprecated.
use
isVirtualSource() instead |
String |
getKeyword()
Returns the keyword of this section.
|
Timestamp |
getLastModified()
Returns the time at which this section was last modified.
|
int |
getLayoutId()
Deprecated.
|
String |
getLayoutName()
Deprecated.
|
Layout[] |
getLayouts()
Deprecated.
|
Collection<ListPool> |
getLists()
Retrieves a collection of all lists related to this section.
|
String |
getName()
Returns the name of this section.
|
String |
getParameter(String parameterName)
Retrieves the value of the specified parameter, use the inherited value if it is
not specified in this section.
|
Set |
getParameterNameSet()
Retrieves a
java.util.Set containing the names of all parameters in this section,
included inherited parameters from parent sections. |
Map |
getParameters()
Retrieves a
java.util.Map containing all parameters in this section,
included inherited parameters from parent sections. |
Section |
getParent()
Returns the parent section of this section.
|
int |
getParentId()
Retrieves the id of the parent section of this section.
|
String |
getPath()
Deprecated.
|
Pool[] |
getPools()
Deprecated.
use getInboxes or getIndexPages instead
|
String |
getPreviewToken(int poolId)
Deprecated.
no replacement
|
String |
getPreviewUrl()
Creates and then returns the preview url to this section.
|
String |
getPreviewUrlForPool(int poolId)
Deprecated.
use
Pool.getPreviewUrl() instead |
String |
getPreviewUrlForPool(int poolId,
Date when)
Deprecated.
use
Pool.getPreviewUrl(java.util.Date) instead |
int |
getPriority()
Retrieves the priority of this section.
|
Timestamp |
getPublishDate()
Returns the time at which this section was published.
|
String |
getRelativePath()
Deprecated.
|
String |
getSectionUrl()
Retrieves the url specifically configured for this section.
|
String |
getSource()
Retrieves the source of this section.
|
String |
getSourceId()
Retrieves the source id of this section.
|
int |
getState()
Retrieves the state of this section.
|
Collection<Type> |
getStorylineTemplates()
Returns a collection of all storyline templates that has been assigned to be used on this section
|
int |
getSubSectionByDirectoryName(String pDirectoryName)
Returns the id of the subsection with the given directory name.
|
Section[] |
getSubSections()
Returns the subsections of this section.
|
Type |
getType()
Retrieves the type of this section.
|
String |
getUniqueName()
Returns the unique name of this section.
|
String |
getUrl()
Returns the URL of this section.
|
String |
getVirtualParameter(String parameterName)
Find a parameter in the shared section if this section
is a shadow section, otherwise return null.
|
Set |
getVirtualParameterNameSet()
Return the list of parameter names that are inherited
from the virtual source, which can be queried by calling
getVirtualParameter(java.lang.String) ; |
boolean |
isAgreementRequired()
Checks whether or not you need an agreement to publish this section.
|
boolean |
isAllowedAsHomeSection()
Check if this section can be used as an article's home section.
|
boolean |
isHidden()
Check if the section is marked as hidden or not.
|
boolean |
isVirtualSource()
Checks whether or not this can be a source for a virtual section.
|
boolean |
removeLayout(Layout l)
Deprecated.
|
boolean |
setLayouts(Layout[] l)
Deprecated.
|
breakAndLock, createTransaction, getChecksum, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomain, getProtectionDomains, isLocked, isPreview, isValid, lock, lock, lock, lock, refresh
Section[] getSubSections() throws PersistentStoreException, NoSuchObjectException
Array
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existint getSubSectionByDirectoryName(String pDirectoryName) throws PersistentStoreException, NoSuchObjectException
pDirectoryName
- The name of the subsectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout[] getLayouts() throws PersistentStoreException, NoSuchObjectException
Array
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existboolean removeLayout(Layout l) throws PersistentStoreException, NoSuchObjectException
Layout
does not exist in the section, nothing happens.true
if it succeeded in removing the layout; false
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existboolean setLayouts(Layout[] l) throws PersistentStoreException, NoSuchObjectException
true
if it succeeded adding the layouts to this
section; false otherwisePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existSection getParent() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existint getParentId()
String getName() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getUniqueName() throws PersistentStoreException, NoSuchObjectException
Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existType getType() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existType
String getDirectoryName() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp getCreationDate() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existint getState() throws PersistentStoreException, NoSuchObjectException
TypeManager.getType(neo.xredsys.api.Type)
method.PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTypeManager
,
Type
String getKeyword() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp getPublishDate() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp getLastModified() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp getFirstPublished() throws PersistentStoreException, NoSuchObjectException
getPublishDate()
.PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existint getLayoutId() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout
String getLayoutName() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existint getArticleLayoutId() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout
String getArticleLayoutName() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existint getEdition() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existboolean getHtmlCache() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getUrl() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getPreviewUrl() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getPreviewUrlForPool(int poolId) throws PersistentStoreException, NoSuchObjectException
Pool.getPreviewUrl()
insteadPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getPreviewUrlForPool(int poolId, Date when) throws PersistentStoreException, NoSuchObjectException
Pool.getPreviewUrl(java.util.Date)
insteadPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getPreviewToken(int poolId)
poolId
- id of Pool used to create the preview token.String getSectionUrl() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getPath() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getRelativePath() throws PersistentStoreException, NoSuchObjectException
Publication
root.PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existint getPriority() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existboolean getApproveMessages() throws PersistentStoreException, NoSuchObjectException
boolean getAskToJoin() throws PersistentStoreException, NoSuchObjectException
Pool getActivePool() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIndexPage getActiveIndexPage() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if there is no active index pagePool[] getPools() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existboolean getInheritAccess()
true
if this section inherits access rights, else
false
boolean isHidden()
Boolean
String getParameter(String parameterName)
parameterName
- name of the parameter to retrieveSet getParameterNameSet()
java.util.Set
containing the names of all parameters in this section,
included inherited parameters from parent sections.Set
containing all parameter namesMap getParameters()
java.util.Map
containing all parameters in this section,
included inherited parameters from parent sections.Map
containing all parametersMap getDeclaredParameters()
java.util.Map
containing all parameters specified in this section, disregarding any
inherited value.Map
containing all parametersString getDeclaredParameter(String parameterName)
parameterName
- name of parameter to retrieveSet getDeclaredParameterNameSet()
Set
containg all parameter names in this sectionSet
String getVirtualParameter(String parameterName)
Put simply, this method is used to get parameters that should be inherited from a shared section instead of the normal section hierarchy. The method is present in Section so that client code does not have to check whether or not the section is a virtual section first, and then check if the parameter has been inherited.
If the section is a normal section, this method returns null If the section is a virtual (shadow) section, this method returns the value of the parameter in the virtual source (shared) section
parameterName
- name of parameter to retrieveSet getVirtualParameterNameSet()
getVirtualParameter(java.lang.String)
;Set
containg all parameter names
in the shared section of which this section is a shadow.String getDirectoryPath()
int[] getHomeArticleIds()
getHomeArticleIds(boolean)
instead.int[] getHomeArticleIds(boolean excludeHidden)
excludeHidden
- true if hidden articles should be excludedString getSource() throws PersistentStoreException
PersistentStoreException
- if an error occurs in the persistence layerString getSourceId() throws PersistentStoreException
PersistentStoreException
- if an error occurs in the persistence layerboolean getIsVirtualSource()
isVirtualSource()
insteadboolean isVirtualSource()
VirtualSection
for details on virtual sections.true
if this section is a virtual source, false
otherwiseboolean isAgreementRequired()
AgreementInfo
for details on agreements.AgreementInfo
int getAgreementId()
AgreementInfo
for details on agreements.AgreementInfo
AgreementInfo getAgreementInfo()
AgreementInfo
for details on agreements.AgreementInfo
boolean isAllowedAsHomeSection()
true
if this section can be used as home section for
an article. This method will return false
for the following
sections: frontpage (unless the feature allowFrontPageAsHomeSection is set to true for the
publication), sections of type hidden and sections of type topic.
If the section is a mirror section, the method will return false
.Collection<ListPool> getInboxes()
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existCollection<ListPool> getLists()
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existCollection<IndexPage> getIndexPages()
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existCollection<Type> getStorylineTemplates() throws PersistentStoreException
PersistentStoreException
- if loading the storyline template fails© 1998- 2018 Stibo DX