public interface SectionTransaction extends Section, IOTransaction
Section
object.
This will ensure that only one person can modify this section at a time. A new transaction object can be retrieved when this object is released.
See LockManager
for further details on locking.
Make sure that all manditory attributes are set before invoking IOTransaction.create()
.
Manditory attributes:
Section
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 |
---|---|
String |
putParameter(String pName,
String pValue)
Sets the value of the specified section parameter.
|
String |
removeParameter(String pName)
Removes the specified section parameter if it is present.
|
void |
setAgreementId(int agreementId)
Sets the id of the agreement belonging to this section.
|
void |
setAgreementRequired(boolean agreementRequired)
Sets wether or not you need an agreement to publish this section.
|
void |
setArticleLayout(Layout layout)
Deprecated.
|
void |
setArticleLayoutId(int aLayoutId)
Deprecated.
|
void |
setCreationDate(Timestamp cDate)
Sets the time when this section was created.
|
void |
setDirectoryName(String name)
Sets the name of the directory that will be owned by this section.
|
void |
setEdition(int edition)
Deprecated.
not in use.
|
void |
setFirstPublished(Timestamp firstPub)
Sets the date when this topic was first published.
|
void |
setHidden(boolean pHidden)
Sets the Section to be hidden or not.
|
void |
setInheritAccess(boolean mInheritAccess)
Sets whether or not this section should inherit access rights from it's parent.
|
void |
setKeyword(String keyword)
Sets the keyword of this section.
|
void |
setLastModified(Timestamp lastMod)
Sets the date when this topic was last modified.
|
void |
setLayoutId(int layoutId)
Deprecated.
|
void |
setName(String name)
Sets the name of this section.
|
void |
setParameters(Map<String,String> pParameters)
Sets the specified parameters to be the new section parameters for this section.
|
void |
setParameters(Properties pParameters)
Deprecated.
use
setParameters(java.util.Map) instead |
void |
setParent(Section parent)
Sets the parent of this section.
|
void |
setPriority(int pri)
Sets the priority of this section.
|
void |
setPublishDate(Timestamp pubDate)
Sets the date when this topic was published.
|
void |
setSectionLayout(Layout layout)
Deprecated.
|
void |
setSectionLayoutId(int sLayoutId)
Deprecated.
|
void |
setSectionUrl(String url)
Sets the url of this section.
|
void |
setSource(String pSource)
Sets the source of this section.
|
void |
setSourceId(String pSourceId)
Sets the source id of this section.
|
void |
setState(int stateId)
Sets the state of this section.
|
void |
setStorylineTemplates(Collection<Type> pTemplateTypes)
Sets the storyline templates that is to be used by this section
|
void |
setType(int type)
Sets the type of section.
|
void |
setUniqueName(String name)
Sets the unique name of this section.
|
void |
setVirtualSource(boolean pSource)
Sets whether or not this section is source for any virtual sections.
|
getActiveIndexPage, getActivePool, getAgreementId, getAgreementInfo, getApproveMessages, getArticleLayoutId, getArticleLayoutName, getAskToJoin, getCreationDate, getDeclaredParameter, getDeclaredParameterNameSet, getDeclaredParameters, getDirectoryName, getDirectoryPath, getEdition, getFirstPublished, getHomeArticleIds, getHomeArticleIds, getHtmlCache, getInboxes, getIndexPages, getInheritAccess, getIsVirtualSource, getKeyword, getLastModified, getLayoutId, getLayoutName, getLayouts, getLists, getName, getParameter, getParameterNameSet, getParameters, getParent, getParentId, getPath, getPools, getPreviewToken, getPreviewUrl, getPreviewUrlForPool, getPreviewUrlForPool, getPriority, getPublishDate, getRelativePath, getSectionUrl, getSource, getSourceId, getState, getStorylineTemplates, getSubSectionByDirectoryName, getSubSections, getType, getUniqueName, getUrl, getVirtualParameter, getVirtualParameterNameSet, isAgreementRequired, isAllowedAsHomeSection, isHidden, isVirtualSource, removeLayout, setLayouts
create, delete, getObject, release, setId, setOwnerPublicationId, update
breakAndLock, createTransaction, getChecksum, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomain, getProtectionDomains, isLocked, isPreview, isValid, lock, lock, lock, lock, refresh
void setParent(Section parent)
parent
- the parent of this sectionvoid setName(String name) throws PersistentStoreException, NoSuchObjectException
name
- the name of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setUniqueName(String name) throws PersistentStoreException, NoSuchObjectException
name
- the unique name of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setType(int type) throws PersistentStoreException, NoSuchObjectException
type
- the type of sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existType
void setDirectoryName(String name) throws PersistentStoreException, NoSuchObjectException
name
- the name of the directory that will be owned by this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setCreationDate(Timestamp cDate) throws PersistentStoreException, NoSuchObjectException
cDate
- the time when this section was createdPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp
void setState(int stateId) throws PersistentStoreException, NoSuchObjectException
TypeManager.getType(neo.xredsys.api.Type)
method.stateId
- the state of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setKeyword(String keyword) throws PersistentStoreException, NoSuchObjectException
keyword
- the keyword of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setPublishDate(Timestamp pubDate) throws PersistentStoreException, NoSuchObjectException
pubDate
- the date when this topic was publishedPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existTimestamp
void setLastModified(Timestamp lastMod) throws PersistentStoreException, NoSuchObjectException
lastMod
- the date when this topic was last modifiedPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setFirstPublished(Timestamp firstPub) throws PersistentStoreException, NoSuchObjectException
firstPub
- the date when this topic was first publishedPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setLayoutId(int layoutId) throws PersistentStoreException, NoSuchObjectException
layoutId
- the id of the layout belonging to this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setArticleLayoutId(int aLayoutId) throws PersistentStoreException, NoSuchObjectException
aLayoutId
- the id of the article layout belonging to this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setArticleLayout(Layout layout) throws PersistentStoreException, NoSuchObjectException
layout
- the article layout belonging to this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setSectionLayoutId(int sLayoutId) throws PersistentStoreException, NoSuchObjectException
sLayoutId
- the id of the section layout that will belong to this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setSectionLayout(Layout layout) throws PersistentStoreException, NoSuchObjectException
IOAtom.ID_INVALID
).layout
- the section layout that will belong to this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not exist@Deprecated void setEdition(int edition) throws PersistentStoreException, NoSuchObjectException
edition
- the edition of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setSectionUrl(String url) throws PersistentStoreException, NoSuchObjectException
url
- the url of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIllegalArgumentException
- if the uri is invalid.void setPriority(int pri) throws PersistentStoreException, NoSuchObjectException
pri
- the priority of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid setSource(String pSource) throws PersistentStoreException
pSource
- the source of this sectionPersistentStoreException
- if an error occurs in the persistence layervoid setSourceId(String pSourceId) throws PersistentStoreException
pSourceId
- the source id of this sectionPersistentStoreException
- if an error occurs in the persistence layervoid setInheritAccess(boolean mInheritAccess)
mInheritAccess
- true if this section should inherit access rights from it's parent; otherwise false.void setHidden(boolean pHidden)
pHidden
- is a Boolean
void setVirtualSource(boolean pSource)
pSource
- true if this section is source for any virtual sections; otherwise falseVirtualSection
void setAgreementRequired(boolean agreementRequired)
agreementRequired
- true if you need an agreement to publish this section;otherwise falseAgreementInfo
void setAgreementId(int agreementId)
agreementId
- the id of the agreement belonging to this sectionAgreementInfo
String putParameter(String pName, String pValue)
pName
- The parameter namepValue
- The valueSection.getParameter(String)
String removeParameter(String pName)
pName
- The section parameter to be removedSection.getParameter(String)
void setParameters(Properties pParameters)
setParameters(java.util.Map)
insteadpParameters
- The new section parameters to use for this section.Section.getParameter(String)
void setParameters(Map<String,String> pParameters)
pParameters
- The new section parameters to use for this section.Section.getParameter(String)
void setStorylineTemplates(Collection<Type> pTemplateTypes)
pTemplateTypes
- the storyline templates to use© 1998- 2018 Stibo DX