public class WGStructEntry extends WGDocument implements java.lang.Comparable<WGStructEntry>, PageHierarchyNode
Modifier and Type | Class and Description |
---|---|
class |
WGStructEntry.ContentSet
The set of contents that belongs to one struct entry, divided up into different maps
|
class |
WGStructEntry.SessionData |
static class |
WGStructEntry.StructCache |
WGDocument.Cache, WGDocument.FakeMetaDataContext, WGDocument.SaveAction
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
EDITORS_INHERIT_AND_REDUCE
Value to place as first value in
META_CHILD_EDITORS or META_PAGE_EDITORS to inherit editor rights from the parent and further reduce it with the other values of the meta. |
static java.lang.String |
EXT_PAGE_SEQUENCE
extension data field which stores the page sequence for this document in CS Versions > 5
|
static int |
FETCHSTATE_ACTIVE_ONLY
Only active contents (non-archived) have been fetched for this struct
entry.
|
static int |
FETCHSTATE_ARCHIVED
All contents - including archived - have been fetched for this struct
entry.
|
static int |
FETCHSTATE_NONE
No content has yet been fetched for this struct entry.
|
static java.lang.String |
META_ALLOWED_CHILDTYPES |
static java.lang.String |
META_AREA |
static java.lang.String |
META_CHILD_EDITORS |
static java.lang.String |
META_CHILDPAGERESTRICTIONS |
static java.lang.String |
META_CONTENTTYPE |
static java.lang.String |
META_KEY |
static java.lang.String |
META_PAGE_EDITORS |
static java.lang.String |
META_PAGESEQUENCE |
static java.lang.String |
META_POSITION |
static java.lang.String |
META_PUBLISHED |
static java.lang.String |
META_READERS |
static java.lang.String |
META_TITLE |
static java.lang.String |
META_UNIQUENAME |
static java.lang.String |
META_WORKFLOW_NAME |
static MetaInfo |
METAINFO_ALLOWED_CHILDTYPES |
static MetaInfo |
METAINFO_AREA |
static MetaInfo |
METAINFO_CHILD_EDITORS |
static MetaInfo |
METAINFO_CHILDPAGERESTRICTIONS |
static MetaInfo |
METAINFO_CONTENTTYPE |
static MetaInfo |
METAINFO_KEY |
static MetaInfo |
METAINFO_PAGE_EDITORS |
static MetaInfo |
METAINFO_PAGESEQUENCE |
static MetaInfo |
METAINFO_POSITION |
static MetaInfo |
METAINFO_PUBLISHED |
static MetaInfo |
METAINFO_READERS |
static MetaInfo |
METAINFO_TITLE |
static MetaInfo |
METAINFO_UNIQUENAME |
static MetaInfo |
METAINFO_WORKFLOW_NAME |
CSFEATURE_EXTDATA, DERIVATE_NAME_PATTERN, DOCKEY_DIVIDER, EXT_PRIMARY_ATTACHMENT, EXTDATA_META_PREFIX, META_CREATED, META_LASTMODIFIED, META_PASTAUTHORS, META_PASTEDITDATES, META_REVISION, METAINFO_CREATED, METAINFO_LASTMODIFIED, METAINFO_PASTAUTHORS, METAINFO_PASTEDITDATES, METAINFO_REVISION, NOONE_ALLOWED, PAGERESTRICTION_ANY, PAGERESTRICTION_FIXEDTYPES, PAGERESTRICTION_NONE, PAGERESTRICTION_UNSPECIFIED, TYPE_ACLENTRY, TYPE_AREA, TYPE_CONTENT, TYPE_CONTENTTYPE, TYPE_CSSJS, TYPE_DBMETADATA, TYPE_FILECONTAINER, TYPE_FILEDERIVATE, TYPE_LANGUAGE, TYPE_STRUCTENTRY, TYPE_TML, TYPE_USERPROFILE, TYPENAME_ACLENTRY, TYPENAME_AREA, TYPENAME_CONTENT, TYPENAME_CONTENTTYPE, TYPENAME_CSSJS, TYPENAME_DBMETADATA, TYPENAME_FILECONTAINER, TYPENAME_FILEDERIVATE, TYPENAME_LANGUAGE, TYPENAME_STRUCTENTRY, TYPENAME_TML, TYPENAME_USERPROFILE
Constructor and Description |
---|
WGStructEntry(WGDatabase db,
WGDocumentCore doc)
Constructor.
|
WGStructEntry(WGDatabase wgDatabase,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags) |
Modifier and Type | Method and Description |
---|---|
void |
changeContentType(WGContentType contentType)
Change the content type for this struct entry and all its contents.
|
int |
compareTo(WGStructEntry otherEntry)
Compares two struct entries.
|
WGStructEntry |
createChildEntry(WGContentType contentType,
java.lang.String title)
Create a child struct entry
|
WGContent |
createChildPage(WGContentType contentType,
java.lang.String title,
java.lang.String language)
Creates a new child page, including struct entry and content.
|
WGDocument |
createClone(WGDatabase db,
WGDocument ref)
Creates a clone of this document in another database
|
WGContent |
createContent(java.lang.String title)
Creates a new content for this struct entry, using the default language of the database.
|
WGContent |
createContent(java.lang.String language,
java.lang.String title)
Create a content document under this struct entry.
|
WGContent |
createContent(WGLanguage language,
java.lang.String title)
Create a content document under this struct entry.
|
void |
createPageSequence() |
void |
createPageSequence(boolean forceCreate) |
WGContentList |
getAllContent()
Returns all active (non-archived) content under this struct entry.
|
WGContentList |
getAllContent(boolean includeArchived)
Returns all content documents under this struct entry
|
java.util.List<java.lang.String> |
getAllowedChildTypes()
Returns the allowed content types for child pages of this struct.
|
java.util.Map |
getAllReleasedContent()
Returns all released content documents under this struct entry, keyed by
their language code.
|
java.util.List<WGContent> |
getArchivedContent(java.lang.String language)
Returns the archived contents for one language, as list in the order of their version numbers.
|
WGArea |
getArea()
Returns the area of this struct entry
|
java.lang.String |
getBranchWorkflow()
Returns a workflow that was set to be used on this page and all subpages that themselves do not redefine the workflow.
|
java.util.List<java.lang.String> |
getChildEditors()
Returns the editors allowed to edit child entries and content of this
struct entry
|
WGStructEntryList |
getChildEntries()
Returns the child entries of this struct entry
|
WGStructEntryList |
getChildEntries(int offset,
int size)
Returns a partial list of the child entries of this struct entry
|
int |
getChildEntryCount()
Returns the number of child entries without actually retrieving them.
|
WGStructEntryIterator |
getChildEntryIterator(int pageSize)
Returns an iterator over the child entries of this struct entry
Internally the iterator fetches multiple entities at once from the backend for more performant backend retrieval processes.
|
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
getChildNodeIterator(int pageSize)
Returns an iterator for the child nodes of this hierarchy node
|
java.util.List |
getChildNodes()
Returns the child nodes of this hierarchy node
|
java.lang.Class |
getChildNodeType()
Return the class type of child nodes
|
java.lang.String |
getChildPageRestrictions()
Returns the restrictions regarding childpages of this struct.
|
WGContent |
getContent(java.lang.String language,
int version)
Returns a specific content of the given language and content version
|
WGContent |
getContent(java.lang.String language,
java.lang.String status)
Returns a content of the given language and status, if any exists.
|
int |
getContentCount()
Returns the number of content documents in any status or language, that are located at this struct entry.
|
int |
getContentFetchState()
Returns the fetch state for content of this structentry as constant
FETCHSTATE_...
|
WGStructEntry.ContentSet |
getContentSet(boolean includeArchived)
Returns the set of contents for the current WGStructEntry
|
WGContentType |
getContentType()
Returns the content type for this struct entry
|
java.util.List<java.lang.String> |
getEffectiveAllowedChildTypes()
Returns the allowed content types for child pages of this struct that are actually effective.
|
java.util.List<java.lang.String> |
getEffectiveChildEditors()
Returns the list of currently effective child editors.
|
java.lang.String |
getEffectiveChildPageRestrictions()
Returns the effective restrictions regarding childpages of this struct.
|
java.util.List<java.lang.String> |
getEffectivePageEditors()
Returns the list of currently effective page editors.
|
java.util.List<java.lang.String> |
getEffectiveReaders()
Returns the list of currently effective readers.
|
WGTMLModule |
getInnerLayout(java.lang.String mediaKey)
Returns the inner layout for this struct entry.
|
java.lang.Integer |
getLevel()
Returns the child level of this entry. 1 is root.
|
java.lang.String |
getLocalWorkflowName()
Returns the name of the workflow explicitly set for the current struct entry.
|
WGStructEntry |
getNextSibling()
Returns the next sibling by siblings index.
|
java.lang.String |
getNodeKey()
Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.
|
java.lang.String |
getNodeTitle(java.lang.String language)
Returns the display title for the node.
|
WGStructEntryList |
getOrderedChildEntries(int offset,
int size,
java.lang.String orderExpression)
Returns a partial list of the child entries of this struct entry, ordered by a special order expression
|
WGStructEntryList |
getOrderedChildEntries(java.lang.String orderExpression)
Returns a list of all child entries of this struct entry, ordered by a special order expression
|
WGStructEntryIterator |
getOrderedChildEntryIterator(int pageSize,
java.lang.String pageOrder)
Returns an iterator over the child entries of this struct entry, returned in a particular order
Internally the iterator fetches multiple entities at once from the backend for more performant backend retrieval processes.
|
WGStructEntryIterator |
getOrderedSiblingEntryIterator(int pageSize,
java.lang.String orderExpression)
Gets an struct entry iterator for the sibling entries (including the current struct entry), ordered by a given order expression
|
WGTMLModule |
getOuterLayout(java.lang.String mediaKey)
Returns the outer layout for this struct entry.
|
java.util.List<java.lang.String> |
getPageEditors()
Returns a list of names that are allowed to edit this struct document and
it's contents.
|
long |
getPageSequence() |
WGStructEntry |
getParentEntry()
Returns the parent entry, null if this is a root entry.
|
Lockable |
getParentLockable()
returns the parent lockable of this lockable for e.g.
|
PageHierarchyNode |
getParentNode()
Return the parent of this node in hierarchy.
|
java.lang.Number |
getPosition()
Returns the position number.
|
java.util.List |
getPositionPath()
Returns a path of position numbers for all ancestors of the current struct entry
|
WGStructEntry |
getPreviousSibling()
Returns the previous sibling by siblings index
|
java.util.Map<java.lang.String,java.util.Date> |
getPublished()
Returns the dates when this page was first published in its available languages
The returned map is keyed by language codes.
|
java.util.List<java.lang.String> |
getReaders()
Returns a list of allowed readers of contents on this struct entry.
|
WGDocument |
getReadProtectionCause()
Tests if the current user may read contents on this page and below, and if so returns the document whose settings prohibit it.
|
WGContent |
getReleasedContent(java.lang.String strLanguage)
Returns the released content of the given language
|
WGStructEntry |
getRootEntry()
Returns the root entry of this entry
|
WGStructEntryList |
getSiblingEntries()
Gets the sibling entries (including the current struct entry)
|
WGStructEntryIterator |
getSiblingEntryIterator(int pageSize)
Gets an struct entry iterator for the sibling entries (including the current struct entry)
|
int |
getSiblingIndex()
Returns the index of the current struct entry in the list of it's siblings
|
java.util.List |
getStructEditors()
Deprecated.
|
java.lang.Object |
getStructKey()
Returns the struct key.
|
java.lang.String |
getStructKeyPath()
Returns a path consisting of the structkeys from root entry to this
entry, divided by slashes.
|
java.lang.String |
getTitle()
Returns the title of the struct entry.
|
java.lang.String |
getTitlePath()
Returns a path consisting of the entry titles from root entry to this
entry, divided by slashes This information can be used as an easy
reference for the position of this entry in the area's hierarchy
|
int |
getType()
Returns the type of this document as constant WGDocument.TYPE_...
|
java.lang.String |
getUniqueName()
Returns the unique name of this struct entry, null if there is none
|
java.lang.String |
getWorkflowName()
Returns the name of the workflow that is effective on this struct entry.
|
boolean |
hasChildren()
Determines if this entry has child entries
|
boolean |
hasContent(java.lang.String strLanguage,
java.lang.String strStatus)
Tests if struct entry has content in given language code / status, even if the user doesn't have the authorisation to read it.
|
boolean |
hasReleasedContent(java.lang.String strLanguage)
Tests if this entry has an released content for the given language.
|
void |
initializePagePublished(WGStructEntry source)
Initializes empty published fields on page level by the first released content versions' creation date
This is a tool method that can be used to init given published field from non CS5 sources, on migration for example.
|
boolean |
isActive()
Determines if this page is already "active", i.e. it contains contents that are no more in draft state or child pages
|
boolean |
isDescendantOf(WGDocument doc)
Determines if this struct entry is a descendant of the given document, i.e.
|
boolean |
isDifferentParent(WGStructEntry clone)
Tests if this struct entry has a different parent than the given clone.
|
boolean |
isPublic()
Tests if this page branch is publicly accessible, i.e. anyone can generally read its content
|
boolean |
isRoot()
Determines if this entry is a root entry
|
boolean |
mayCreateContent(WGLanguage lang)
Test if user may create content in a given language
|
boolean |
mayEditChildPages()
Tests if the current user generally may edit child pages of this page, according to the hierarchical access rights.
|
WGDocument |
mayEditChildren()
Deprecated.
Because of counter-intuitive return values. Use
mayEditChildPages() |
WGDocument |
mayEditEntryAndContent()
Deprecated.
Because of counter-intuitive return values. Use
performChildCreationCheck() or mayEditChildPages() |
boolean |
mayEditPage()
Tests if the current user generally may edit this struct entry and it's contents, according to the hierarchical access rights.
|
boolean |
mayPushExtData(java.lang.String extName)
checks if extension data may be "pushed".
|
boolean |
mayReadContent()
Tests if the current user may read contents on this page and below
|
boolean |
maySave()
Tests if the current user is allowed to save the current document
For getting more details about failure reasons for save checks see
WGDocument.performSaveCheck() |
void |
performChildCreationCheck()
Performs a check if the current user generally create child pages of this page, according to the hierarchical access rights.
|
void |
performChildCreationCheck(WGContentType ct)
Checks if the current user may create a new child struct entry of the given content type.
|
void |
performChildPageCreationCheck(WGContentType ct,
WGLanguage lang)
Checks if the current user may create a new child page with the given data.
|
void |
performEditPageCheck()
Tests if the current user generally may edit this struct entry and it's contents, according to the hierarchical access rights.
|
void |
performReadProtectionCheck() |
void |
performSaveCheck()
Performs a validation for saving the document at the current state, just like it actually was saved.
|
void |
performSubtreeModificationCheck()
Tests if the current user may modify each document of the current pages subtree.
|
void |
pushData(WGDocument doc)
Pushed the data of this document to another document of the same type.
|
boolean |
save(java.util.Date lastModified)
Saves the current document with it's modifications.
|
void |
setAllowedChildTypes(java.util.List<java.lang.String> types)
Sets the allowed content types for child pages of this struct.
|
void |
setBranchWorkflow(java.lang.String wfName)
Sets a workflow to use on this page and all subpages that themselves do not redefine the workflow.
|
boolean |
setChildEditors(java.util.List editors)
Sets allowed editors for child entries and their content (if they inherit
their editing rights)
|
void |
setChildPageRestrictions(java.lang.String childPages)
Sets the restrictions regarding childpages of this struct.
|
void |
setPageEditors(java.util.List editors)
Sets names that are allowed to edit this struct and it's contents.
|
boolean |
setPosition(int pos)
Sets the position number.
|
boolean |
setReaders(java.util.List list)
Sets the allowed readers for this struct entry.
|
boolean |
setStructEditors(java.util.List editors)
Deprecated.
|
boolean |
setTitle(java.lang.String title)
Sets the struct title.
|
void |
setUniqueName(java.lang.String name)
Sets the unique name of this struct entry
|
boolean |
setWorkflowName(java.lang.String wfname)
Deprecated.
Assymetric to
getWorkflowName() and thus irritating. Use setBranchWorkflow(String) instead. |
void |
visit(WGPageVisitor visitor)
Implements the visitor pattern on the page hierarchy branch of this struct entry.
|
afterSave, attachAllFiles, attachAllFiles, attachFile, attachFile, attachFile, attachFileWithoutAnnotation, attachFileWithoutAnnotation, autoSave, buildDocumentKey, createFileDerivate, createFileDerivate, docTypeClassToNumber, doctypeNameToNumber, doctypeNumberToClass, doctypeNumberToName, dropCache, dropCore, equals, evaluateExpression, getCore, getCoreRetrieved, getCreated, getDatabase, getDocumentKey, getDocumentKeyObj, getExpectedMetaClass, getExtdataMetaName, getExtensionData, getExtensionDataNames, getFileData, getFileDerivateData, getFileDerivateMetaData, getFileDerivates, getFileLastModified, getFileMetaData, getFileMimeType, getFileMimeTypes, getFileNames, getFileParent, getFileSize, getFileText, getFileText, getItemDate, getItemNames, getItemNumber, getItemText, getItemValue, getItemValueList, getLastModified, getLastUpdates, getLockStatus, getLockStatus, getMetaData, getMetaDataList, getMetaInfo, getMetaInfoByType, getMetaNames, getName, getNativeObject, getObjectCreated, getPastAuthors, getPastEditDates, getPersistentStore, getPrimaryFileName, getRevision, hasFile, hasFileMetadata, hashCode, hasItem, innerAttachFile, isCachingEnabled, isCoreRetrieved, isDeleted, isDeleted, isDummy, isEdited, isListMeta, isSaved, isTemporary, lock, lock, markEdited, markMetaDataModified, mayRemove, mayRemove, performRemoveCheck, performRemoveCheck, remove, removeAllExtensionData, removeAllFiles, removeAllItems, removeExtensionData, removeFile, removeFileDerivate, removeItem, renameFile, resultIsFalse, resultIsTrue, save, saveQuiet, saveWithGivenTimestamps, setCachingEnabled, setItem, setItems, setItemValue, setMeta, setMetaData, setMetas, setMetaToDefault, setPrimaryFileName, setValues, unlock, unlock, validateMetas, validateMetas, writeExtensionData, writeFileDerivateMetaData
public static final java.lang.String EDITORS_INHERIT_AND_REDUCE
META_CHILD_EDITORS
or META_PAGE_EDITORS
to inherit editor rights from the parent and further reduce it with the other values of the meta.
This effectively simulates the behaviour of META_READERS
for these metadata fields where it is only possible to further reduce rights down the hierarchy and impossible to loosen them.public static final java.lang.String EXT_PAGE_SEQUENCE
public static final java.lang.String META_KEY
public static final MetaInfo METAINFO_KEY
public static final java.lang.String META_TITLE
public static final java.lang.String META_UNIQUENAME
public static final MetaInfo METAINFO_TITLE
public static final java.lang.String META_AREA
public static final MetaInfo METAINFO_AREA
public static final java.lang.String META_POSITION
public static final MetaInfo METAINFO_POSITION
public static final java.lang.String META_CONTENTTYPE
public static final MetaInfo METAINFO_CONTENTTYPE
public static final java.lang.String META_READERS
public static final MetaInfo METAINFO_READERS
public static final java.lang.String META_PAGE_EDITORS
public static final MetaInfo METAINFO_PAGE_EDITORS
public static final java.lang.String META_CHILD_EDITORS
public static final MetaInfo METAINFO_CHILD_EDITORS
public static final java.lang.String META_WORKFLOW_NAME
public static final MetaInfo METAINFO_WORKFLOW_NAME
public static final MetaInfo METAINFO_UNIQUENAME
public static final java.lang.String META_PUBLISHED
public static final MetaInfo METAINFO_PUBLISHED
public static final java.lang.String META_CHILDPAGERESTRICTIONS
public static final MetaInfo METAINFO_CHILDPAGERESTRICTIONS
public static final java.lang.String META_ALLOWED_CHILDTYPES
public static final MetaInfo METAINFO_ALLOWED_CHILDTYPES
public static final java.lang.String META_PAGESEQUENCE
public static final MetaInfo METAINFO_PAGESEQUENCE
public static final int FETCHSTATE_NONE
public static final int FETCHSTATE_ACTIVE_ONLY
public static final int FETCHSTATE_ARCHIVED
public WGStructEntry(WGDatabase db, WGDocumentCore doc) throws WGAPIException
db
- doc
- WGAPIException
public WGStructEntry(WGDatabase wgDatabase, WGDocumentCore doc, de.innovationgate.webgate.api.WGDocumentObjectFlags flags) throws WGAPIException
WGAPIException
public boolean isRoot() throws WGAPIException
WGAPIException
public boolean setChildEditors(java.util.List editors) throws WGAPIException
editors
- WGAPIException
public void setPageEditors(java.util.List editors) throws WGAPIException
editors
- WGAPIException
public boolean setStructEditors(java.util.List editors) throws WGAPIException
setPageEditors(List)
. Avoid in new developments.editors
- WGAPIException
public boolean hasChildren() throws WGAPIException
WGAPIException
public java.util.List<java.lang.String> getPageEditors() throws WGAPIException
WGAPIException
public java.lang.String getLocalWorkflowName() throws WGAPIException
WGAPIException
public java.util.List getStructEditors() throws WGAPIException
getPageEditors()
. Avoid in new developments.WGAPIException
public java.util.List<java.lang.String> getChildEditors() throws WGAPIException
WGAPIException
public WGStructEntry getParentEntry() throws WGAPIException
WGAPIException
public WGArea getArea() throws WGAPIException
WGAPIException
public WGStructEntryList getSiblingEntries() throws WGAPIException
WGAPIException
public WGStructEntryIterator getSiblingEntryIterator(int pageSize) throws WGAPIException
pageSize
- The size of retrieval pagesWGAPIException
public WGStructEntryIterator getOrderedSiblingEntryIterator(int pageSize, java.lang.String orderExpression) throws WGAPIException
pageSize
- The size of retrieval pagesorderExpression
- Column set expression determining the order in which to return pagesWGAPIException
public WGStructEntry getRootEntry() throws WGAPIException
WGAPIException
public java.lang.Number getPosition() throws WGAPIException
WGAPIException
public java.util.List getPositionPath() throws WGAPIException
WGAPIException
public boolean setPosition(int pos) throws WGAPIException
pos
- WGAPIException
public WGStructEntryList getChildEntries() throws WGAPIException
WGAPIException
public WGStructEntryIterator getChildEntryIterator(int pageSize) throws WGAPIException
pageSize
- The size of retrieval pagesWGAPIException
public WGStructEntryList getChildEntries(int offset, int size) throws WGAPIException
offset
- The offset of the first entry to retrieve, 0 being the first onesize
- The number of entries to retrieveWGAPIException
public WGStructEntryIterator getOrderedChildEntryIterator(int pageSize, java.lang.String pageOrder) throws WGAPIException
pageSize
- The size of retrieval pagespageOrder
- Order expression denoting the order in which pages should be returnedWGAPIException
public WGStructEntryList getOrderedChildEntries(int offset, int size, java.lang.String orderExpression) throws WGAPIException
offset
- The offset of the first entry to retrieve, 0 being the first onesize
- The number of entries to retrieveorderExpression
- Page order set expressionWGAPIException
public WGStructEntryList getOrderedChildEntries(java.lang.String orderExpression) throws WGAPIException
orderExpression
- Page order set expressionWGAPIException
public WGContentList getAllContent(boolean includeArchived) throws WGAPIException
includeArchived
- Specify true to also include archived documents in result.WGAPIException
public WGContentList getAllContent() throws WGAPIException
WGAPIException
public WGContent getContent(java.lang.String language, int version) throws WGAPIException
language
- version
- WGAPIException
public WGContent getContent(java.lang.String language, java.lang.String status) throws WGAPIException
language
- The language of the contentstatus
- The workflow status of the contentWGAPIException
public java.lang.String getTitle() throws WGAPIException
WGAPIException
public boolean setTitle(java.lang.String title) throws WGAPIException
title
- WGAPIException
public java.lang.String getWorkflowName() throws WGAPIException
setWorkflowName(String)
as it does not just return a workflow that is stored on this concrete struct.
Instead it really determines the workflow active for this page, either from a workflow stored on this struct, stored on some parent struct
or on the content type.WGAPIException
public boolean setWorkflowName(java.lang.String wfname) throws WGAPIException
getWorkflowName()
and thus irritating. Use setBranchWorkflow(String)
instead.wfname
- The workflow name to setWGAPIException
public void setBranchWorkflow(java.lang.String wfName) throws WGAPIException
wfName
- Name of the workflowWGAPIException
public java.lang.String getBranchWorkflow() throws WGAPIException
WGAPIException
public WGContentType getContentType() throws WGAPIException
WGAPIException
public void changeContentType(WGContentType contentType) throws WGAPIException
contentType
- The content type to setWGAPIException
public WGTMLModule getInnerLayout(java.lang.String mediaKey) throws WGAPIException
mediaKey
- The media key of the desired layoutWGAPIException
public WGTMLModule getOuterLayout(java.lang.String mediaKey) throws WGAPIException
mediaKey
- The media key of the desired layoutWGAPIException
public int compareTo(WGStructEntry otherEntry) throws java.lang.ClassCastException
compareTo
in interface java.lang.Comparable<WGStructEntry>
WGAPIException
java.lang.ClassCastException
public java.lang.Integer getLevel() throws WGAPIException
WGAPIException
public java.lang.Object getStructKey()
public WGContent getReleasedContent(java.lang.String strLanguage) throws WGAPIException
strLanguage
- WGAPIException
public boolean hasReleasedContent(java.lang.String strLanguage) throws WGAPIException
strLanguage
- The language to testWGAPIException
public boolean hasContent(java.lang.String strLanguage, java.lang.String strStatus) throws WGAPIException
WGAPIException
public int getContentCount() throws WGAPIException
WGAPIException
public java.util.Map getAllReleasedContent() throws WGAPIException
WGAPIException
public WGStructEntry getNextSibling() throws WGAPIException
WGAPIException
public WGStructEntry getPreviousSibling() throws WGAPIException
WGAPIException
public WGDocument mayEditEntryAndContent() throws WGAPIException
performChildCreationCheck()
or mayEditChildPages()
WGAPIException
public boolean mayCreateContent(WGLanguage lang) throws WGAPIException
lang
- WGAPIException
public void performEditPageCheck() throws WGAPIException
WGAPIException
public boolean mayEditPage() throws WGBackendException
WGBackendException
public void performSubtreeModificationCheck() throws WGAPIException, WGAuthorisationException
WGAuthorisationException
if he does not, holding detail information about the cause.public WGDocument getReadProtectionCause() throws WGAPIException
WGAPIException
public void performReadProtectionCheck() throws WGAPIException
WGAPIException
public boolean isPublic() throws WGAPIException
WGAPIException
public boolean mayReadContent() throws WGAPIException
WGAPIException
public WGDocument mayEditChildren() throws WGAPIException
mayEditChildPages()
WGAPIException
public boolean mayEditChildPages() throws WGAPIException
WGAPIException
public void performChildCreationCheck() throws WGAPIException
WGAPIException
public WGStructEntry createChildEntry(WGContentType contentType, java.lang.String title) throws WGAPIException
contentType
- Content type for new entrytitle
- Title of new entryWGAPIException
public WGContent createContent(WGLanguage language, java.lang.String title) throws WGAPIException
language
- The language for the contenttitle
- The title of the contentWGAPIException
public WGContent createContent(java.lang.String language, java.lang.String title) throws WGAPIException
language
- The language for the contenttitle
- The title of the contentWGAPIException
public WGContent createContent(java.lang.String title) throws WGAPIException
title
- The title of the new contentWGAPIException
public WGDocument createClone(WGDatabase db, WGDocument ref) throws WGAPIException
WGDocument
createClone
in class WGDocument
db
- The target databaseref
- A reference document in the target database. For struct
entries, this is the parent entry in the target db. For
contents this is the struct entry in the target db.WGAPIException
public void pushData(WGDocument doc) throws WGAPIException
WGDocument
pushData
in class WGDocument
doc
- The target document receiving the data.WGAPIException
- If something goes wrongpublic boolean mayPushExtData(java.lang.String extName)
WGDocument
mayPushExtData
in class WGDocument
public void initializePagePublished(WGStructEntry source) throws WGAPIException
source
- The source page whose contents should be used to init the published dates. This may be the current page but also a diffent one (migration, sync).WGAPIException
public boolean isDifferentParent(WGStructEntry clone) throws WGAPIException
clone
- The struct entry cloneWGAPIException
public boolean isActive() throws WGAPIException
WGAPIException
public boolean save(java.util.Date lastModified) throws WGAPIException
WGDocument
save
in class WGDocument
lastModified
- Date of last modification to set (if this is supported by the implementation)WGAuthorisationException
LockException
- - instance of ResourceIsLockedException if a process try to modifiy a locked object without obtaining a lockWGSystemException
WGIllegalArgumentException
WGAPIException
public boolean maySave() throws WGAPIException
WGDocument
WGDocument.performSaveCheck()
maySave
in class WGDocument
WGAPIException
public void performSaveCheck() throws WGAPIException, WGAuthorisationException
WGDocument
WGAuthorisationException
is thrown.
For checking saving permissions without catching an exception see WGDocument.maySave()
.performSaveCheck
in class WGDocument
WGAPIException
WGAuthorisationException
public int getContentFetchState()
public java.lang.String getStructKeyPath() throws WGAPIException
WGAPIException
public java.lang.String getTitlePath() throws WGAPIException
WGAPIException
public boolean isDescendantOf(WGDocument doc) throws WGAPIException
doc
- The document that may be a descendant. Allows WGStructEntry
and WGArea
type documentsWGAPIException
public Lockable getParentLockable() throws WGAPIException
Lockable
getParentLockable
in interface Lockable
getParentLockable
in class WGDocument
WGAPIException
public WGStructEntry.ContentSet getContentSet(boolean includeArchived) throws WGAPIException
includeArchived
- Set true to also retrieve archived contentsWGAPIException
public int getSiblingIndex() throws WGAPIException
WGAPIException
public java.lang.Class getChildNodeType()
PageHierarchyNode
getChildNodeType
in interface PageHierarchyNode
public java.util.List getChildNodes() throws WGAPIException
PageHierarchyNode
getChildNodes
in interface PageHierarchyNode
WGAPIException
public de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> getChildNodeIterator(int pageSize) throws WGAPIException
PageHierarchyNode
getChildNodeIterator
in interface PageHierarchyNode
pageSize
- The size of a fetch page, if the implementation fetches childnodes page-wiseWGAPIException
public java.lang.String getNodeKey() throws WGAPIException
PageHierarchyNode
getNodeKey
in interface PageHierarchyNode
WGAPIException
public java.lang.String getNodeTitle(java.lang.String language) throws WGAPIException
PageHierarchyNode
getNodeTitle
in interface PageHierarchyNode
language
- The language whose title is wantedWGAPIException
public PageHierarchyNode getParentNode() throws WGAPIException
PageHierarchyNode
getParentNode
in interface PageHierarchyNode
WGAPIException
public java.util.List<WGContent> getArchivedContent(java.lang.String language) throws WGAPIException
language
- The language to retrieve archived contents forWGAPIException
public java.lang.String getUniqueName() throws WGAPIException
WGAPIException
public void setUniqueName(java.lang.String name) throws WGAPIException
WGAPIException
public java.util.Map<java.lang.String,java.util.Date> getPublished() throws WGAPIException
WGAPIException
public void visit(WGPageVisitor visitor) throws WGAPIException
visitor
- WGAPIException
public void performChildCreationCheck(WGContentType ct) throws WGAPIException
ct
- The content type to use.WGAPIException
- @throws WGAPIException If the user may not create the document. The exception informs about the reason.public void performChildPageCreationCheck(WGContentType ct, WGLanguage lang) throws WGAPIException
ct
- The content type to use for the struct entrylang
- The language to use for the contentWGAPIException
- If the user may not create the document. The exception informs about the reason.public WGContent createChildPage(WGContentType contentType, java.lang.String title, java.lang.String language) throws WGAPIException
contentType
- The content type of the pagetitle
- The title of the page that will be used for both struct entrylanguage
- The language of the content to create. Leave null to use databases default language.WGAPIException
public int getType()
WGDocument
getType
in class WGDocument
public java.util.List<java.lang.String> getReaders() throws WGAPIException
WGAPIException
public boolean setReaders(java.util.List list) throws WGAPIException
list
- WGAPIException
public java.util.List<java.lang.String> getEffectiveReaders() throws WGAPIException
WGAPIException
public java.util.List<java.lang.String> getEffectivePageEditors() throws WGAPIException
WGAPIException
public java.util.List<java.lang.String> getEffectiveChildEditors() throws WGAPIException
WGAPIException
public int getChildEntryCount() throws WGAPIException
WGAPIException
public java.lang.String getEffectiveChildPageRestrictions() throws WGAPIException
WGAPIException
public java.lang.String getChildPageRestrictions() throws WGAPIException
WGAPIException
public void setChildPageRestrictions(java.lang.String childPages) throws WGAPIException
childPages
- Restriction string. Use constants PAGERESTRICTION_...WGAPIException
public java.util.List<java.lang.String> getEffectiveAllowedChildTypes() throws WGAPIException
WGAPIException
public java.util.List<java.lang.String> getAllowedChildTypes() throws WGAPIException
getChildPageRestrictions()
is WGDocument.PAGERESTRICTION_FIXEDTYPES
WGAPIException
public void setAllowedChildTypes(java.util.List<java.lang.String> types) throws WGAPIException
getChildPageRestrictions()
is WGDocument.PAGERESTRICTION_FIXEDTYPES
types
- Names of content typesWGAPIException
public long getPageSequence() throws WGAPIException
WGAPIException
public void createPageSequence() throws WGAPIException, java.lang.InstantiationException, java.lang.IllegalAccessException
WGAPIException
java.lang.InstantiationException
java.lang.IllegalAccessException
public void createPageSequence(boolean forceCreate) throws WGAPIException, java.lang.InstantiationException, java.lang.IllegalAccessException
WGAPIException
java.lang.InstantiationException
java.lang.IllegalAccessException