WGArea

java.lang.Object
- de.innovationgate.webgate.api.WGDocument
- - de.innovationgate.webgate.api.WGDesignDocument
  - - de.innovationgate.webgate.api.WGSchemaDocument
    - - de.innovationgate.webgate.api.WGArea

All Implemented Interfaces:

Lockable, MetaInfoProvider, PageHierarchyNode, WGExtensionDataContainer, WGFileMetaDataContext
```
public class WGArea
extends WGSchemaDocument
implements PageHierarchyNode
```
Represents an area of the content database, containing content documents. Areas are treated as separated regions of the content, where each has it's own access controlling.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WGArea.AreaCache

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

Nested Classes
Modifier and Type	Class and Description
`static class`	`WGArea.AreaCache`
`class`	`WGArea.SessionData`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`META_ALLOWED_ROOTTYPES`
`static java.lang.String`	`META_EDITORS`
`static java.lang.String`	`META_READERS`
`static java.lang.String`	`META_ROOTPAGERESTRICTIONS`
`static java.lang.String`	`META_SYSTEM`
`static MetaInfo`	`METAINFO_ALLOWED_ROOTTYPES`
`static MetaInfo`	`METAINFO_EDITORS`
`static MetaInfo`	`METAINFO_READERS`
`static MetaInfo`	`METAINFO_ROOTPAGERESTRICTIONS`
`static MetaInfo`	`METAINFO_SYSTEM`

Fields inherited from class de.innovationgate.webgate.api.WGSchemaDocument
EXTDATA_SCHEMADEFINITION

Fields inherited from class de.innovationgate.webgate.api.WGDesignDocument
META_DESCRIPTION, META_DESIGNREFERENCE, META_NAME, META_VARIANT, METAINFO_DESCRIPTION, METAINFO_DESIGNREFERENCE, METAINFO_NAME, METAINFO_VARIANT

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
`WGArea(WGDatabase db, WGDocumentCore doc)`
`WGArea(WGDatabase wgDatabase, WGDocumentCore doc, de.innovationgate.webgate.api.WGDocumentObjectFlags flags)`

Method Summary

