public class SectionTransactionImpl extends SectionImpl implements SectionTransaction
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
Modifier and Type | Method and Description |
---|---|
boolean |
create()
Deprecated.
Creates a new object in the persistence layer.
|
boolean |
delete()
Deprecated.
Removes an existing
IOObject from the persistence layer. |
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. |
IOObject |
getObject()
Deprecated.
Retrieves the object this transaction was initialized with.
|
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.
|
boolean |
isHidden()
Deprecated.
Check if the section is marked as hidden or not.
|
String |
putParameter(String pName,
String pValue)
Deprecated.
Sets the value of the specified section parameter.
|
boolean |
release()
Deprecated.
Releases the lock on this
IOObject . |
String |
removeParameter(String pName)
Deprecated.
Removes the specified section parameter if it is present.
|
void |
setAgreementId(int agreementId)
Deprecated.
Sets the id of the agreement belonging to this section.
|
void |
setAgreementRequired(boolean agreementRequired)
Deprecated.
Sets wether or not you need an agreement to publish this section.
|
void |
setApproveMessages(int x)
Deprecated.
|
void |
setArticleLayout(Layout layout)
Deprecated.
Sets the article layout belonging to this section.
|
void |
setArticleLayoutId(int x)
Deprecated.
Sets the id of the article layout belonging to this section.
|
void |
setAskToJoin(int x)
Deprecated.
|
void |
setCreationDate(Timestamp x)
Deprecated.
Sets the time when this section was created.
|
void |
setDirectoryName(String pNewDirectoryName)
Deprecated.
Sets the name of the directory that will be owned by this section.
|
void |
setEdition(int x)
Deprecated.
Sets the edition of this section.
|
void |
setFirstPublished(Timestamp x)
Deprecated.
Sets the date when this topic was first published.
|
void |
setHidden(boolean pHidden)
Deprecated.
Sets the Section to be hidden or not.
|
void |
setHtmlCache(boolean x)
Deprecated.
|
void |
setId(int pId)
Deprecated.
Set the id of this object.
|
void |
setInheritAccess(boolean pInheritAccess)
Deprecated.
Sets whether or not this section should inherit access rights from it's parent.
|
void |
setKeyword(String x)
Deprecated.
Sets the keyword of this section.
|
void |
setLastModified(Timestamp x)
Deprecated.
Sets the date when this topic was last modified.
|
void |
setLayoutId(int x)
Deprecated.
Sets the id of the layout belonging to this section.
|
void |
setName(String name)
Deprecated.
Sets the name of this section.
|
void |
setObject(IOObject s)
Deprecated.
|
void |
setOwnerPublicationId(int pubId)
Deprecated.
This method sets the id of the owner publication
|
void |
setParameters(Map<String,String> pParameters)
Deprecated.
Sets the specified parameters to be the new section parameters for this section.
|
void |
setParameters(Properties pParameters)
Deprecated.
Sets the specified properties to be the new section parameters for this section.
|
void |
setParent(Section parent)
Deprecated.
Sets the parent of this section.
|
void |
setPriority(int x)
Deprecated.
Sets the priority of this section.
|
void |
setPublishDate(Timestamp x)
Deprecated.
Sets the date when this topic was published.
|
void |
setSectionLayout(Layout layout)
Deprecated.
Sets the section layout that will belong to this section.
|
void |
setSectionLayoutId(int x)
Deprecated.
Sets the id of the section layout that will belong to this section.
|
void |
setSectionUrl(String x)
Deprecated.
Sets the url of this section.
|
void |
setSource(String pSource)
Deprecated.
Sets the source of this section.
|
void |
setSourceId(String pSourceId)
Deprecated.
Sets the source id of this section.
|
void |
setState(int x)
Deprecated.
Sets the state of this section.
|
void |
setStorylineTemplates(Collection<Type> pTemplateTypes)
Deprecated.
Sets the storyline templates that is to be used by this section
|
void |
setType(int type)
Deprecated.
Sets the type of section.
|
void |
setUniqueName(String name)
Deprecated.
Sets the unique name of this section.
|
void |
setVirtualSource(boolean pSource)
Deprecated.
Sets whether or not this section is source for any virtual sections.
|
boolean |
update()
Deprecated.
A section is validated against the following rules:
A section must have a parent
The parent must belong to the same publication
The parent cannot be the section itself or any of its children
The section cannot have the same directory name as another sibling
|
checkLoaded, getActiveIndexPage, getActivePool, getAgreementId, getAgreementInfo, getApproveMessages, getArticleLayoutId, getArticleLayoutName, getAskToJoin, getChecksum, getCreationDate, getDirectoryName, getDirectoryPath, getEdition, getFirstPublished, getHomeArticleIds, getHomeArticleIds, getHtmlCache, getInboxes, getIndexPages, getInheritAccess, getIOSection, getIsVirtualSource, getKeyword, getLastModified, getLayoutId, getLayoutName, getLayouts, getLists, getName, getParentId, getPath, getPools, getPreviewToken, getPreviewUrl, getPreviewUrlForPool, getPreviewUrlForPool, getPriority, getProtectionDomain, getPublishDate, getRelativePath, getSectionUrl, getSource, getSourceId, getState, getStorylineTemplates, getSubSectionByDirectoryName, getSubSections, getTransactionObjectImpl, getType, getUniqueName, getUrl, getUUID, getVirtualParameter, getVirtualParameterNameSet, isAgreementRequired, isAllowedAsHomeSection, isVirtualSource, refresh, removeLayout, setIOSection, setLayouts
breakAndLock, compareTo, createTransaction, equals, getDefaultProtectionDomain, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomains, getValid, hashCode, isLocked, isPreview, isStillValid, isValid, lock, lock, lock, lock, objectTypeAsString, setValid, stringToObjectType, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getActiveIndexPage, getActivePool, getAgreementId, getAgreementInfo, getApproveMessages, getArticleLayoutId, getArticleLayoutName, getAskToJoin, getCreationDate, getDirectoryName, getDirectoryPath, getEdition, getFirstPublished, getHomeArticleIds, getHomeArticleIds, getHtmlCache, getInboxes, getIndexPages, getInheritAccess, getIsVirtualSource, getKeyword, getLastModified, getLayoutId, getLayoutName, getLayouts, getLists, getName, getParentId, getPath, getPools, getPreviewToken, getPreviewUrl, getPreviewUrlForPool, getPreviewUrlForPool, getPriority, getPublishDate, getRelativePath, getSectionUrl, getSource, getSourceId, getState, getStorylineTemplates, getSubSectionByDirectoryName, getSubSections, getType, getUniqueName, getUrl, getVirtualParameter, getVirtualParameterNameSet, isAgreementRequired, isAllowedAsHomeSection, isVirtualSource, removeLayout, setLayouts
breakAndLock, createTransaction, getChecksum, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomain, getProtectionDomains, isLocked, isPreview, isValid, lock, lock, lock, lock, refresh
public IOObject getObject()
IOTransaction
getObject
in interface IOTransaction
public void setObject(IOObject s)
public boolean update() throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
update
in interface IOTransaction
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIllegalOperationException
- if the state of the object did not pass validation checkspublic boolean create() throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
IOTransaction
create
in interface IOTransaction
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIllegalOperationException
- if the state of the object did not pass validation checkspublic boolean delete() throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
IOTransaction
IOObject
from the persistence layer.delete
in interface IOTransaction
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existIllegalOperationException
- if the state of the object did not pass validation checkspublic boolean release() throws IllegalArgumentException, IllegalOperationException
IOTransaction
IOObject
. A new lock must be retrieved when new modifications should be made
on this object.release
in interface IOTransaction
IllegalOperationException
- if this user is not authorized to perform this actionIllegalArgumentException
public Section getParent() throws PersistentStoreException, NoSuchObjectException
Section
getParent
in interface Section
getParent
in class SectionImpl
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic void setParent(Section parent)
SectionTransaction
setParent
in interface SectionTransaction
parent
- the parent of this sectionpublic void setOwnerPublicationId(int pubId)
IOTransaction
setOwnerPublicationId
in interface IOTransaction
setOwnerPublicationId
in class IOObjectImpl
pubId
- the idpublic void setName(String name) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setName
in interface SectionTransaction
name
- the name of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic void setUniqueName(String name) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setUniqueName
in interface SectionTransaction
name
- the unique name of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic void setType(int type) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setType
in interface SectionTransaction
type
- the type of sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existType
public void setDirectoryName(String pNewDirectoryName) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setDirectoryName
in interface SectionTransaction
pNewDirectoryName
- 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 existpublic void setCreationDate(Timestamp x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setCreationDate
in interface SectionTransaction
x
- 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
public void setState(int x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
TypeManager.getType(neo.xredsys.api.Type)
method.setState
in interface SectionTransaction
x
- the state of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic void setKeyword(String x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setKeyword
in interface SectionTransaction
x
- the keyword of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic void setPublishDate(Timestamp x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setPublishDate
in interface SectionTransaction
x
- 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
public void setLastModified(Timestamp x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setLastModified
in interface SectionTransaction
x
- 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 existpublic void setFirstPublished(Timestamp x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setFirstPublished
in interface SectionTransaction
x
- 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 existpublic void setLayoutId(int x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setLayoutId
in interface SectionTransaction
x
- 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 existpublic void setArticleLayoutId(int x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setArticleLayoutId
in interface SectionTransaction
x
- 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 existpublic void setArticleLayout(Layout layout) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setArticleLayout
in interface SectionTransaction
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 existpublic void setSectionLayoutId(int x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setSectionLayoutId
in interface SectionTransaction
x
- 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 existpublic void setSectionLayout(Layout layout)
SectionTransaction
IOAtom.ID_INVALID
).setSectionLayout
in interface SectionTransaction
layout
- the section layout that will belong to this sectionpublic void setEdition(int x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setEdition
in interface SectionTransaction
x
- the edition of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic void setHtmlCache(boolean x) throws PersistentStoreException, NoSuchObjectException
public void setSectionUrl(String x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setSectionUrl
in interface SectionTransaction
x
- the url of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic void setPriority(int x) throws PersistentStoreException, NoSuchObjectException
SectionTransaction
setPriority
in interface SectionTransaction
x
- the priority of this sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existpublic void setApproveMessages(int x) throws PersistentStoreException, NoSuchObjectException
public void setAskToJoin(int x) throws PersistentStoreException, NoSuchObjectException
public void setSource(String pSource) throws PersistentStoreException
SectionTransaction
setSource
in interface SectionTransaction
pSource
- the source of this sectionPersistentStoreException
- if an error occurs in the persistence layerpublic void setSourceId(String pSourceId) throws PersistentStoreException
SectionTransaction
setSourceId
in interface SectionTransaction
pSourceId
- the source id of this sectionPersistentStoreException
- if an error occurs in the persistence layerpublic void setInheritAccess(boolean pInheritAccess)
SectionTransaction
setInheritAccess
in interface SectionTransaction
pInheritAccess
- true if this section should inherit access rights from it's parent; otherwise false.public boolean isHidden()
Section
isHidden
in interface Section
isHidden
in class SectionImpl
Boolean
public void setHidden(boolean pHidden)
SectionTransaction
setHidden
in interface SectionTransaction
pHidden
- is a Boolean
public void setVirtualSource(boolean pSource)
SectionTransaction
setVirtualSource
in interface SectionTransaction
pSource
- true if this section is source for any virtual sections; otherwise falseVirtualSection
public void setAgreementRequired(boolean agreementRequired)
SectionTransaction
setAgreementRequired
in interface SectionTransaction
agreementRequired
- true if you need an agreement to publish this section;otherwise falseAgreementInfo
public void setAgreementId(int agreementId)
SectionTransaction
setAgreementId
in interface SectionTransaction
agreementId
- the id of the agreement belonging to this sectionAgreementInfo
public String putParameter(String pName, String pValue)
SectionTransaction
putParameter
in interface SectionTransaction
pName
- The parameter namepValue
- The valueSection.getParameter(String)
public String removeParameter(String pName)
SectionTransaction
removeParameter
in interface SectionTransaction
pName
- The section parameter to be removedSection.getParameter(String)
public void setParameters(Properties pParameters)
SectionTransaction
setParameters
in interface SectionTransaction
pParameters
- The new section parameters to use for this section.Section.getParameter(String)
public void setParameters(Map<String,String> pParameters)
SectionTransaction
setParameters
in interface SectionTransaction
pParameters
- The new section parameters to use for this section.Section.getParameter(String)
public Map getDeclaredParameters()
Section
java.util.Map
containing all parameters specified in this section, disregarding any
inherited value.getDeclaredParameters
in interface Section
getDeclaredParameters
in class SectionImpl
Map
containing all parameterspublic String getDeclaredParameter(String parameterName)
Section
getDeclaredParameter
in interface Section
getDeclaredParameter
in class SectionImpl
parameterName
- name of parameter to retrievepublic Set getDeclaredParameterNameSet()
Section
getDeclaredParameterNameSet
in interface Section
getDeclaredParameterNameSet
in class SectionImpl
Set
containg all parameter names in this sectionSet
public String getParameter(String parameterName)
Section
getParameter
in interface Section
getParameter
in class SectionImpl
parameterName
- name of the parameter to retrievepublic void setId(int pId)
IOTransaction
setId
in interface IOTransaction
setId
in class IOObjectImpl
pId
- the idpublic Map getParameters()
Section
java.util.Map
containing all parameters in this section,
included inherited parameters from parent sections.getParameters
in interface Section
getParameters
in class SectionImpl
Map
containing all parameterspublic 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
getParameterNameSet
in class SectionImpl
Set
containing all parameter namespublic void setStorylineTemplates(Collection<Type> pTemplateTypes)
SectionTransaction
setStorylineTemplates
in interface SectionTransaction
pTemplateTypes
- the storyline templates to use© 1998- 2021 Escenic AS