WGStructEntry

java.lang.Object
- de.innovationgate.webgate.api.WGDocument
- - de.innovationgate.webgate.api.WGStructEntry

All Implemented Interfaces:

Lockable, MetaInfoProvider, PageHierarchyNode, WGExtensionDataContainer, WGFileMetaDataContext, java.lang.Comparable<WGStructEntry>
```
public class WGStructEntry
extends WGDocument
implements java.lang.Comparable<WGStructEntry>, PageHierarchyNode
```
A struct entry that is used to build the site hierarchy, determine the content types at the hierarchy nodes and the editing rights in the hierarchy.

Nested Class Summary

Nested Classes
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`

Nested classes/interfaces inherited from class de.innovationgate.webgate.api.WGDocument
WGDocument.Cache, WGDocument.FakeMetaDataContext, WGDocument.SaveAction

Field Summary

Fields
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 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_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_POSITION`
`static MetaInfo`	`METAINFO_PUBLISHED`
`static MetaInfo`	`METAINFO_READERS`
`static MetaInfo`	`METAINFO_TITLE`
`static MetaInfo`	`METAINFO_UNIQUENAME`
`static MetaInfo`	`METAINFO_WORKFLOW_NAME`

Fields inherited from class de.innovationgate.webgate.api.WGDocument
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 Summary

Constructors
Constructor and Description
`WGStructEntry(WGDatabase db, WGDocumentCore doc)` Constructor.
`WGStructEntry(WGDatabase wgDatabase, WGDocumentCore doc, de.innovationgate.webgate.api.WGDocumentObjectFlags flags)`

Method Summary

Methods
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.
`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.
`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`	`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.

Methods inherited from class de.innovationgate.webgate.api.WGDocument
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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EDITORS_INHERIT_AND_REDUCE
```
public static final 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. 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.
    
    See Also:
    Constant Field Values
  - META_KEY
```
public static final java.lang.String META_KEY
```
    See Also:
    Constant Field Values
  - METAINFO_KEY
```
public static final MetaInfo METAINFO_KEY
```
  - META_TITLE
```
public static final java.lang.String META_TITLE
```
    See Also:
    Constant Field Values
  - META_UNIQUENAME
```
public static final java.lang.String META_UNIQUENAME
```
    See Also:
    Constant Field Values
  - METAINFO_TITLE
```
public static final MetaInfo METAINFO_TITLE
```
  - META_AREA
```
public static final java.lang.String META_AREA
```
    See Also:
    Constant Field Values
  - METAINFO_AREA
```
public static final MetaInfo METAINFO_AREA
```
  - META_POSITION
```
public static final java.lang.String META_POSITION
```
    See Also:
    Constant Field Values
  - METAINFO_POSITION
```
public static final MetaInfo METAINFO_POSITION
```
  - META_CONTENTTYPE
```
public static final java.lang.String META_CONTENTTYPE
```
    See Also:
    Constant Field Values
  - METAINFO_CONTENTTYPE
```
public static final MetaInfo METAINFO_CONTENTTYPE
```
  - META_READERS
```
public static final java.lang.String META_READERS
```
    See Also:
    Constant Field Values
  - METAINFO_READERS
```
public static final MetaInfo METAINFO_READERS
```
  - META_PAGE_EDITORS
```
public static final java.lang.String META_PAGE_EDITORS
```
    See Also:
    Constant Field Values
  - METAINFO_PAGE_EDITORS
```
public static final MetaInfo METAINFO_PAGE_EDITORS
```
  - META_CHILD_EDITORS
```
public static final java.lang.String META_CHILD_EDITORS
```
    See Also:
    Constant Field Values
  - METAINFO_CHILD_EDITORS
```
public static final MetaInfo METAINFO_CHILD_EDITORS
```
  - META_WORKFLOW_NAME
```
public static final java.lang.String META_WORKFLOW_NAME
```
    See Also:
    Constant Field Values
  - METAINFO_WORKFLOW_NAME
```
public static final MetaInfo METAINFO_WORKFLOW_NAME
```
  - METAINFO_UNIQUENAME
```
public static final MetaInfo METAINFO_UNIQUENAME
```
  - META_PUBLISHED
```
public static final java.lang.String META_PUBLISHED
```
    See Also:
    Constant Field Values
  - METAINFO_PUBLISHED
```
public static final MetaInfo METAINFO_PUBLISHED
```
  - META_CHILDPAGERESTRICTIONS
```
public static final java.lang.String META_CHILDPAGERESTRICTIONS
```
    See Also:
    Constant Field Values
  - METAINFO_CHILDPAGERESTRICTIONS
```
public static final MetaInfo METAINFO_CHILDPAGERESTRICTIONS
```
  - META_ALLOWED_CHILDTYPES
```
public static final java.lang.String META_ALLOWED_CHILDTYPES
```
    See Also:
    Constant Field Values
  - METAINFO_ALLOWED_CHILDTYPES
```
public static final MetaInfo METAINFO_ALLOWED_CHILDTYPES
```
  - FETCHSTATE_NONE
```
public static final int FETCHSTATE_NONE
```
    No content has yet been fetched for this struct entry.
    
    See Also:
    Constant Field Values
  - FETCHSTATE_ACTIVE_ONLY
```
public static final int FETCHSTATE_ACTIVE_ONLY
```
    Only active contents (non-archived) have been fetched for this struct entry.
    
    See Also:
    Constant Field Values
  - FETCHSTATE_ARCHIVED
```
public static final int FETCHSTATE_ARCHIVED
```
    All contents - including archived - have been fetched for this struct entry.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - WGStructEntry
```
public WGStructEntry(WGDatabase db,
             WGDocumentCore doc)
              throws WGAPIException
