public class SectionImpl extends IOObjectImpl implements Section
IOAtom.ObjectType
LOGGER, sRefreshObjectBeforeLock
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
Constructor and Description |
---|
SectionImpl()
Deprecated.
|
SectionImpl(int sectionId)
Deprecated.
|
SectionImpl(int sectionId,
int ownerPublicationId)
Deprecated.
|
SectionImpl(neo.xredsys.Section value)
Deprecated.
|
SectionImpl(Section section)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
protected void |
checkLoaded()
Deprecated.
|
IndexPage |
getActiveIndexPage()
Deprecated.
Retrieves the active index page from this section.
|
Pool |
getActivePool()
Deprecated.
Retrieves the active pool from this section.
|
int |
getAgreementId()
Deprecated.
Retrieves the id of this section's agreement.
|
AgreementInfo |
getAgreementInfo()
Deprecated.
Retrieves this sections agreement.
|
boolean |
getApproveMessages()
Deprecated.
|
int |
getArticleLayoutId()
Deprecated.
Retrieves the layout id that is used when displaying
articles is this section.
|
String |
getArticleLayoutName()
Deprecated.
Returns the name of the layout used for displaying this section's content items.
|
boolean |
getAskToJoin()
Deprecated.
|
String |
getChecksum()
Deprecated.
Get the version for this object.
|
Timestamp |
getCreationDate()
Deprecated.
Returns the time at which this section was created.
|
String |
getDeclaredParameter(String parameterName)
Deprecated.
Retrieves the value of the specified parameter in this section, disregarding any
inherited value.
|
Set |
getDeclaredParameterNameSet()
Deprecated.
Retrieves java.util.Set containing the names of all parameters in this section, disregarding any
inherited parameters.
|
Map |
getDeclaredParameters()
Deprecated.
Retrieves a
java.util.Map containing all parameters specified in this section, disregarding any
inherited value. |
String |
getDirectoryName()
Deprecated.
Returns the directory name of this section.
|
String |
getDirectoryPath()
Deprecated.
Retrieves the absolute directory of this section on the local file system,
relative to the publication root.
|
int |
getEdition()
Deprecated.
Retrieves the edition of this section.
|
Timestamp |
getFirstPublished()
Deprecated.
Returns the time at which this section was published for the first time.
|
int[] |
getHomeArticleIds()
Deprecated.
Retrieves an array of integers containing the article Id's of each article
that has this section as its home section.
|
int[] |
getHomeArticleIds(boolean pExcludeHidden)
Deprecated.
Retrieves an array of integers containing the article Id's of each article
that has this section as its home section.
|
boolean |
getHtmlCache()
Deprecated.
Retrieves the html caching status of this section.
|
Collection<ListPool> |
getInboxes()
Deprecated.
Retrieves a collection of all inboxes related to this section.
|
Collection<IndexPage> |
getIndexPages()
Deprecated.
Retrieves a collection of all index pages related to this section.
|
boolean |
getInheritAccess()
Deprecated.
Checks whether or not this section inherits access rights from its parent.
|
protected neo.xredsys.Section |
getIOSection()
Deprecated.
|
boolean |
getIsVirtualSource()
Deprecated.
|
String |
getKeyword()
Deprecated.
Returns the keyword of this section.
|
Timestamp |
getLastModified()
Deprecated.
Returns the time at which this section was last modified.
|
int |
getLayoutId()
Deprecated.
Retrieves the id of the layout belonging to this section.
|
String |
getLayoutName()
Deprecated.
Returns the name of the layout used for this section.
|
Layout[] |
getLayouts()
Deprecated.
Retrieves all layouts connected to this section
|
Collection<ListPool> |
getLists()
Deprecated.
Retrieves a collection of all lists related to this section.
|
String |
getName()
Deprecated.
Returns the name of this section.
|
String |
getParameter(String parameterName)
Deprecated.
Retrieves the value of the specified parameter, use the inherited value if it is
not specified in this section.
|
Set |
getParameterNameSet()
Deprecated.
Retrieves a
java.util.Set containing the names of all parameters in this section,
included inherited parameters from parent sections. |
Map |
getParameters()
Deprecated.
Retrieves a
java.util.Map containing all parameters in this section,
included inherited parameters from parent sections. |
Section |
getParent()
Deprecated.
Returns the parent section of this section.
|
int |
getParentId()
Deprecated.
Retrieves the id of the parent section of this section.
|
String |
getPath()
Deprecated.
Returns the local file system path of this section.
|
Pool[] |
getPools()
Deprecated.
Retrieves all of the pools related to this section in an array.
|
String |
getPreviewToken(int poolId)
Deprecated.
Generate a token to be used when preview a Pool.
|
String |
getPreviewUrl()
Deprecated.
Creates and then returns the preview url to this section.
|
String |
getPreviewUrlForPool(int poolId)
Deprecated.
Creates and then returns the preview url to this section for a given pool.
|
String |
getPreviewUrlForPool(int poolId,
Date when)
Deprecated.
Creates and then returns the preview url to this section for a given pool.
|
int |
getPriority()
Deprecated.
Retrieves the priority of this section.
|
ProtectionDomain |
getProtectionDomain()
Deprecated.
Retrieves the
ProtectionDomain of this object. |
Timestamp |
getPublishDate()
Deprecated.
Returns the time at which this section was published.
|
String |
getRelativePath()
Deprecated.
Returns the path of this section relative to the
Publication root. |
String |
getSectionUrl()
Deprecated.
Retrieves the url specifically configured for this section.
|
String |
getSource()
Deprecated.
Retrieves the source of this section.
|
String |
getSourceId()
Deprecated.
Retrieves the source id of this section.
|
int |
getState()
Deprecated.
Retrieves the state of this section.
|
Collection<Type> |
getStorylineTemplates()
Deprecated.
Returns a collection of all storyline templates that has been assigned to be used on this section
|
int |
getSubSectionByDirectoryName(String pDirectoryName)
Deprecated.
Returns the id of the subsection with the given directory name.
|
Section[] |
getSubSections()
Deprecated.
Returns the subsections of this section.
|
IOTransaction |
getTransactionObjectImpl()
Deprecated.
|
Type |
getType()
Deprecated.
Retrieves the type of this section.
|
String |
getUniqueName()
Deprecated.
Returns the unique name of this section.
|
String |
getUrl()
Deprecated.
Returns the URL of this section.
|
String |
getUUID()
Deprecated.
|
String |
getVirtualParameter(String parameterName)
Deprecated.
If this is a shadow section, retrieve the given parameter
from the virtual source (shared) section.
|
Set |
getVirtualParameterNameSet()
Deprecated.
Return the list of parameter names that are inherited
from the virtual source, if any.
|
boolean |
isAgreementRequired()
Deprecated.
Checks whether or not you need an agreement to publish this section.
|
boolean |
isAllowedAsHomeSection()
Deprecated.
Check if this section can be used as an article's home section.
|
boolean |
isHidden()
Deprecated.
Check if the section is marked as hidden or not.
|
boolean |
isVirtualSource()
Deprecated.
Checks whether or not this can be a source for a virtual section.
|
void |
refresh()
Deprecated.
|
boolean |
removeLayout(Layout l)
Deprecated.
Removes a layout from this section.
|
protected void |
setIOSection(neo.xredsys.Section s)
Deprecated.
|
boolean |
setLayouts(Layout[] l)
Deprecated.
Sets the layouts of this section.
|
breakAndLock, compareTo, createTransaction, equals, getDefaultProtectionDomain, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomains, getValid, hashCode, isLocked, isPreview, isStillValid, isValid, lock, lock, lock, lock, objectTypeAsString, setId, setOwnerPublicationId, setValid, stringToObjectType, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
breakAndLock, createTransaction, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomains, isLocked, isPreview, isValid, lock, lock, lock, lock
public SectionImpl(neo.xredsys.Section value)
public SectionImpl(Section section)
public SectionImpl(int sectionId)
public SectionImpl(int sectionId, int ownerPublicationId)
public SectionImpl()
protected neo.xredsys.Section getIOSection()
protected void setIOSection(neo.xredsys.Section s)
public IOTransaction getTransactionObjectImpl()
getTransactionObjectImpl
in class IOObjectImpl
public String getUUID()
getUUID
in class IOObjectImpl
public Section[] getSubSections() throws PersistentStoreException, NoSuchObjectException
Section
getSubSections
in interface Section
Array
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic int getSubSectionByDirectoryName(String pDirectoryName)
Section
getSubSectionByDirectoryName
in interface Section
pDirectoryName
- The name of the subsectionpublic Layout[] getLayouts() throws PersistentStoreException, NoSuchObjectException
Section
getLayouts
in interface Section
Array
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic boolean removeLayout(Layout l) throws PersistentStoreException, NoSuchObjectException
Section
Layout
does not exist in the section, nothing happens.removeLayout
in interface Section
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 existpublic boolean setLayouts(Layout[] l) throws PersistentStoreException, NoSuchObjectException
Section
setLayouts
in interface Section
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 existpublic void refresh() throws PersistentStoreException, NoSuchObjectException
refresh
in interface IOObject
PersistentStoreException
NoSuchObjectException
protected void checkLoaded() throws PersistentStoreException, NoSuchObjectException
public Section getParent() throws PersistentStoreException, NoSuchObjectException
Section
getParent
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic int getParentId()
Section
getParentId
in interface Section
public String getChecksum()
IOObject
getChecksum
in interface IOObject
getChecksum
in class IOObjectImpl
public String getName() throws PersistentStoreException, NoSuchObjectException
Section
getName
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic String getUniqueName() throws PersistentStoreException, NoSuchObjectException
Section
getUniqueName
in interface Section
Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic Type getType() throws PersistentStoreException, NoSuchObjectException
Section
getType
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existType
public String getDirectoryName() throws PersistentStoreException, NoSuchObjectException
Section
getDirectoryName
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic Timestamp getCreationDate() throws PersistentStoreException, NoSuchObjectException
Section
getCreationDate
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic int getState() throws PersistentStoreException, NoSuchObjectException
Section
TypeManager.getType(neo.xredsys.api.Type)
method.getState
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTypeManager
,
Type
public String getKeyword() throws PersistentStoreException, NoSuchObjectException
Section
getKeyword
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic Timestamp getPublishDate() throws PersistentStoreException, NoSuchObjectException
Section
getPublishDate
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic Timestamp getLastModified() throws PersistentStoreException, NoSuchObjectException
Section
getLastModified
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic Timestamp getFirstPublished() throws PersistentStoreException, NoSuchObjectException
Section
Section.getPublishDate()
.getFirstPublished
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic int getLayoutId() throws PersistentStoreException, NoSuchObjectException
Section
getLayoutId
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout
public int getArticleLayoutId() throws PersistentStoreException, NoSuchObjectException
Section
getArticleLayoutId
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout
public String getLayoutName() throws PersistentStoreException, NoSuchObjectException
Section
getLayoutName
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic String getArticleLayoutName() throws PersistentStoreException, NoSuchObjectException
Section
getArticleLayoutName
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic int getEdition() throws PersistentStoreException, NoSuchObjectException
Section
getEdition
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic boolean getHtmlCache() throws PersistentStoreException, NoSuchObjectException
Section
getHtmlCache
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic String getUrl() throws PersistentStoreException, NoSuchObjectException
Section
getUrl
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic String getPreviewUrl() throws PersistentStoreException, NoSuchObjectException
Section
getPreviewUrl
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic String getPreviewUrlForPool(int poolId)
Section
getPreviewUrlForPool
in interface Section
public String getPreviewUrlForPool(int poolId, Date when) throws PersistentStoreException, NoSuchObjectException
Section
getPreviewUrlForPool
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic String getPreviewToken(int poolId)
Section
getPreviewToken
in interface Section
poolId
- id of Pool used to create the preview token.public String getPath() throws PersistentStoreException, NoSuchObjectException
Section
getPath
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic String getRelativePath() throws PersistentStoreException, NoSuchObjectException
Section
Publication
root.getRelativePath
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic String getSectionUrl() throws PersistentStoreException, NoSuchObjectException
Section
getSectionUrl
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic int getPriority() throws PersistentStoreException, NoSuchObjectException
Section
getPriority
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic boolean getApproveMessages() throws PersistentStoreException, NoSuchObjectException
getApproveMessages
in interface Section
PersistentStoreException
NoSuchObjectException
public boolean getAskToJoin() throws PersistentStoreException, NoSuchObjectException
getAskToJoin
in interface Section
PersistentStoreException
NoSuchObjectException
public Pool getActivePool() throws PersistentStoreException, NoSuchObjectException
Section
getActivePool
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic IndexPage getActiveIndexPage() throws PersistentStoreException, NoSuchObjectException
Section
getActiveIndexPage
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if there is no active index pagepublic String getSource() throws PersistentStoreException
Section
getSource
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerpublic String getSourceId() throws PersistentStoreException
Section
getSourceId
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerpublic Pool[] getPools() throws PersistentStoreException, NoSuchObjectException
Section
getPools
in interface Section
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic boolean getInheritAccess()
Section
getInheritAccess
in interface Section
true
if this section inherits access rights, else
false
public boolean isHidden()
Section
public String getParameter(String parameterName)
Section
getParameter
in interface Section
parameterName
- name of the parameter to retrievepublic Set getParameterNameSet()
Section
java.util.Set
containing the names of all parameters in this section,
included inherited parameters from parent sections.getParameterNameSet
in interface Section
Set
containing all parameter namespublic Map getDeclaredParameters()
Section
java.util.Map
containing all parameters specified in this section, disregarding any
inherited value.getDeclaredParameters
in interface Section
Map
containing all parameterspublic Map getParameters()
Section
java.util.Map
containing all parameters in this section,
included inherited parameters from parent sections.getParameters
in interface Section
Map
containing all parameterspublic String getDeclaredParameter(String parameterName)
Section
getDeclaredParameter
in interface Section
parameterName
- name of parameter to retrievepublic Set getDeclaredParameterNameSet()
Section
getDeclaredParameterNameSet
in interface Section
Set
containg all parameter names in this sectionSet
public String getVirtualParameter(String parameterName)
getVirtualParameter
in interface Section
parameterName
- name of parameter to retrievepublic Set getVirtualParameterNameSet()
getVirtualParameterNameSet
in interface Section
Set
containg all parameter names
in the shared section of which this section is a shadow.public String getDirectoryPath()
Section
getDirectoryPath
in interface Section
public int[] getHomeArticleIds()
Section
getHomeArticleIds
in interface Section
public int[] getHomeArticleIds(boolean pExcludeHidden)
Section
getHomeArticleIds
in interface Section
pExcludeHidden
- true if hidden articles should be excludedpublic boolean getIsVirtualSource()
getIsVirtualSource
in interface Section
public boolean isVirtualSource()
Section
VirtualSection
for details on virtual sections.isVirtualSource
in interface Section
true
if this section is a virtual source, false
otherwisepublic boolean isAgreementRequired()
Section
AgreementInfo
for details on agreements.isAgreementRequired
in interface Section
AgreementInfo
public int getAgreementId()
Section
AgreementInfo
for details on agreements.getAgreementId
in interface Section
AgreementInfo
public AgreementInfo getAgreementInfo()
Section
AgreementInfo
for details on agreements.getAgreementInfo
in interface Section
AgreementInfo
public boolean isAllowedAsHomeSection()
Section
isAllowedAsHomeSection
in interface Section
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
.public Collection<ListPool> getInboxes()
Section
getInboxes
in interface Section
public Collection<ListPool> getLists()
Section
public Collection<IndexPage> getIndexPages()
Section
getIndexPages
in interface Section
public ProtectionDomain getProtectionDomain() throws PersistentStoreException, NoSuchObjectException
IOObject
ProtectionDomain
of this object.getProtectionDomain
in interface IOObject
getProtectionDomain
in class IOObjectImpl
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic Collection<Type> getStorylineTemplates() throws PersistentStoreException
Section
getStorylineTemplates
in interface Section
PersistentStoreException
- if loading the storyline template fails© 1998- 2021 Escenic AS