Methods
Modifier and Type	Method and Description
`WGDocument`	`createClone(WGDatabase db)` Creates a clone of this design document in another database
`WGContent`	`createContent()` Creates a new content as root for this area.
`WGContent`	`createContent(java.lang.Object key, java.lang.String title)` Creates a new content object as root in this area.
`WGStructEntry`	`createRootEntry(WGContentType contentType, java.lang.String title)` Creates a new root entry for this area.
`WGContent`	`createRootPage(WGContentType contentType, java.lang.String title)` Variant of `createRootPage(WGContentType, String, String)` that always uses default language.
`WGContent`	`createRootPage(WGContentType contentType, java.lang.String title, java.lang.String language)` Creates a new root page, including struct entry and content.
`java.util.List<java.lang.String>`	`getAllowedRootTypes()` Returns the allowed content types for root pages on this area.
`de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode>`	`getChildNodeIterator(int pageSize)` Returns an iterator for the child nodes of this hierarchy node
`java.util.List<PageHierarchyNode>`	`getChildNodes()` Returns the child nodes of this hierarchy node
`java.lang.Class`	`getChildNodeType()` Return the class type of child nodes
`java.util.List`	`getEditors()` Returns a list of allowed content editors in this area.
`java.util.List`	`getEffectiveEditors()` Returns the list of currently effective editors.
`java.util.List`	`getEffectiveReaders()` Returns the list of currently effective readers.
`java.lang.String`	`getName()` Returns the name of this area.
`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`	`getOrderedRootEntries(int offset, int size, java.lang.String orderExpression)` Returns a partial list of the root entries of this area, ordered by a special order expression
`WGStructEntryList`	`getOrderedRootEntries(java.lang.String orderExpression)` Returns a list of all root entries in this area, ordered by a special order expression
`WGStructEntryIterator`	`getOrderedRootEntryIterator(int pageSize, java.lang.String pageOrder)` Returns an iterator over the root entries of this area, returned in a particular order Internally the iterator fetches multiple entities at once from the backend for more performant backend retrieval processes.
`PageHierarchyNode`	`getParentNode()` Return the parent of this node in hierarchy.
`java.util.List`	`getReaders()` Returns a list of allowed readers of contents in this area.
`WGHierarchyContentIterator`	`getRootContentIterator(java.lang.String language, int pageSize)` Returns an iterator over the root contents of area in a given language Internally the iterator fetches multiple pages at once from the backend for more performant backend retrieval processes.
`WGStructEntryList`	`getRootEntries()` Returns a list of all root entries in this area.
`WGStructEntryList`	`getRootEntries(int offset, int size)` Returns a partial list of the root entries in this area.
`int`	`getRootEntryCount()`
`WGStructEntryIterator`	`getRootEntryIterator(int pageSize)` Returns an iterator over the root entries of this area.
`java.lang.String`	`getRootPageRestrictions()` Returns the restrictions regarding root pages on this area.
`int`	`getType()` Returns the type of this document as constant WGDocument.TYPE_...
`boolean`	`isPublic()` Tests if this area is publicly accessible, i.e. anyone can generally read its content
`boolean`	`isSystemArea()` Returns if this area is marked as being a system area, which contains no publishable content
`boolean`	`mayEditAreaChildren()` Deprecated. Use `mayEditPages()`
`boolean`	`mayEditPages()` Tests if the current user is generally allowed to edit documents in this area, according to area access rights
`boolean`	`mayReadContent()` Tests if the current user may read contents in this area
`void`	`performRemoveCheck(boolean deepCheck, WGDocument deletionRoot)` Performs a validation for removing the document at the current state, just like it actually was removed.
`void`	`performRootCreationCheck(WGContentType ct)` Checks if the current user may create a new root struct entry of the given content type.
`void`	`performRootPageCreationCheck(WGContentType ct, WGLanguage lang)` Checks if the current user may create a new root page with the given data.
`void`	`performSaveCheck()` Performs a validation for saving the document at the current state, just like it actually was saved.
`void`	`pushData(WGDocument doc)` Pushed the data of this document to another document of the same type.
`void`	`setAllowedRootTypes(java.util.List<java.lang.String> types)` Sets the allowed content types for root pages on this area.
`boolean`	`setEditors(java.util.List list)` Sets the allowed editors for this area.
`boolean`	`setReaders(java.util.List list)` Sets the allowed readers for this area.
`void`	`setRootPageRestrictions(java.lang.String rootPages)` Sets the restrictions regarding root pages on this area
`void`	`setSystemArea(boolean system)` Sets if this area should be marked a system area.
`void`	`visit(WGPageVisitor visitor)` Implements the visitor pattern on the page hierarchy of this area.

Methods inherited from class de.innovationgate.webgate.api.WGSchemaDocument
createSchemaDefinition, getSchemaDefinition, isMetaDeterminedInSchema, setMetaData

Methods inherited from class de.innovationgate.webgate.api.WGDesignDocument
buildDesignDocumentKey, createClone, getDescription, getDesignReference, getMediaKey, getParentLockable, isVariant, mayEditDocument, rename, rename, retrieveCore, setDescription

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, maySave, performRemoveCheck, performRemoveCheck, remove, removeAllExtensionData, removeAllFiles, removeAllItems, removeExtensionData, removeFile, removeFileDerivate, removeItem, renameFile, resultIsFalse, resultIsTrue, save, save, saveQuiet, saveWithGivenTimestamps, setCachingEnabled, setItem, setItems, setItemValue, setMeta, 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
  - META_READERS
```
public static final java.lang.String META_READERS
```
    See Also:
    Constant Field Values
  - METAINFO_READERS
```
public static final MetaInfo METAINFO_READERS
```
  - META_EDITORS
```
public static final java.lang.String META_EDITORS
```
    See Also:
    Constant Field Values
  - METAINFO_EDITORS
```
public static final MetaInfo METAINFO_EDITORS
```
  - META_SYSTEM
```
public static final java.lang.String META_SYSTEM
```
    See Also:
    Constant Field Values
  - METAINFO_SYSTEM
```
public static final MetaInfo METAINFO_SYSTEM
```
  - META_ROOTPAGERESTRICTIONS
```
public static final java.lang.String META_ROOTPAGERESTRICTIONS
```
    See Also:
    Constant Field Values
  - METAINFO_ROOTPAGERESTRICTIONS