```
    Constructor. Should not be used outside the WGAPI
    
    Parameters:
    db -
    doc -
    
    Throws:
    
    WGAPIException
  - WGStructEntry
```
public WGStructEntry(WGDatabase wgDatabase,
             WGDocumentCore doc,
             de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
              throws WGAPIException
```
    Throws:
    
    WGAPIException
- Method Detail
  - isRoot
```
public boolean isRoot()
               throws WGAPIException
```
    Determines if this entry is a root entry
    
    Throws:
    
    WGAPIException
  - setChildEditors
```
public boolean setChildEditors(java.util.List editors)
                        throws WGAPIException
```
    Sets allowed editors for child entries and their content (if they inherit their editing rights)
    
    Parameters:
    editors -
    
    Throws:
    
    WGAPIException
  - setPageEditors
```
public void setPageEditors(java.util.List editors)
                    throws WGAPIException
```
    Sets names that are allowed to edit this struct and it's contents.
    
    Parameters:
    editors -
    
    Throws:
    
    WGAPIException
  - setStructEditors
```
public boolean setStructEditors(java.util.List editors)
                         throws WGAPIException
```
    Deprecated.
    
    Old version of setPageEditors(List). Avoid in new developments.
    
    Parameters:
    editors -
    
    Throws:
    
    WGAPIException
  - hasChildren
```
public boolean hasChildren()
                    throws WGAPIException
```
    Determines if this entry has child entries
    
    Throws:
    
    WGAPIException
  - getPageEditors
```
public java.util.List<java.lang.String> getPageEditors()
                                                throws WGAPIException
```
    Returns a list of names that are allowed to edit this struct document and it's contents.
    
    Throws:
    
    WGAPIException
  - getLocalWorkflowName
```
public java.lang.String getLocalWorkflowName()
                                      throws WGAPIException
```
    Returns the name of the workflow explicitly set for the current struct entry. A value of null means that no workflow is set and this page inherits its workflow from either parent structs or the content type.
    
    Throws:
    
    WGAPIException
  - getStructEditors
```
public java.util.List getStructEditors()
                                throws WGAPIException
```
    Deprecated.
    
    Old version for getPageEditors(). Avoid in new developments.
    
    Throws:
    
    WGAPIException
  - getChildEditors
```
public java.util.List<java.lang.String> getChildEditors()
                                                 throws WGAPIException
```
    Returns the editors allowed to edit child entries and content of this struct entry
    
    Throws:
    
    WGAPIException
  - getParentEntry
```
public WGStructEntry getParentEntry()
                             throws WGAPIException
```
    Returns the parent entry, null if this is a root entry.
    
    Throws:
    
    WGAPIException
  - getArea
```
public WGArea getArea()
               throws WGAPIException
```
    Returns the area of this struct entry
    
    Throws:
    
    WGAPIException
  - getSiblingEntries
```
public WGStructEntryList getSiblingEntries()
                                    throws WGAPIException
```
    Gets the sibling entries (including the current struct entry)
    
    Throws:
    
    WGAPIException
  - getSiblingEntryIterator
```
public WGStructEntryIterator getSiblingEntryIterator(int pageSize)
                                              throws WGAPIException
```
    Gets an struct entry iterator for the sibling entries (including the current struct entry)
    
    Parameters:
    pageSize - The size of retrieval pages
    
    Throws:
    
    WGAPIException
  - getOrderedSiblingEntryIterator
```
public WGStructEntryIterator getOrderedSiblingEntryIterator(int pageSize,
                                                   java.lang.String orderExpression)
                                                     throws WGAPIException
```
    Gets an struct entry iterator for the sibling entries (including the current struct entry), ordered by a given order expression
    
    Parameters:
    pageSize - The size of retrieval pages
    orderExpression - Column set expression determining the order in which to return pages
    
    Throws:
    
    WGAPIException
  - getRootEntry
```
public WGStructEntry getRootEntry()
                           throws WGAPIException
```
    Returns the root entry of this entry
    
    Throws:
    
    WGAPIException
  - getPosition
```
public java.lang.Number getPosition()
                             throws WGAPIException
```
    Returns the position number.
    
    Throws:
    
    WGAPIException
  - getPositionPath
```
public java.util.List getPositionPath()
                               throws WGAPIException
```
    Returns a path of position numbers for all ancestors of the current struct entry
    
    Returns:
    A list of position numbers for the struct entry and all it's ancestors, beginning with the current struct entry and proceeding up the hierarchy
    
    Throws:
    
    WGAPIException
  - setPosition
```
public boolean setPosition(int pos)
                    throws WGAPIException
```
    Sets the position number.
    
    Parameters:
    pos -
    
    Throws:
    
    WGAPIException
  - getChildEntries
```
public WGStructEntryList getChildEntries()
                                  throws WGAPIException
```
    Returns the child entries of this struct entry
    
    Throws:
    
    WGAPIException
  - getChildEntryIterator
```
public WGStructEntryIterator getChildEntryIterator(int pageSize)
                                            throws WGAPIException
```
    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. The size of those rertrieval pages must be determined as argument..
    
    Parameters:
    pageSize - The size of retrieval pages
    
    Returns:
    An iterator over all child entries of this struct entry
    
    Throws:
    
    WGAPIException
  - getChildEntries
```
public WGStructEntryList getChildEntries(int offset,
                                int size)
                                  throws WGAPIException
```
    Returns a partial list of the child entries of this struct entry
    
    Parameters:
    offset - The offset of the first entry to retrieve, 0 being the first one
    size - The number of entries to retrieve
    
    Throws:
    
    WGAPIException
  - getOrderedChildEntryIterator
```
public WGStructEntryIterator getOrderedChildEntryIterator(int pageSize,
                                                 java.lang.String pageOrder)
                                                   throws WGAPIException
```
    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. The size of those retrieval pages must be determined as argument..
    
    Parameters:
    pageSize - The size of retrieval pages
    pageOrder - Order expression denoting the order in which pages should be returned
    
    Returns:
    An iterator over all child entries of this struct entry
    
    Throws:
    
    WGAPIException
  - getOrderedChildEntries
```
public WGStructEntryList getOrderedChildEntries(int offset,
                                       int size,
                                       java.lang.String orderExpression)
                                         throws WGAPIException
```
    Returns a partial list of the child entries of this struct entry, ordered by a special order expression
    
    Parameters:
    offset - The offset of the first entry to retrieve, 0 being the first one
    size - The number of entries to retrieve
    orderExpression - Page order set expression
    
    Throws:
    
    WGAPIException
  - getOrderedChildEntries
```
public WGStructEntryList getOrderedChildEntries(java.lang.String orderExpression)
                                         throws WGAPIException
```
    Returns a list of all child entries of this struct entry, ordered by a special order expression
    
    Parameters:
    orderExpression - Page order set expression
    
    Throws:
    
    WGAPIException
  - getAllContent
```
public WGContentList getAllContent(boolean includeArchived)
                            throws WGAPIException
```
    Returns all content documents under this struct entry
    
    Parameters:
    includeArchived - Specify true to also include archived documents in result.
    
    Throws:
    
    WGAPIException
  - getAllContent
```
public WGContentList getAllContent()
                            throws WGAPIException
```
    Returns all active (non-archived) content under this struct entry.
    
    Throws:
    
    WGAPIException
  - getContent
```
public WGContent getContent(java.lang.String language,
                   int version)
                     throws WGAPIException
```
    Returns a specific content of the given language and content version
    
    Parameters:
    language -
    version -
    
    Throws:
    
    WGAPIException
  - getContent
```
public WGContent getContent(java.lang.String language,
                   java.lang.String status)
                     throws WGAPIException
```
    Returns a content of the given language and status, if any exists. If multiple contents exist with these parameters a random content of that group is returned.
    
    Parameters:
    language - The language of the content
    status - The workflow status of the content
    
    Returns:
    A content with that parameters. null if none exists.
    
    Throws:
    
    WGAPIException
  - getTitle
```
public java.lang.String getTitle()
                          throws WGAPIException
```
    Returns the title of the struct entry. We prohibit this on struct entries whose contents may not be read by the current user.
    
    Throws:
    
    WGAPIException
  - setTitle
```
public boolean setTitle(java.lang.String title)
                 throws WGAPIException
```
    Sets the struct title.
    
    Parameters:
    title -
    
    Throws:
    
    WGAPIException
  - getWorkflowName
```
public java.lang.String getWorkflowName()
                                 throws WGAPIException
```
    Returns the name of the workflow that is effective on this struct entry. This method is assymetric to 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.
    
    Throws:
    
    WGAPIException
  - setWorkflowName
```
public boolean setWorkflowName(java.lang.String wfname)
                        throws WGAPIException
```
    Deprecated. Assymetric to getWorkflowName() and thus irritating. Use setBranchWorkflow(String) instead.
    
    Sets a workflow on this concrete struct entry
    
    Parameters:
    wfname - The workflow name to set
    
    Throws:
    
    WGAPIException
  - setBranchWorkflow
```
public void setBranchWorkflow(java.lang.String wfName)
                       throws WGAPIException
```
    Sets a workflow to use on this page and all subpages that themselves do not redefine the workflow.
    
    Parameters:
    wfName - Name of the workflow
    
    Throws:
    
    WGAPIException
  - getBranchWorkflow
```
public java.lang.String getBranchWorkflow()
                                   throws WGAPIException
```
    Returns a workflow that was set to be used on this page and all subpages that themselves do not redefine the workflow. Returns null if no such workflow is set on this page.
    
    Throws:
    
    WGAPIException
  - getContentType
```
public WGContentType getContentType()
                             throws WGAPIException
```
    Returns the content type for this struct entry
    
    Throws:
    
    WGAPIException
  - changeContentType
```
public void changeContentType(WGContentType contentType)
                       throws WGAPIException
```
    Change the content type for this struct entry and all its contents. This is only possible while no contents are in a approval workflow.
    
    Parameters:
    contentType - The content type to set
    
    Throws:
    
    WGAPIException
  - getInnerLayout
```
public WGTMLModule getInnerLayout(java.lang.String mediaKey)
                           throws WGAPIException
```
    Returns the inner layout for this struct entry. This may be determined by it's content type or by internal struct fields.
    
    Parameters:
    mediaKey - The media key of the desired layout
    
    Returns:
    The TML module for the layout, if it exists for this media key, null otherwise
    
    Throws:
    
    WGAPIException
  - getOuterLayout
```
public WGTMLModule getOuterLayout(java.lang.String mediaKey)
                           throws WGAPIException
```
    Returns the outer layout for this struct entry. This may be determined by it's content type or by internal struct fields.
    
    Parameters:
    mediaKey - The media key of the desired layout
    
    Returns:
    The TML module for the layout, if it exists for this media key, null otherwise
    
    Throws:
    
    WGAPIException
  - compareTo
```
public int compareTo(WGStructEntry otherEntry)
              throws java.lang.ClassCastException
```
    Compares two struct entries. Position is taken into account for higher/lower but does not result in equality when positions are equal.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<WGStructEntry>
    
    Throws:
    
    WGAPIException
    
    java.lang.ClassCastException
  - getLevel
```
public java.lang.Integer getLevel()
                           throws WGAPIException
```
    Returns the child level of this entry. 1 is root.
    
    Throws:
    
    WGAPIException
  - getStructKey
```
public java.lang.Object getStructKey()
```
    Returns the struct key.
  - getReleasedContent
```
public WGContent getReleasedContent(java.lang.String strLanguage)
                             throws WGAPIException
```
    Returns the released content of the given language
    
    Parameters:
    strLanguage -
    
    Throws:
    
    WGAPIException
  - hasReleasedContent
```
public boolean hasReleasedContent(java.lang.String strLanguage)
                           throws WGAPIException
```
    Tests if this entry has an released content for the given language. This method is capable of regarding contents that the current user is not allowed to see.
    
    Parameters:
    strLanguage - The language to test
    
    Returns:
    true, if there is a released content, false otherwise
    
    Throws:
    
    WGAPIException
  - hasContent
```
public boolean hasContent(java.lang.String strLanguage,
                 java.lang.String strStatus)
                   throws WGAPIException
```
    Tests if struct entry has content in given language code / status, even if the user doesn't have the authorisation to read it. If language code parameter is null, proves on any language code. If status parameter is null, proves on any status.
    
    Throws:
    
    WGAPIException
  - getContentCount
```
public int getContentCount()
                    throws WGAPIException
```
    Returns the number of content documents in any status or language, that are located at this struct entry. This includes content documents that are invisible to the current user because of reader settings, so this method may be used to determine the existence of such documents while they cannot be retrieved directly.
    
    Throws:
    
    WGAPIException
  - getAllReleasedContent
```
public java.util.Map getAllReleasedContent()
                                    throws WGAPIException
```
    Returns all released content documents under this struct entry, keyed by their language code.
    
    Throws:
    
    WGAPIException
  - getNextSibling
```
public WGStructEntry getNextSibling()
                             throws WGAPIException
```
    Returns the next sibling by siblings index.
    
    Throws:
    
    WGAPIException
  - getPreviousSibling
```
public WGStructEntry getPreviousSibling()
                                 throws WGAPIException
```
    Returns the previous sibling by siblings index
    
    Throws:
    
    WGAPIException
  - mayEditEntryAndContent
```
public WGDocument mayEditEntryAndContent()
                                  throws WGAPIException
```
    Deprecated. Because of counter-intuitive return values. Use performChildCreationCheck() or mayEditChildPages()
    
    Tests if the current user may edit this struct entry and it's contents.
    
    Returns:
    null, if the user may edit. If not, the WGStructEntry or WGArea object ist returned that denies editing access
    
    Throws:
    
    WGAPIException
  - mayCreateContent
```
public boolean mayCreateContent(WGLanguage lang)
                         throws WGAPIException
```
    Test if user may create content in a given language
    
    Parameters:
    lang -
    
    Returns:
    true if content creation is allowed
    
    Throws:
    
    WGAPIException
  - performEditPageCheck
```
public void performEditPageCheck()
                          throws WGAPIException
```
    Tests if the current user generally may edit this struct entry and it's contents, according to the hierarchical access rights. If so the method exits normally. Otherwise an rexception is thrown.
    
    Throws:
    
    WGAPIException
  - mayEditPage
```
public boolean mayEditPage()
                    throws WGBackendException
```
    Tests if the current user generally may edit this struct entry and it's contents, according to the hierarchical access rights.
    
    Throws:
    
    WGBackendException
  - performSubtreeModificationCheck
```
public void performSubtreeModificationCheck()
                                     throws WGAPIException,
                                            WGAuthorisationException
```
    Tests if the current user may modify each document of the current pages subtree. This is intended to be tested on operations that involve each document of a page subtree including the current one, like moving it. The method exits normally if the user may do this operation or with an WGAuthorisationException if he does not, holding detail information about the cause.
    
    Throws:
    
    WGAPIException
    
    WGAuthorisationException
  - getReadProtectionCause
```
public WGDocument getReadProtectionCause()
                                  throws WGAPIException
```
    Tests if the current user may read contents on this page and below, and if so returns the document whose settings prohibit it.
    
    Returns:
    null, if the user may read. If not, the WGStructEntry or WGArea object ist returned that denies reading access
    
    Throws:
    
    WGAPIException
  - performReadProtectionCheck
```
public void performReadProtectionCheck()
                                throws WGAPIException
```
    Throws:
    
    WGAPIException
  - isPublic
```
public boolean isPublic()
                 throws WGAPIException
```
    Tests if this page branch is publicly accessible, i.e. anyone can generally read its content
    
    Throws:
    
    WGAPIException
  - mayReadContent
```
public boolean mayReadContent()
                       throws WGAPIException
```
    Tests if the current user may read contents on this page and below
    
    Returns:
    true if the user may, false if not
    
    Throws:
    
    WGAPIException
  - mayEditChildren
```
public WGDocument mayEditChildren()
                           throws WGAPIException
```
    Deprecated. Because of counter-intuitive return values. Use mayEditChildPages()
    
    Tests if the current user may edit child entries and their contents.
    
    Returns:
    null, if the user may edit. If not, the WGStructEntry or WGArea object is returned that denies editing access
    
    Throws:
    
    WGAPIException
  - mayEditChildPages
```
public boolean mayEditChildPages()
                          throws WGAPIException
```
    Tests if the current user generally may edit child pages of this page, according to the hierarchical access rights.
    
    Throws:
    
    WGAPIException
  - performChildCreationCheck
```
public void performChildCreationCheck()
                               throws WGAPIException
```
    Performs a check if the current user generally create child pages of this page, according to the hierarchical access rights. Runs through if he may, throws an exception otherwise, identifying the cause of restriction.
    
    Throws:
    
    WGAPIException
  - createChildEntry
```
public WGStructEntry createChildEntry(WGContentType contentType,
                             java.lang.String title)
                               throws WGAPIException
```
    Create a child struct entry
    
    Parameters:
    contentType - Content type for new entry
    title - Title of new entry
    
    Returns:
    The newly created entry
    
    Throws:
    
    WGAPIException
  - createContent
```
public WGContent createContent(WGLanguage language,
                      java.lang.String title)
                        throws WGAPIException
```
    Create a content document under this struct entry.
    
    Parameters:
    language - The language for the content
    title - The title of the content
    
    Returns:
    The newly created content
    
    Throws:
    
    WGAPIException
  - createContent
```
public WGContent createContent(java.lang.String language,
                      java.lang.String title)
                        throws WGAPIException
```
    Create a content document under this struct entry.
    
    Parameters:
    language - The language for the content
    title - The title of the content
    
    Returns:
    The newly created content
    
    Throws:
    
    WGAPIException
  - createContent
```
public WGContent createContent(java.lang.String title)
                        throws WGAPIException
```
    Creates a new content for this struct entry, using the default language of the database.
    
    Parameters:
    title - The title of the new content
    
    Returns:
    The newly created content
    
    Throws:
    
    WGAPIException
  - createClone
```
public WGDocument createClone(WGDatabase db,
                     WGDocument ref)
                       throws WGAPIException
```
    Description copied from class: WGDocument
    
    Creates a clone of this document in another database
    
    Specified by:
    
    createClone in class WGDocument
    
    Parameters:
    db - The target database
    ref - 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.
    
    Returns:
    The clone
    
    Throws:
    
    WGAPIException
  - pushData
```
public void pushData(WGDocument doc)
              throws WGAPIException
```
    Description copied from class: WGDocument
    
    Pushed the data of this document to another document of the same type. This method is allowed to save the target document if necessary, but is not required to.
    
    Overrides:
    
    pushData in class WGDocument
    
    Parameters:
    doc - The target document receiving the data.
    
    Throws:
    
    WGAPIException - If something goes wrong
  - initializePagePublished
```
public void initializePagePublished(WGStructEntry source)
                             throws WGAPIException
```
    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.
    
    Parameters:
    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).
    
    Throws:
    
    WGAPIException
  - isDifferentParent
```
public boolean isDifferentParent(WGStructEntry clone)
                          throws WGAPIException
```
    Tests if this struct entry has a different parent than the given clone. Used in synchronisation to test if the struct was repositioned since last sync.
    
    Parameters:
    clone - The struct entry clone
    
    Returns:
    true if it was repositioned, false otherwise
    
    Throws:
    
    WGAPIException
  - isActive
```
public boolean isActive()
                 throws WGAPIException
```
    Determines if this page is already "active", i.e. it contains contents that are no more in draft state or child pages
    
    Throws:
    
    WGAPIException
  - save
```
public boolean save(java.util.Date lastModified)
             throws WGAPIException
```
    Description copied from class: WGDocument
    
    Saves the current document with it's modifications. Special version only to be used inside WGAPI, e.g. for createClone.
    
    Overrides:
    
    save in class WGDocument
    
    Parameters:
    lastModified - Date of last modification to set (if this is supported by the implementation)
    
    Returns:
    true, if the saving succeded, false otherwise.
    
    Throws:
    
    WGAuthorisationException
    
    LockException - - instance of ResourceIsLockedException if a process try to modifiy a locked object without obtaining a lock
    
    WGSystemException
    
    WGIllegalArgumentException
    
    WGAPIException
  - maySave
```
public boolean maySave()
                throws WGAPIException
```
    Description copied from class: WGDocument
    
    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()
    
    Overrides:
    
    maySave in class WGDocument
    
    Throws:
    
    WGAPIException
  - performSaveCheck
```
public void performSaveCheck()
                      throws WGAPIException,
                             WGAuthorisationException
```
    Description copied from class: WGDocument
    
    Performs a validation for saving the document at the current state, just like it actually was saved. This method finishes quietly if the save check succeeded. Otherwise an adequate WGAuthorisationException is thrown. For checking saving permissions without catching an exception see WGDocument.maySave().
    
    Overrides:
    
    performSaveCheck in class WGDocument
    
    Throws:
    
    WGAPIException
    
    WGAuthorisationException
  - getContentFetchState
```
public int getContentFetchState()
```
    Returns the fetch state for content of this structentry as constant FETCHSTATE_... WGA clients may determine by this state how expensive a desired fetch operation might be. E.g. retrieving content including archived versions may be expensive if it has not been fetched yet Otherwise, everything that is already fetched is cheap to retrieve.
  - getStructKeyPath
```
public java.lang.String getStructKeyPath()
                                  throws WGAPIException
```
    Returns a path consisting of the structkeys 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
    
    Throws:
    
    WGAPIException
  - getTitlePath
```
public java.lang.String getTitlePath()
                              throws WGAPIException
```
    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
    
    Throws:
    
    WGAPIException
  - isDescendantOf
```
public boolean isDescendantOf(WGDocument doc)
                       throws WGAPIException
```
    Determines if this struct entry is a descendant of the given document, i.e. is a part of it's child hierarchy.
    
    Parameters:
    doc - The document that may be a descendant. Allows WGStructEntry and WGArea type documents
    
    Returns:
    yes if it is a descendant of the given entry, false if not
    
    Throws:
    
    WGAPIException
  - getParentLockable
```
public Lockable getParentLockable()
                           throws WGAPIException
```
    Description copied from interface: Lockable
    
    returns the parent lockable of this lockable for e.g. WGStructEntry in case of WGContent
    
    Specified by:
    
    getParentLockable in interface Lockable
    
    Specified by:
    
    getParentLockable in class WGDocument
    
    Throws:
    
    WGAPIException
  - getContentSet
```
public WGStructEntry.ContentSet getContentSet(boolean includeArchived)
                                       throws WGAPIException
```
    Returns the set of contents for the current WGStructEntry
    
    Parameters:
    includeArchived - Set true to also retrieve archived contents
    
    Returns:
    The content set
    
    Throws:
    
    WGAPIException
  - getSiblingIndex
```
public int getSiblingIndex()
                    throws WGAPIException
```
    Returns the index of the current struct entry in the list of it's siblings
    
    Throws:
    
    WGAPIException
  - getChildNodeType
```
public java.lang.Class getChildNodeType()
```
    Description copied from interface: PageHierarchyNode
    
    Return the class type of child nodes
    
    Specified by:
    
    getChildNodeType in interface PageHierarchyNode
  - getChildNodes
```
public java.util.List getChildNodes()
                             throws WGAPIException
```
    Description copied from interface: PageHierarchyNode
    
    Returns the child nodes of this hierarchy node
    
    Specified by:
    
    getChildNodes in interface PageHierarchyNode
    
    Throws:
    
    WGAPIException
  - getChildNodeIterator
```
public de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> getChildNodeIterator(int pageSize)
                                                                                           throws WGAPIException
```
    Description copied from interface: PageHierarchyNode
    
    Returns an iterator for the child nodes of this hierarchy node
    
    Specified by:
    
    getChildNodeIterator in interface PageHierarchyNode
    
    Parameters:
    pageSize - The size of a fetch page, if the implementation fetches childnodes page-wise
    
    Throws:
    
    WGAPIException
  - getNodeKey
```
public java.lang.String getNodeKey()
                            throws WGAPIException
```
    Description copied from interface: PageHierarchyNode
    
    Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.
    
    Specified by:
    
    getNodeKey in interface PageHierarchyNode
    
    Throws:
    
    WGAPIException
  - getNodeTitle
```
public java.lang.String getNodeTitle(java.lang.String language)
                              throws WGAPIException
```
    Description copied from interface: PageHierarchyNode
    
    Returns the display title for the node. If multiple titles for multiple languages exist we choose a specific one for the given language.
    
    Specified by:
    
    getNodeTitle in interface PageHierarchyNode
    
    Parameters:
    language - The language whose title is wanted
    
    Returns:
    The title
    
    Throws:
    
    WGAPIException
  - getParentNode
```
public PageHierarchyNode getParentNode()
                                throws WGAPIException
```
    Description copied from interface: PageHierarchyNode
    
    Return the parent of this node in hierarchy. Return null at the root level.
    
    Specified by:
    
    getParentNode in interface PageHierarchyNode
    
    Throws:
    
    WGAPIException
  - getArchivedContent
```
public java.util.List<WGContent> getArchivedContent(java.lang.String language)
                                             throws WGAPIException
```
    Returns the archived contents for one language, as list in the order of their version numbers.
    
    Parameters:
    language - The language to retrieve archived contents for
    
    Returns:
    List of archived contents of the given language, ordered by version ascending
    
    Throws:
    
    WGAPIException
  - getUniqueName
```
public java.lang.String getUniqueName()
                               throws WGAPIException
```
    Returns the unique name of this struct entry, null if there is none
    
    Throws:
    
    WGAPIException
  - setUniqueName
```
public void setUniqueName(java.lang.String name)
                   throws WGAPIException
```
    Sets the unique name of this struct entry
    
    Throws:
    
    WGAPIException
  - getPublished
```
public java.util.Map<java.lang.String,java.util.Date> getPublished()
                                                            throws WGAPIException
```
    Returns the dates when this page was first published in its available languages The returned map is keyed by language codes. The corresponding value is the date/time when the page was first published in this language.
    
    Throws:
    
    WGAPIException
  - visit
```
public void visit(WGPageVisitor visitor)
           throws WGAPIException
```
    Implements the visitor pattern on the page hierarchy branch of this struct entry. The visitor visits this and all struct entries below and all of their (non-archived) contents.
    
    Parameters:
    visitor -
    
    Throws:
    
    WGAPIException
  - performChildCreationCheck
```
public void performChildCreationCheck(WGContentType ct)
                               throws WGAPIException
```
    Checks if the current user may create a new child struct entry of the given content type. If so the method exits normally. Otherwise an rexception is thrown.
    
    Parameters:
    ct - The content type to use.
    
    Throws:
    
    WGAPIException - @throws WGAPIException If the user may not create the document. The exception informs about the reason.
  - performChildPageCreationCheck
```
public void performChildPageCreationCheck(WGContentType ct,
                                 WGLanguage lang)
                                   throws WGAPIException
```
    Checks if the current user may create a new child page with the given data. If so the method exits normally. Otherwise an exception is thrown.
    
    Parameters:
    ct - The content type to use for the struct entry
    lang - The language to use for the content
    
    Throws:
    
    WGAPIException - If the user may not create the document. The exception informs about the reason.
  - createChildPage
```
public WGContent createChildPage(WGContentType contentType,
                        java.lang.String title,
                        java.lang.String language)
                          throws WGAPIException
```
    Creates a new child page, including struct entry and content. Both documents are already saved when the method exists.
    
    Parameters:
    contentType - The content type of the page
    title - The title of the page that will be used for both struct entry
    language - The language of the content to create. Leave null to use databases default language.
    
    Returns:
    The content of the created page
    
    Throws:
    
    WGAPIException
  - getType
```
public int getType()
```
    Description copied from class: WGDocument
    
    Returns the type of this document as constant WGDocument.TYPE_...
    
    Specified by:
    
    getType in class WGDocument
  - getReaders
```
public java.util.List<java.lang.String> getReaders()
                                            throws WGAPIException
```
    Returns a list of allowed readers of contents on this struct entry. This method only returns the readers set on this entry, not those that are effective in hierarchy. This is only supported on content stores of version 5.
    
    Returns:
    List
    
    Throws:
    
    WGAPIException
  - setReaders
```
public boolean setReaders(java.util.List list)
                   throws WGAPIException
```
    Sets the allowed readers for this struct entry. This is only supported on content stores of version 5.
    
    Parameters:
    list -
    
    Throws:
    
    WGAPIException
  - getEffectiveReaders
```
public java.util.List<java.lang.String> getEffectiveReaders()
                                                     throws WGAPIException
```
    Returns the list of currently effective readers. These may differ from the currently set readers in a yet unsaved document.
    
    Throws:
    
    WGAPIException
  - getEffectivePageEditors
```
public java.util.List<java.lang.String> getEffectivePageEditors()
                                                         throws WGAPIException
```
    Returns the list of currently effective page editors. These may differ from the currently set editors in a yet unsaved document.
    
    Throws:
    
    WGAPIException
  - getEffectiveChildEditors
```
public java.util.List<java.lang.String> getEffectiveChildEditors()
                                                          throws WGAPIException
```
    Returns the list of currently effective child editors. These may differ from the currently set editors in a yet unsaved document.
    
    Throws:
    
    WGAPIException
  - getChildEntryCount
```
public int getChildEntryCount()
                       throws WGAPIException
```
    Returns the number of child entries without actually retrieving them. Most content store implementations provide optimized functionality to retrieve the count in a performant, resource neutral way. Use it to determine if a struct entry has children where you do not actually need to retrieve those children.
    
    Returns:
    Number of child entries.
    
    Throws:
    
    WGAPIException
  - getEffectiveChildPageRestrictions
```
public java.lang.String getEffectiveChildPageRestrictions()
                                                   throws WGAPIException
```
    Returns the effective restrictions regarding childpages of this struct. These are either restrictions set on this struct or, if not set there, on its content type. Returns constants PAGERESTRICTION_...
    
    Throws:
    
    WGAPIException
  - getChildPageRestrictions
```
public java.lang.String getChildPageRestrictions()
                                          throws WGAPIException
```
    Returns the restrictions regarding childpages of this struct. Returns constants PAGERESTRICTION_...
    
    Throws:
    
    WGAPIException
  - setChildPageRestrictions
```
public void setChildPageRestrictions(java.lang.String childPages)
                              throws WGAPIException
```
    Sets the restrictions regarding childpages of this struct.
    
    Parameters:
    childPages - Restriction string. Use constants PAGERESTRICTION_...
    
    Throws:
    
    WGAPIException
  - getEffectiveAllowedChildTypes
```
public java.util.List<java.lang.String> getEffectiveAllowedChildTypes()
                                                               throws WGAPIException
```
    Returns the allowed content types for child pages of this struct that are actually effective. These are either types set on this struct or, if not set there, on its content type. Returns constants PAGERESTRICTION_...
    
    Throws:
    
    WGAPIException
  - getAllowedChildTypes
```
public java.util.List<java.lang.String> getAllowedChildTypes()
                                                      throws WGAPIException
```
    Returns the allowed content types for child pages of this struct. Only effective when getChildPageRestrictions() is WGDocument.PAGERESTRICTION_FIXEDTYPES
    
    Throws:
    
    WGAPIException
  - setAllowedChildTypes
```
public void setAllowedChildTypes(java.util.List<java.lang.String> types)
                          throws WGAPIException
```
    Sets the allowed content types for child pages of this struct. Only effective when getChildPageRestrictions() is WGDocument.PAGERESTRICTION_FIXEDTYPES
    
    Parameters:
    types - Names of content types
    
    Throws:
    
    WGAPIException

Class WGStructEntry

Nested Class Summary

Nested classes/interfaces inherited from class de.innovationgate.webgate.api.WGDocument

Field Summary

Fields inherited from class de.innovationgate.webgate.api.WGDocument

Constructor Summary

Method Summary

Methods inherited from class de.innovationgate.webgate.api.WGDocument

Methods inherited from class java.lang.Object

Field Detail

EDITORS_INHERIT_AND_REDUCE

META_KEY

METAINFO_KEY

META_TITLE

META_UNIQUENAME

METAINFO_TITLE

META_AREA

METAINFO_AREA

META_POSITION

METAINFO_POSITION

META_CONTENTTYPE

METAINFO_CONTENTTYPE

META_READERS

METAINFO_READERS

META_PAGE_EDITORS

METAINFO_PAGE_EDITORS

META_CHILD_EDITORS

METAINFO_CHILD_EDITORS

META_WORKFLOW_NAME

METAINFO_WORKFLOW_NAME

METAINFO_UNIQUENAME

META_PUBLISHED

METAINFO_PUBLISHED

META_CHILDPAGERESTRICTIONS

METAINFO_CHILDPAGERESTRICTIONS

META_ALLOWED_CHILDTYPES

METAINFO_ALLOWED_CHILDTYPES

FETCHSTATE_NONE

FETCHSTATE_ACTIVE_ONLY

FETCHSTATE_ARCHIVED

Constructor Detail

WGStructEntry

WGStructEntry

Method Detail

isRoot

setChildEditors

setPageEditors

setStructEditors

hasChildren

getPageEditors

getLocalWorkflowName

getStructEditors

getChildEditors

getParentEntry

getArea

getSiblingEntries

getSiblingEntryIterator

getOrderedSiblingEntryIterator

getRootEntry

getPosition

getPositionPath

setPosition

getChildEntries

getChildEntryIterator

getChildEntries

getOrderedChildEntryIterator

getOrderedChildEntries

getOrderedChildEntries

getAllContent

getAllContent

getContent

getContent

getTitle

setTitle

getWorkflowName

setWorkflowName

setBranchWorkflow

getBranchWorkflow

getContentType

changeContentType