```
public static final MetaInfo METAINFO_ROOTPAGERESTRICTIONS
```
  - META_ALLOWED_ROOTTYPES
```
public static final java.lang.String META_ALLOWED_ROOTTYPES
```
    See Also:
    Constant Field Values
  - METAINFO_ALLOWED_ROOTTYPES
```
public static final MetaInfo METAINFO_ALLOWED_ROOTTYPES
```
- Constructor Detail
  - WGArea
```
public WGArea(WGDatabase db,
      WGDocumentCore doc)
       throws WGAPIException
```
    Throws:
    
    WGAPIException
    See Also:
    WGDocument.WGDocument(WGDatabase, WGDocumentCore)
  - WGArea
```
public WGArea(WGDatabase wgDatabase,
      WGDocumentCore doc,
      de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
       throws WGAPIException
```
    Throws:
    
    WGAPIException
- Method Detail
  - getName
```
public java.lang.String getName()
                         throws WGAPIException
```
    Returns the name of this area.
    
    Specified by:
    
    getName in class WGDesignDocument
    
    Throws:
    
    WGAPIException
  - getRootEntries
```
public WGStructEntryList getRootEntries()
                                 throws WGAPIException
```
    Returns a list of all root entries in this area.
    
    Returns:
    WGStructEntryList
    
    Throws:
    
    WGSystemException
    
    WGBackendException
    
    WGAPIException
  - getRootEntryIterator
```
public WGStructEntryIterator getRootEntryIterator(int pageSize)
                                           throws WGAPIException
```
    Returns an iterator over the root entries of this area. 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
    
    Returns:
    An iterator over all root entries of this area
    
    Throws:
    
    WGAPIException
  - getOrderedRootEntryIterator
```
public WGStructEntryIterator getOrderedRootEntryIterator(int pageSize,
                                                java.lang.String pageOrder)
                                                  throws WGAPIException
```
    Returns an iterator over the root entries of this area, 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 root entries of this area
    
    Throws:
    
    WGAPIException
  - getRootContentIterator
```
public WGHierarchyContentIterator getRootContentIterator(java.lang.String language,
                                                int pageSize)
                                                  throws WGAPIException
```
    Returns an iterator over the root contents of area in a given language Internally the iterator fetches multiple pages at once from the backend for more performant backend retrieval processes. The size of those retrieval pages must be determined as argument.. This method does only return released contents. Pages without released contents in the current language are skipped.
    
    Parameters:
    pageSize - The size of retrieval pages
    
    Returns:
    An iterator over the root contents of this area
    
    Throws:
    
    WGAPIException
  - getRootEntries
```
public WGStructEntryList getRootEntries(int offset,
                               int size)
                                 throws WGAPIException
```
    Returns a partial list of the root entries in this area.
    
    Parameters:
    offset - The offset of the first entry to retrieve, 0 being the first one
    size - The number of entries to retrieve
    
    Returns:
    WGStructEntryList
    
    Throws:
    
    WGSystemException
    
    WGBackendException
    
    WGAPIException
  - getOrderedRootEntries
```
public WGStructEntryList getOrderedRootEntries(int offset,
                                      int size,
                                      java.lang.String orderExpression)
                                        throws WGAPIException
```
    Returns a partial list of the root entries of this area, 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
  - getOrderedRootEntries
```
public WGStructEntryList getOrderedRootEntries(java.lang.String orderExpression)
                                        throws WGAPIException
```
    Returns a list of all root entries in this area, ordered by a special order expression
    
    Parameters:
    orderExpression - Page order set expression
    
    Returns:
    WGStructEntryList
    
    Throws:
    
    WGSystemException
    
    WGBackendException
    
    WGAPIException
  - getEditors
```
public java.util.List getEditors()
                          throws WGAPIException
```
    Returns a list of allowed content editors in this area.
    
    Returns:
    List
    
    Throws:
    
    WGAPIException
  - getReaders
```
public java.util.List getReaders()
                          throws WGAPIException
```
    Returns a list of allowed readers of contents in this area. This is only supported on content stores of version 5.
    
    Returns:
    List
    
    Throws:
    
    WGAPIException
  - setEditors
```
public boolean setEditors(java.util.List list)
                   throws WGAPIException
```
    Sets the allowed editors for this area.
    
    Parameters:
    list -
    
    Throws:
    
    WGAPIException
  - setReaders
```
public boolean setReaders(java.util.List list)
                   throws WGAPIException
```
    Sets the allowed readers for this area. This is only supported on content stores of version 5.
    
    Parameters:
    list -
    
    Throws:
    
    WGAPIException
  - mayEditAreaChildren
```
public boolean mayEditAreaChildren()
                            throws WGAPIException
```
    Deprecated. Use mayEditPages()
    
    Tests if the current user is allowed to edit documents in this area.
    
    Returns:
    boolean
    
    Throws:
    
    WGAPIException
  - mayEditPages
```
public boolean mayEditPages()
                     throws WGAPIException
```
    Tests if the current user is generally allowed to edit documents in this area, according to area access rights
    
    Throws:
    
    WGAPIException
  - getEffectiveReaders
```
public java.util.List 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
  - getEffectiveEditors
```
public java.util.List getEffectiveEditors()
                                   throws WGAPIException
```
    Returns the list of currently effective editors. These may differ from the currently set editors in a yet unsaved document.
    
    Throws:
    
    WGAPIException
  - createRootEntry
```
public WGStructEntry createRootEntry(WGContentType contentType,
                            java.lang.String title)
                              throws WGAPIException
```
    Creates a new root entry for this area.
    
    Parameters:
    contentType - The content type for this new entry.
    title - The title of this new entry.
    
    Returns:
    A newly created root entry
    
    Throws:
    
    WGAPIException
  - createRootPage
```
public WGContent createRootPage(WGContentType contentType,
                       java.lang.String title,
                       java.lang.String language)
                         throws WGAPIException
```
    Creates a new root 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
  - createRootPage
```
public WGContent createRootPage(WGContentType contentType,
                       java.lang.String title)
                         throws WGAPIException
```
    Variant of createRootPage(WGContentType, String, String) that always uses default language.
    
    Parameters:
    contentType -
    title -
    
    Returns:
    The content of the created page
    
    Throws:
    
    WGAPIException
  - createClone
```
public WGDocument createClone(WGDatabase db)
                       throws WGAPIException
```
    Description copied from class: WGDesignDocument
    
    Creates a clone of this design document in another database
    
    Specified by:
    
    createClone in class WGDesignDocument
    
    Parameters:
    db - Target database
    
    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
  - performRemoveCheck
```
public void performRemoveCheck(boolean deepCheck,
                      WGDocument deletionRoot)
                        throws WGAPIException
```
    Description copied from class: WGDocument
    
    Performs a validation for removing the document at the current state, just like it actually was removed. This method finishes quietly if the removal check succeeded. Otherwise an adequate WGAuthorisationException is thrown. For checking remove permissions without catching an exception see WGDocument.mayRemove(boolean).
    
    Parameters:
    deepCheck - Perform an hierarchical check beyond the current document, which is more expensive but also 100% accurate. This is only effective for document types whose deletion will also delete dependent documents.
    
    Throws:
    
    WGAuthorisationException
    
    WGAPIException
  - createContent
```
public WGContent createContent(java.lang.Object key,
                      java.lang.String title)
                        throws WGAPIException
```
    Creates a new content object as root in this area. This is only usable in content stores without struct entries (e.g. all descendants of SimpleContentSource).
    
    Parameters:
    key - The key for the new content
    title - The title of the new content
    
    Returns:
    Newly created content object
    
    Throws:
    
    WGAPIException
  - createContent
```
public WGContent createContent()
                        throws WGAPIException
```
    Creates a new content as root for this area. This is only usable in content stores without struct entries (e.g. all descendants of SimpleContentSource).
    
    Returns:
    Newly created root content.
    
    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<PageHierarchyNode> 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
  - 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
  - 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
  - performSaveCheck
```
public void performSaveCheck()
                      throws ResourceIsLockedException,
                             WGAPIException
```
    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 WGSchemaDocument
    
    Throws:
    
    WGAPIException
    
    ResourceIsLockedException
  - visit
```
public void visit(WGPageVisitor visitor)
           throws WGAPIException
```
    Implements the visitor pattern on the page hierarchy of this area. The visitor visits all struct entries and all of their (non-archived) contents.
    
    Parameters:
    visitor -
    
    Throws:
    
    WGAPIException
  - performRootCreationCheck
```
public void performRootCreationCheck(WGContentType ct)
                              throws WGAPIException
```
    Checks if the current user may create a new root struct entry of the given content type. If so the method exits normally. Otherwise an exception is thrown.
    
    Parameters:
    ct - The content type to use.
    
    Throws:
    
    WGAPIException - If the user may not create the document. The exception informs about the reason.
  - performRootPageCreationCheck
```
public void performRootPageCreationCheck(WGContentType ct,
                                WGLanguage lang)
                                  throws WGAPIException
```
    Checks if the current user may create a new root 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.
  - 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
  - isSystemArea
```
public boolean isSystemArea()
                     throws WGAPIException
```
    Returns if this area is marked as being a system area, which contains no publishable content
    
    Throws:
    
    WGAPIException
  - setSystemArea
```
public void setSystemArea(boolean system)
                   throws WGAPIException
```
    Sets if this area should be marked a system area. Pages in system areas are not published and may be used for internal purposes by the system.
    
    Parameters:
    system -
    
    Throws:
    
    WGAPIException
  - mayReadContent
```
public boolean mayReadContent()
                       throws WGAPIException
```
    Tests if the current user may read contents in this area
    
    Throws:
    
    WGAPIException
  - getRootEntryCount
```
public int getRootEntryCount()
                      throws WGAPIException
```
    Throws:
    
    WGAPIException
  - isPublic
```
public boolean isPublic()
                 throws WGAPIException
```
    Tests if this area is publicly accessible, i.e. anyone can generally read its content
    
    Throws:
    
    WGAPIException
  - getRootPageRestrictions
```
public java.lang.String getRootPageRestrictions()
                                         throws WGAPIException
```
    Returns the restrictions regarding root pages on this area. Returns constants PAGERESTRICTION_...
    
    Throws:
    
    WGAPIException
  - setRootPageRestrictions
```
public void setRootPageRestrictions(java.lang.String rootPages)
                             throws WGAPIException
```
    Sets the restrictions regarding root pages on this area
    
    Parameters:
    rootPages - Restriction string. Use constants PAGERESTRICTION_...s
    
    Throws:
    
    WGAPIException
  - getAllowedRootTypes
```
public java.util.List<java.lang.String> getAllowedRootTypes()
                                                     throws WGAPIException
```
    Returns the allowed content types for root pages on this area. Only effective when getRootPageRestrictions() is WGDocument.PAGERESTRICTION_FIXEDTYPES
    
    Throws:
    
    WGAPIException
  - setAllowedRootTypes
```
public void setAllowedRootTypes(java.util.List<java.lang.String> types)
                         throws WGAPIException
```
    Sets the allowed content types for root pages on this area. Only effective when getRootPageRestrictions() is WGDocument.PAGERESTRICTION_FIXEDTYPES
    
    Parameters:
    types - Names of content types
    
    Throws:
    
    WGAPIException

Class WGArea

Nested Class Summary

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

Field Summary

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Field Detail

META_READERS

METAINFO_READERS

META_EDITORS

METAINFO_EDITORS

META_SYSTEM

METAINFO_SYSTEM

META_ROOTPAGERESTRICTIONS

METAINFO_ROOTPAGERESTRICTIONS

META_ALLOWED_ROOTTYPES

METAINFO_ALLOWED_ROOTTYPES

Constructor Detail

WGArea

WGArea

Method Detail

getName

getRootEntries

getRootEntryIterator

getOrderedRootEntryIterator

getRootContentIterator

getRootEntries

getOrderedRootEntries

getOrderedRootEntries

getEditors

getReaders

setEditors

setReaders

mayEditAreaChildren

mayEditPages

getEffectiveReaders

getEffectiveEditors

createRootEntry

createRootPage

createRootPage

createClone

pushData

performRemoveCheck

createContent

createContent

getChildNodeType

getChildNodes

getChildNodeIterator

getParentNode

getNodeKey

getNodeTitle

performSaveCheck

visit

performRootCreationCheck

performRootPageCreationCheck

getType

isSystemArea

setSystemArea

mayReadContent

getRootEntryCount

isPublic

getRootPageRestrictions

setRootPageRestrictions

getAllowedRootTypes

setAllowedRootTypes