WGDocument

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

All Implemented Interfaces:

Lockable, MetaInfoProvider, WGExtensionDataContainer, WGFileMetaDataContext

Direct Known Subclasses:

WGContent, WGDesignDocument, WGStructEntry, WGUserProfile
```
public abstract class WGDocument
extends java.lang.Object
implements Lockable, WGExtensionDataContainer, WGFileMetaDataContext, MetaInfoProvider
```
Parent class for all document objects in a WGA database.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WGDocument.Cache`
`static class`	`WGDocument.FakeMetaDataContext` Fake md context when the metadata does not represent already stored md
`static interface`	`WGDocument.SaveAction` An interface defining an action that can be execute after the current document was saved in the current session

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CSFEATURE_EXTDATA` Feature identifier for `WGContentStoreVersionException` regarding extension data operations
`static java.util.regex.Pattern`	`DERIVATE_NAME_PATTERN`
`static java.lang.String`	`DOCKEY_DIVIDER` Divider character for `WGDocumentKey` strings, dividing the key parts
`static java.lang.String`	`EXT_PRIMARY_ATTACHMENT` extension data field which stores the "primary attachment" for this document in CS Versions > 5
`static java.lang.String`	`EXTDATA_META_PREFIX` Prefix for names of extension data fields that actually store document metadata fields
`static java.lang.String`	`META_CREATED`
`static java.lang.String`	`META_LASTMODIFIED`
`static java.lang.String`	`META_PASTAUTHORS`
`static java.lang.String`	`META_PASTEDITDATES`
`static java.lang.String`	`META_REVISION`
`static MetaInfo`	`METAINFO_CREATED`
`static MetaInfo`	`METAINFO_LASTMODIFIED`
`static MetaInfo`	`METAINFO_PASTAUTHORS`
`static MetaInfo`	`METAINFO_PASTEDITDATES`
`static MetaInfo`	`METAINFO_REVISION`
`static java.lang.String`	`NOONE_ALLOWED` String used in WGStructEntry fields for edit access to symbolize that noone may edit this document.
`static java.lang.String`	`PAGERESTRICTION_ANY` Restriction string for page positioning: Any page allowed
`static java.lang.String`	`PAGERESTRICTION_FIXEDTYPES` Restriction string for page positioning: Pages of special content types allowed
`static java.lang.String`	`PAGERESTRICTION_NONE` Restriction string for page positioning: No pages allowed
`static java.lang.String`	`PAGERESTRICTION_UNSPECIFIED` Restriction string for page positioning: No restriction set here, retrieve from "parent"
`static int`	`TYPE_ACLENTRY` Pseudo document type for ACL entries
`static int`	`TYPE_AREA` Document types of WGArea objects
`static int`	`TYPE_CONTENT` Document types of WGContent objects
`static int`	`TYPE_CONTENTTYPE` Document types of WGContentType objects
`static int`	`TYPE_CSSJS` Document types of WGCSSJSModule objects
`static int`	`TYPE_DBMETADATA` Pseudo document type for database metadata (i.e. extension data on db level)
`static int`	`TYPE_FILECONTAINER` Document types of WGFileContainer objects
`static int`	`TYPE_FILEDERIVATE` Pseudo document type for file derivate
`static int`	`TYPE_LANGUAGE` Document types of WGLanguage objects
`static int`	`TYPE_STRUCTENTRY` Document types of WGStructEntry objects
`static int`	`TYPE_TML` Document types of WGTMLModule objects
`static int`	`TYPE_USERPROFILE` Document types of WGUserProfile objects
`static java.lang.String`	`TYPENAME_ACLENTRY` Pseudo document type name for ACL entries
`static java.lang.String`	`TYPENAME_AREA` Document type name of WGArea objects
`static java.lang.String`	`TYPENAME_CONTENT` Document type name of WGContent objects
`static java.lang.String`	`TYPENAME_CONTENTTYPE` Document type name of WGContentType objects
`static java.lang.String`	`TYPENAME_CSSJS` Document type name of WGCSSJSModule objects
`static java.lang.String`	`TYPENAME_DBMETADATA` Pseudo document type name for database metadata
`static java.lang.String`	`TYPENAME_FILECONTAINER` Document type name of WGFileContainer objects
`static java.lang.String`	`TYPENAME_FILEDERIVATE` Pseudo document type name for file derivate
`static java.lang.String`	`TYPENAME_LANGUAGE` Document type name of WGLanguage objects
`static java.lang.String`	`TYPENAME_STRUCTENTRY` Document type name of WGStructEntry objects
`static java.lang.String`	`TYPENAME_TML` Document type name of WGTMLModule objects
`static java.lang.String`	`TYPENAME_USERPROFILE` Document type name of WGUserProfile objects

Constructor Summary

Constructors
Constructor and Description
`WGDocument(WGDatabase db, WGDocumentCore core)`
`WGDocument(WGDatabase db, WGDocumentCore core, de.innovationgate.webgate.api.WGDocumentObjectFlags flags)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`afterSave(WGDocument.SaveAction action)` Adds an action that will be executed after the document is saved the next time on this database session.
`void`	`attachAllFiles(WGDocument doc)` Copies all attachments of the parameter document to the current document.
`void`	`attachAllFiles(WGDocument doc, boolean copyExtensionData)` Copies all attachments of the parameter document to the current document
`boolean`	`attachFile(java.io.File file)` Attaches a file to the document.
`boolean`	`attachFile(java.io.File file, java.util.List<WGFileAnnotator> additionalAnnotators)` Attaches a file to the document.
`boolean`	`attachFile(java.io.InputStream stream, java.lang.String filename)` Takes data from an input stream and attaches the data as file under the given name.
`boolean`	`attachFileWithoutAnnotation(java.io.File file)` Attaches a file to the document without running any annotators
`boolean`	`attachFileWithoutAnnotation(java.io.InputStream stream, java.lang.String filename)` Takes data from an input stream and attaches the data as file, without running any annotators under the given name.
`void`	`autoSave()` Marks the document to be automatically saved at the end of the session
`static WGDocumentKey`	`buildDocumentKey(WGDocumentCore core, WGDatabase db)` Builds the document key for a document core.
`abstract WGDocument`	`createClone(WGDatabase db, WGDocument ref)` Creates a clone of this document in another database
`WGFileDerivateMetaData`	`createFileDerivate(java.lang.String fileName, java.lang.String creator, java.lang.String name, java.io.File file, java.lang.String usage, java.util.List<WGFileAnnotator> additionalAnnotators)` Creates a new file derivate for an existing original file attachment
`WGFileDerivateMetaData`	`createFileDerivate(java.lang.String fileName, java.lang.String creator, java.lang.String derivateName, java.io.InputStream in, java.lang.String usage, java.util.List<WGFileAnnotator> additionalAnnotators)` Creates a new file derivate for an existing original file attachment
`static java.lang.Integer`	`docTypeClassToNumber(java.lang.Class<?> clazz)` Converts document type classes of the WGAPI to doctype numbers
`static int`	`doctypeNameToNumber(java.lang.String name)` Converts doctype names WGDocument.TYPENAME_... to number constants WGDocument.TYPE_...
`static java.lang.Class<?>`	`doctypeNumberToClass(int number)` Converts doctype numbers WGDocument.TYPE... to document type classes in WGAPI
`static java.lang.String`	`doctypeNumberToName(int number)` Converts doctype numbers WGDocument.TYPE_... to doctype names WGDocument.TYPENAME_...
`void`	`dropCache()` Drops the cache of this document.
`void`	`dropCore()` Drops the retrieved document core (i.e. backend document), if there is one.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Object`	`evaluateExpression(java.lang.String expression)` Evaluates a native expression with the current document as context.
`WGDocumentCore`	`getCore()` Returns the core implementation object for this document.
`java.util.Date`	`getCoreRetrieved()` Returns the time when the document core was retrieved in the current session.
`java.util.Date`	`getCreated()` Returns the creation date of this document
`WGDatabase`	`getDatabase()` Returns the database that stores this document
`java.lang.String`	`getDocumentKey()` Returns the document key of this document, which is unique in this database among all documents.
`WGDocumentKey`	`getDocumentKeyObj()` Returns a parsed document key object, ready to access single parts of the key
`static java.lang.Class<?>`	`getExpectedMetaClass(int type, java.lang.String metaName)` Returns the expected data type of a metadata field
`static java.lang.String`	`getExtdataMetaName(MetaInfo metaInfo)` Returns the name that a metadata field has when stored as extension data
`java.lang.Object`	`getExtensionData(java.lang.String strName)` Returns the value of an extension data field.
`java.util.List<java.lang.String>`	`getExtensionDataNames()` Returns the names of all extension data fields on this entity
`java.io.InputStream`	`getFileData(java.lang.String strFile)` Returns the data of a file attachment as input stream Retrieving the data of a recently attached file while the document is not yet saved is not supported and may produce unknown results.
`java.io.InputStream`	`getFileDerivateData(java.lang.String id)` Returns the data of a file derivate
`WGFileDerivateMetaData`	`getFileDerivateMetaData(java.lang.String id)` Returns the metadata of a file derivate
`java.util.List<WGFileDerivateMetaData>`	`getFileDerivates(java.lang.String fileName)` Returns a list of all available derivates for the specified file
`java.util.Date`	`getFileLastModified(java.lang.String file)` Provides the best (most specific) information about the last modified date of an individual file attachment.
`WGFileMetaData`	`getFileMetaData(java.lang.String strFile)` Returns the meta data object for the given filename
`java.lang.String`	`getFileMimeType(java.lang.String strFile)` Returns the (primary) mime-type for the file of the given name.
`java.util.Collection<java.lang.String>`	`getFileMimeTypes(java.lang.String strFile)` Returns all mime-types for the file of the given name.
`java.util.List<java.lang.String>`	`getFileNames()` Returns a list of file attachment names for this document
`WGDocument`	`getFileParent()` Returns the parent document holding the file attachment, if possible
`int`	`getFileSize(java.lang.String strFile)` Returns the size of an attachment in bytes.
`java.io.Reader`	`getFileText(java.lang.String strFile)` Deprecated. Use `getFileText(String)` which allows specifying an encoding
`java.io.Reader`	`getFileText(java.lang.String strFile, java.lang.String encoding)` Returns the contents of a file attachment in text format.
`java.util.Date`	`getItemDate(java.lang.String strName)` Retrieves the value of a date item.
`java.util.List<java.lang.String>`	`getItemNames()` Retrieves a list of the names of all content items on this document
`java.lang.Number`	`getItemNumber(java.lang.String strName)` Retrieves a number item.
`java.lang.String`	`getItemText(java.lang.String strName)` Returns a text item.
`java.lang.Object`	`getItemValue(java.lang.String strName)` Returns an item's value.
`java.util.List<?>`	`getItemValueList(java.lang.String name)` Returns an items value(s) always as list.
`java.util.Date`	`getLastModified()` Returns the last modification date of the document
`de.innovationgate.utils.SkippingIterator<WGUpdateLog>`	`getLastUpdates()` Returns update logs for the last updates done to this document, in descending chronological order
`int`	`getLockStatus()` returns the lock status for the current sessioncontext
`int`	`getLockStatus(LockOwner owner)` returns the current lockstatus of the lockable - if parent is set and locked the lockstatus is inherited
`java.lang.Object`	`getMetaData(java.lang.String name)` Returns meta data about this document.
`java.util.List<?>`	`getMetaDataList(java.lang.String name)` Returns meta data about this document.
`MetaInfo`	`getMetaInfo(java.lang.String metaName)` Returns the meta information for a given metadata field.
`static MetaInfo`	`getMetaInfoByType(int type, java.lang.String metaName)` returns the metaInfo of the given metaName for the given doctype
`java.util.List<java.lang.String>`	`getMetaNames()` Returns all meta names that are supported by the current document type.
`static java.lang.String`	`getName(WGDocumentCore core)` Retrieves the name information for the given document core.
`java.lang.Object`	`getNativeObject()` Returns the native backend object of this document if there is one.
`java.util.Date`	`getObjectCreated()` Returns the time that this document object was created
`abstract Lockable`	`getParentLockable()` returns the parent lockable of this lockable for e.g.
`java.util.List<java.lang.String>`	`getPastAuthors()` Gets the names list for past authors of this document.
`java.util.List<java.util.Date>`	`getPastEditDates()` Gets the list of dates, when this document was edited in the past.
`java.util.Map<java.lang.String,java.lang.Object>`	`getPersistentStore()` Returns a map as persistent store for the implementation of this document.
`java.lang.String`	`getPrimaryFileName()` Returns the name of the primary attachment of this document The primary attachment is a file attachment that is regarded the main attachment of this document (to be interpreted in a custom way).
`int`	`getRevision()` Returns the revision number of this document.
`abstract int`	`getType()` Returns the type of this document as constant WGDocument.TYPE_...
`boolean`	`hasFile(java.lang.String name)` Tests if a file of this name is attached to the document.
`boolean`	`hasFileMetadata()` Determines if this document serves metadata for file attachments
`int`	`hashCode()`
`boolean`	`hasItem(java.lang.String itemName)` Tests if the document has an item of this name
`boolean`	`innerAttachFile(java.io.File file)`
`boolean`	`isCachingEnabled()` Tests if caching for this document is enabled.
`boolean`	`isCoreRetrieved()` Returns if the current documents holds a document core (i.e. a backend document)
`boolean`	`isDeleted()` Returns if this document has been deleted This method may choose to only check cached deletion flags for performance reasons.
`boolean`	`isDeleted(boolean forceBackendCheck)` Returns if this document has been deleted
`boolean`	`isDummy()` Returns, if this document is a "dummy content document", i.e. this document is nowhere stored in the database but is only temporarily created to provide a content context for the current request.
`boolean`	`isEdited()` Returns if the document was edited and the current state of the document is not yet saved.
`static boolean`	`isListMeta(int type, java.lang.String name)` Determines if the given metadata field should return lists or single values.
`boolean`	`isSaved()` Returns if the document has been saved to the database.
`boolean`	`isTemporary()` Tests if this document object is temporary and will be discarded after the session.
`void`	`lock()` locks the document for the current sessionContext
`void`	`lock(LockOwner owner)` locks the object for the given owner
`void`	`markEdited()` Manually sets this document as being edited.
`void`	`markMetaDataModified(WGFileMetaData md)` Informs the parent resource that the file metadata object is modified, so it is saveable
`boolean`	`mayPushExtData(java.lang.String extName)` checks if extension data may be "pushed".
`boolean`	`mayRemove()` Tests if the current user is allowed to remove the current document For getting more details about failure reasons for remove checks see `performRemoveCheck(boolean)`
`boolean`	`mayRemove(boolean deepCheck)` Tests if the current user is allowed to remove the current document For getting more details about failure reasons for remove checks see `performRemoveCheck(boolean)`
`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 `performSaveCheck()`
`void`	`performRemoveCheck()` Performs a validation for removing the document at the current state, just like it actually was removed.
`void`	`performRemoveCheck(boolean deepCheck)` Performs a validation for removing the document at the current state, just like it actually was removed.
`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.
`boolean`	`remove()` Remove the current document permanently from the database.
`void`	`removeAllExtensionData()` Convenience method to remove all extension data fields from the document at once
`void`	`removeAllFiles()` Convenience method to remove all file attachments from the document at once
`void`	`removeAllItems()` Convenience method to remove all items from the document at once
`void`	`removeExtensionData(java.lang.String strName)` Removes an extension data field from this entity
`boolean`	`removeFile(java.lang.String name)` Removes a file attachment from the document Note: When this method is called you should save the document before attempting to attach a new file of the same name.
`void`	`removeFileDerivate(java.lang.String id)` Deletes an existing file derivate
`void`	`removeItem(java.lang.String name)` Removes an item from the document
`void`	`renameFile(java.lang.String oldFileName, java.lang.String newFileName)` Renames a file exception on this document
`boolean`	`resultIsFalse(java.lang.Object exprResult)` Tests, if the given native expression result means "false" for this database implementation.
`boolean`	`resultIsTrue(java.lang.Object exprResult)` Tests, if the given native expression result means "true" for this database implementation.
`boolean`	`save()` Saved the current state of the document.
`boolean`	`save(java.util.Date lastModified)` Saves the current document with it's modifications.
`void`	`saveQuiet()` Saves the document without updating the last modified timestamp
`void`	`saveWithGivenTimestamps(java.util.Date created, java.util.Date modified)` Sets the given dates as created and modified dates of the document and saved it with them
`void`	`setCachingEnabled(boolean b)` Controls if item/meta caching is enabled for this document.
`WGDocument`	`setItem(java.lang.String name, java.lang.Object value)`
`WGDocument`	`setItems(java.util.Map<java.lang.String,java.lang.Object> values)`
`boolean`	`setItemValue(java.lang.String strName, java.lang.Object value)` Sets an item to the given value.
`WGDocument`	`setMeta(java.lang.String name, java.lang.Object value)`
`boolean`	`setMetaData(java.lang.String strName, java.lang.Object value)` Sets a meta data of this document.
`WGDocument`	`setMetas(java.util.Map<java.lang.String,java.lang.Object> values)`
`void`	`setMetaToDefault(java.lang.String metaName)` sets the given meta to the default value
`void`	`setPrimaryFileName(java.lang.String name)` Manually sets the primary attachment of this document
`WGDocument`	`setValues(java.util.Map<java.lang.String,java.lang.Object> values)`
`void`	`unlock()` unlocks the document for the current sessioncontext
`void`	`unlock(LockOwner owner)` unlock the object if it is locked by the given owner this method only delegates to LockOwner.releaseLock()
`boolean`	`validateMetas()` Variant of `validateMetas(boolean)` that performs no auto correction.
`boolean`	`validateMetas(boolean autoCorrection)` checks all metas of this document to ensure value and datatype correspond to the current api implementation.
`void`	`writeExtensionData(java.lang.String strName, java.lang.Object value)` Sets the value of an extension data field.
`void`	`writeFileDerivateMetaData(WGFileDerivateMetaData md)` Write modifications to derivate metadata to the derivate

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

- Field Detail
  - DERIVATE_NAME_PATTERN
```
public static java.util.regex.Pattern DERIVATE_NAME_PATTERN
```
  - CSFEATURE_EXTDATA
```
public static final java.lang.String CSFEATURE_EXTDATA
```
    Feature identifier for WGContentStoreVersionException regarding extension data operations
    
    See Also:
    Constant Field Values
  - META_CREATED
```
public static final java.lang.String META_CREATED
```
    See Also:
    Constant Field Values
  - METAINFO_CREATED
```
public static final MetaInfo METAINFO_CREATED
```
  - META_LASTMODIFIED
```
public static final java.lang.String META_LASTMODIFIED
```
    See Also:
    Constant Field Values
  - METAINFO_LASTMODIFIED
```
public static final MetaInfo METAINFO_LASTMODIFIED
```
  - META_REVISION
```
public static final java.lang.String META_REVISION
```
    See Also:
    Constant Field Values
  - METAINFO_REVISION
```
public static final MetaInfo METAINFO_REVISION
```
  - META_PASTAUTHORS
```
public static final java.lang.String META_PASTAUTHORS
```
    See Also:
    Constant Field Values
  - METAINFO_PASTAUTHORS
```
public static final MetaInfo METAINFO_PASTAUTHORS
```
  - META_PASTEDITDATES
```
public static final java.lang.String META_PASTEDITDATES
```
    See Also:
    Constant Field Values
  - METAINFO_PASTEDITDATES
```
public static final MetaInfo METAINFO_PASTEDITDATES
```
  - DOCKEY_DIVIDER
```
public static final java.lang.String DOCKEY_DIVIDER
```
    Divider character for WGDocumentKey strings, dividing the key parts
    
    See Also:
    Constant Field Values
  - TYPE_CONTENT
```
public static final int TYPE_CONTENT
```
    Document types of WGContent objects
    
    See Also:
    Constant Field Values
  - TYPE_STRUCTENTRY
```
public static final int TYPE_STRUCTENTRY
```
    Document types of WGStructEntry objects
    
    See Also:
    Constant Field Values
  - TYPE_AREA
```
public static final int TYPE_AREA
```
    Document types of WGArea objects
    
    See Also:
    Constant Field Values
  - TYPE_LANGUAGE
```
public static final int TYPE_LANGUAGE
```
    Document types of WGLanguage objects
    
    See Also:
    Constant Field Values
  - TYPE_CONTENTTYPE
```
public static final int TYPE_CONTENTTYPE
```
    Document types of WGContentType objects
    
    See Also:
    Constant Field Values
  - TYPE_TML
```
public static final int TYPE_TML
```
    Document types of WGTMLModule objects
    
    See Also:
    Constant Field Values
  - TYPE_CSSJS
```
public static final int TYPE_CSSJS
```
    Document types of WGCSSJSModule objects
    
    See Also:
    Constant Field Values
  - TYPE_FILECONTAINER
```
public static final int TYPE_FILECONTAINER
```
    Document types of WGFileContainer objects
    
    See Also:
    Constant Field Values
  - TYPE_USERPROFILE
```
public static final int TYPE_USERPROFILE
```
    Document types of WGUserProfile objects
    
    See Also:
    Constant Field Values
  - TYPE_ACLENTRY
```
public static final int TYPE_ACLENTRY
```
    Pseudo document type for ACL entries
    
    See Also:
    Constant Field Values
  - TYPE_DBMETADATA
```
public static final int TYPE_DBMETADATA
```
    Pseudo document type for database metadata (i.e. extension data on db level)
    
    See Also:
    Constant Field Values
  - TYPE_FILEDERIVATE
```
public static final int TYPE_FILEDERIVATE
```
    Pseudo document type for file derivate
    
    See Also:
    Constant Field Values
  - TYPENAME_CONTENT
```
public static final java.lang.String TYPENAME_CONTENT
```
    Document type name of WGContent objects
    
    See Also:
    Constant Field Values
  - TYPENAME_STRUCTENTRY
```
public static final java.lang.String TYPENAME_STRUCTENTRY
```
    Document type name of WGStructEntry objects
    
    See Also:
    Constant Field Values
  - TYPENAME_AREA
```
public static final java.lang.String TYPENAME_AREA
```
    Document type name of WGArea objects
    
    See Also:
    Constant Field Values
  - TYPENAME_LANGUAGE
```
public static final java.lang.String TYPENAME_LANGUAGE
```
    Document type name of WGLanguage objects
    
    See Also:
    Constant Field Values
  - TYPENAME_CONTENTTYPE
```
public static final java.lang.String TYPENAME_CONTENTTYPE
```
    Document type name of WGContentType objects
    
    See Also:
    Constant Field Values
  - TYPENAME_TML
```
public static final java.lang.String TYPENAME_TML
```
    Document type name of WGTMLModule objects
    
    See Also:
    Constant Field Values
  - TYPENAME_CSSJS
```
public static final java.lang.String TYPENAME_CSSJS
```
    Document type name of WGCSSJSModule objects
    
    See Also:
    Constant Field Values
  - TYPENAME_FILECONTAINER
```
public static final java.lang.String TYPENAME_FILECONTAINER
```
    Document type name of WGFileContainer objects
    
    See Also:
    Constant Field Values
  - TYPENAME_USERPROFILE
```
public static final java.lang.String TYPENAME_USERPROFILE
```
    Document type name of WGUserProfile objects
    
    See Also:
    Constant Field Values
  - TYPENAME_ACLENTRY
```
public static final java.lang.String TYPENAME_ACLENTRY
```
    Pseudo document type name for ACL entries
    
    See Also:
    Constant Field Values
  - TYPENAME_DBMETADATA
```
public static final java.lang.String TYPENAME_DBMETADATA
```
    Pseudo document type name for database metadata
    
    See Also:
    Constant Field Values
  - TYPENAME_FILEDERIVATE
```
public static final java.lang.String TYPENAME_FILEDERIVATE
```
    Pseudo document type name for file derivate
    
    See Also:
    Constant Field Values
  - EXTDATA_META_PREFIX
```
public static final java.lang.String EXTDATA_META_PREFIX
```
    Prefix for names of extension data fields that actually store document metadata fields
    
    See Also:
    Constant Field Values
  - EXT_PRIMARY_ATTACHMENT
```
public static final java.lang.String EXT_PRIMARY_ATTACHMENT
```
    extension data field which stores the "primary attachment" for this document in CS Versions > 5
    
    See Also:
    Constant Field Values
  - NOONE_ALLOWED
```
public static final java.lang.String NOONE_ALLOWED
```
    String used in WGStructEntry fields for edit access to symbolize that noone may edit this document.
    
    See Also:
    Constant Field Values
  - PAGERESTRICTION_UNSPECIFIED
```
public static final java.lang.String PAGERESTRICTION_UNSPECIFIED
```
    Restriction string for page positioning: No restriction set here, retrieve from "parent"
    
    See Also:
    Constant Field Values
  - PAGERESTRICTION_NONE
```
public static final java.lang.String PAGERESTRICTION_NONE
```
    Restriction string for page positioning: No pages allowed
    
    See Also:
    Constant Field Values
  - PAGERESTRICTION_ANY
```
public static final java.lang.String PAGERESTRICTION_ANY
```
    Restriction string for page positioning: Any page allowed
    
    See Also:
    Constant Field Values
  - PAGERESTRICTION_FIXEDTYPES
```
public static final java.lang.String PAGERESTRICTION_FIXEDTYPES
```
    Restriction string for page positioning: Pages of special content types allowed
    
    See Also:
    Constant Field Values
- Constructor Detail
  - WGDocument
```
public WGDocument(WGDatabase db,
          WGDocumentCore core)
           throws WGAPIException
```
    Throws:
    
    WGAPIException
  - WGDocument
```
public WGDocument(WGDatabase db,
          WGDocumentCore core,
          de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
           throws WGAPIException
```
    Constructor.
    
    Parameters:
    db -
    core -
    tempDuplicate -
    
    Throws:
    
    WGAPIException
- Method Detail
  - getMetaInfo
```
public MetaInfo getMetaInfo(java.lang.String metaName)
                     throws WGSystemException
```
    Returns the meta information for a given metadata field.
    
    Parameters:
    metaName - The name of the metadate field to return information for
    
    Returns:
    returns the MetaInfo for given metaName of this class
    
    Throws:
    
    WGSystemException - if the metaDataFramework cannot be accessed
  - getMetaInfoByType
```
public static MetaInfo getMetaInfoByType(int type,
                         java.lang.String metaName)
                                  throws WGSystemException,
                                         WGIllegalArgumentException
```
    returns the metaInfo of the given metaName for the given doctype
    
    Parameters:
    type -
    metaName -
    
    Returns:
    MetaInfo
    
    Throws:
    
    WGSystemException - if metaDataFramework access fails
    
    WGIllegalArgumentException - if type or metaName are invalid
  - getExpectedMetaClass
```
public static java.lang.Class<?> getExpectedMetaClass(int type,
                                      java.lang.String metaName)
                                               throws WGSystemException,
                                                      WGIllegalArgumentException
```
    Returns the expected data type of a metadata field
    
    Parameters:
    type - Document type for the metadata field
    metaName - Name of the metadata field
    
    Returns:
    Expected data type of the metadata as class object
    
    Throws:
    
    WGIllegalArgumentException
    
    WGSystemException
  - isListMeta
```
public static boolean isListMeta(int type,
                 java.lang.String name)
                          throws WGSystemException,
                                 WGIllegalArgumentException
```
    Determines if the given metadata field should return lists or single values.
    
    Parameters:
    type - Document type of metadata field
    name - Name of metadata field
    
    Returns:
    True, if the metadata field should return lists, false if it shouls return single values
    
    Throws:
    
    WGIllegalArgumentException
    
    WGSystemException
  - validateMetas
```
public boolean validateMetas(boolean autoCorrection)
                      throws WGAPIException
```
    checks all metas of this document to ensure value and datatype correspond to the current api implementation. Parameter autoCorrection can be used to automatically correct wrong metadata instead of throwing an exception.
    
    Throws:
    
    WGAPIException
  - validateMetas
```
public boolean validateMetas()
                      throws WGAPIException
```
    Variant of validateMetas(boolean) that performs no auto correction.
    
    Returns:
    true, if the metadata is valid
    
    Throws:
    
    WGAPIException
  - setMetaToDefault
```
public void setMetaToDefault(java.lang.String metaName)
                      throws WGAPIException
```
    sets the given meta to the default value
    
    Parameters:
    metaName -
    
    Throws:
    
    WGAPIException
  - buildDocumentKey
```
public static WGDocumentKey buildDocumentKey(WGDocumentCore core,
                             WGDatabase db)
                                      throws WGAPIException
```
    Builds the document key for a document core.
    
    Parameters:
    core -
    
    Throws:
    
    WGAPIException
  - getDocumentKey
```
public java.lang.String getDocumentKey()
```
    Returns the document key of this document, which is unique in this database among all documents.
  - getDocumentKeyObj
```
public WGDocumentKey getDocumentKeyObj()
```
    Returns a parsed document key object, ready to access single parts of the key
  - doctypeNameToNumber
```
public static int doctypeNameToNumber(java.lang.String name)
```
    Converts doctype names WGDocument.TYPENAME_... to number constants WGDocument.TYPE_...
    
    Parameters:
    name -
  - doctypeNumberToClass
```
public static java.lang.Class<?> doctypeNumberToClass(int number)
```
    Converts doctype numbers WGDocument.TYPE... to document type classes in WGAPI
    
    Parameters:
    number - The doctype number
  - docTypeClassToNumber
```
public static java.lang.Integer docTypeClassToNumber(java.lang.Class<?> clazz)
```
    Converts document type classes of the WGAPI to doctype numbers
    
    Parameters:
    clazz - the doctype class
  - doctypeNumberToName
```
public static java.lang.String doctypeNumberToName(int number)
```
    Converts doctype numbers WGDocument.TYPE_... to doctype names WGDocument.TYPENAME_...
    
    Parameters:
    number -
  - dropCache
```
public void dropCache()
               throws WGAPIException
```
    Drops the cache of this document.
    
    Throws:
    
    WGAPIException
  - getItemText
```
public java.lang.String getItemText(java.lang.String strName)
                             throws WGAPIException
```
    Returns a text item. If the item is not of type text it returns the text representation (obj.toString())
    
    Parameters:
    strName - Name of the item
    
    Throws:
    
    WGAPIException
  - getItemValue
```
public java.lang.Object getItemValue(java.lang.String strName)
                              throws WGAPIException
```
    Returns an item's value. If the item does not exist it returns null by default. You can modify this behaviour by database option "NoItemValue".
    
    Parameters:
    strName - Name of the item
    
    Throws:
    
    WGAPIException
  - getItemValueList
```
public java.util.List<?> getItemValueList(java.lang.String name)
                                   throws WGAPIException
```
    Returns an items value(s) always as list. If the item is not multivalue, this method returns a list containing only the single value.
    
    Parameters:
    name - The item's name
    
    Throws:
    
    WGAPIException
  - getItemNumber
```
public java.lang.Number getItemNumber(java.lang.String strName)
                               throws WGAPIException
```
    Retrieves a number item. If the item is not a number returns null.
    
    Parameters:
    strName - Name of the item.
    
    Throws:
    
    WGAPIException
  - getItemDate
```
public java.util.Date getItemDate(java.lang.String strName)
                           throws WGAPIException
```
    Retrieves the value of a date item. If the item is not of type date it returns null.
    
    Parameters:
    strName - Name of the item
    
    Throws:
    
    WGAPIException
  - setItemValue
```
public boolean setItemValue(java.lang.String strName,
                   java.lang.Object value)
                     throws WGAPIException
```
    Sets an item to the given value. If the item doesn't exist, it is created. Otherwise it's value gets overwritten.
    
    Parameters:
    strName - Name of the item
    value - Value of the item. Accepted values are dependent to the database implementation
    
    Returns:
    True, if the setting succeeded, false otherwise.
    
    Throws:
    
    WGAPIException
  - setMetaData
```
public boolean setMetaData(java.lang.String strName,
                  java.lang.Object value)
                    throws WGAPIException
```
    Sets a meta data of this document. Since there are "direct" methods for any metadata on the document subclasses, WGAPI users should not use this method directly, but prefer the direct methods. E.g. Use WGContent.setTitle("Home") instead of WGDocument.setMetaData(WGContent.META_TITLE, "Home")
    
    Parameters:
    strName - Name of the meta data. Use constants META_... of WGDocument and all descendant objects.
    value - Value to set this metadata
    
    Returns:
    True, if the setting succeeded, false otherwise
    
    Throws:
    
    WGAPIException
  - save
```
public boolean save(java.util.Date lastModified)
             throws WGAPIException
```
    Saves the current document with it's modifications. Special version only to be used inside WGAPI, e.g. for createClone.
    
    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
    
    WGValidationException
    
    LockException - - instance of ResourceIsLockedException if a process try to modifiy a locked object without obtaining a lock
    
    WGSystemException
    
    WGIllegalArgumentException
    
    WGAPIException
  - performSaveCheck
```
public void performSaveCheck()
                      throws WGAuthorisationException,
                             WGAPIException,
                             ResourceIsLockedException
```
    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 maySave().
    
    Throws:
    
    WGAPIException
    
    WGAuthorisationException
    
    ResourceIsLockedException
  - maySave
```
public boolean maySave()
                throws WGAPIException
```
    Tests if the current user is allowed to save the current document For getting more details about failure reasons for save checks see performSaveCheck()
    
    Throws:
    
    WGAPIException
  - mayRemove
```
public boolean mayRemove()
                  throws WGAPIException
```
    Tests if the current user is allowed to remove the current document For getting more details about failure reasons for remove checks see performRemoveCheck(boolean)
    
    Throws:
    
    WGAPIException
  - mayRemove
```
public boolean mayRemove(boolean deepCheck)
                  throws WGAPIException
```
    Tests if the current user is allowed to remove the current document For getting more details about failure reasons for remove checks see performRemoveCheck(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:
    
    WGAPIException
  - save
```
public boolean save()
             throws WGAPIException
```
    Saved the current state of the document.
    
    Throws:
    
    WGAPIException
  - evaluateExpression
```
public java.lang.Object evaluateExpression(java.lang.String expression)
                                    throws WGAPIException
```
    Evaluates a native expression with the current document as context.
    
    Parameters:
    expression - The expression
    
    Returns:
    The expression result.
    
    Throws:
    
    WGAPIException
  - getDatabase
```
public WGDatabase getDatabase()
```
    Returns the database that stores this document
  - getType
```
public abstract int getType()
```
    Returns the type of this document as constant WGDocument.TYPE_...
  - getMetaData
```
public java.lang.Object getMetaData(java.lang.String name)
                             throws WGAPIException
```
    Returns meta data about this document. Use constants META_... of WGDocument and all descendant objects. Since there are "direct" methods for any metadata on the document subclasses, WGAPI users should not use this method directly, but prefer the direct methods. E.g. Use WGContent.getTitle() instead of WGDocument.getMetaData(WGContent.META_TITLE)
    
    Returns:
    The meta data.
    
    Throws:
    
    WGAPIException
  - getExtdataMetaName
```
public static java.lang.String getExtdataMetaName(MetaInfo metaInfo)
```
    Returns the name that a metadata field has when stored as extension data
    
    Parameters:
    metaInfo - The metaInfo of the metadata field
  - getMetaDataList
```
public java.util.List<?> getMetaDataList(java.lang.String name)
                                  throws WGAPIException
```
    Returns meta data about this document. Use constants META_... of WGDocument and all descendant objects. Since there are "direct" methods for any metadata on the document subclasses, WGAPI users should not use this method directly, but prefer the direct methods. E.g. Use WGContent.getTitle() instead of WGDocument.getMetaData(WGContent.META_TITLE)
    
    Returns:
    The meta data as list.
    
    Throws:
    
    WGAPIException
  - getCreated
```
public java.util.Date getCreated()
                          throws WGAPIException
```
    Returns the creation date of this document
    
    Throws:
    
    WGAPIException
  - getLastModified
```
public java.util.Date getLastModified()
                               throws WGAPIException
```
    Returns the last modification date of the document
    
    Throws:
    
    WGAPIException
  - getCore
```
public WGDocumentCore getCore()
                       throws WGAPIException
```
    Returns the core implementation object for this document.
    
    Returns:
    Returns a WGDocument
    
    Throws:
    
    WGAPIException
  - isCoreRetrieved
```
public boolean isCoreRetrieved()
                        throws WGClosedSessionException
```
    Returns if the current documents holds a document core (i.e. a backend document)
    
    Throws:
    
    WGClosedSessionException
  - resultIsTrue
```
public boolean resultIsTrue(java.lang.Object exprResult)
```
    Tests, if the given native expression result means "true" for this database implementation.
  - resultIsFalse
```
public boolean resultIsFalse(java.lang.Object exprResult)
```
    Tests, if the given native expression result means "false" for this database implementation.
    
    Parameters:
    exprResult -
  - isTemporary
```
public boolean isTemporary()
```
    Tests if this document object is temporary and will be discarded after the session. This doesn't mean that the database document represented by this object will be deleted. It just means that there will be another document object for the database document in every session that accesses it.
  - isDeleted
```
public boolean isDeleted(boolean forceBackendCheck)
                  throws WGAPIException
```
    Returns if this document has been deleted
    
    Parameters:
    forceBackendCheck - Specify true if you want to enforce a check on the database backend. Otherwise WGAPI may choose to check cached deletion flags.
    
    Throws:
    
    WGAPIException
  - isDeleted
```
public boolean isDeleted()
                  throws WGAPIException
```
    Returns if this document has been deleted This method may choose to only check cached deletion flags for performance reasons. Use isDeleted(boolean) to force real backend check.
    
    Throws:
    
    WGAPIException
  - getFileNames
```
public java.util.List<java.lang.String> getFileNames()
                                              throws WGAPIException
```
    Returns a list of file attachment names for this document
    
    Throws:
    
    WGAPIException
  - removeAllFiles
```
public void removeAllFiles()
                    throws WGAPIException
```
    Convenience method to remove all file attachments from the document at once
    
    Throws:
    
    WGAPIException
  - attachAllFiles
```
public void attachAllFiles(WGDocument doc)
                    throws java.io.IOException,
                           WGAPIException
```
    Copies all attachments of the parameter document to the current document. This variant only copies the files themselves, not their extension data.
    
    Parameters:
    doc - The document to get attachments from
    
    Throws:
    
    java.io.IOException
    
    WGAPIException
  - attachAllFiles
```
public void attachAllFiles(WGDocument doc,
                  boolean copyExtensionData)
                    throws java.io.IOException,
                           WGAPIException
```
    Copies all attachments of the parameter document to the current document
    
    Parameters:
    doc - The document to get attachments from
    copyExtensionData - Specify true to also copy extension data from source to target. The sources extension data will overwrite eventual automatic annotations done on the attaching process.
    
    Throws:
    
    java.io.IOException
    
    WGAPIException
  - getFileData
```
public java.io.InputStream getFileData(java.lang.String strFile)
                                throws WGAPIException
```
    Returns the data of a file attachment as input stream Retrieving the data of a recently attached file while the document is not yet saved is not supported and may produce unknown results.
    
    Parameters:
    strFile - The name of the attachment
    
    Throws:
    
    WGAPIException
  - getFileMetaData
```
public WGFileMetaData getFileMetaData(java.lang.String strFile)
                               throws WGAPIException
```
    Returns the meta data object for the given filename
    
    Parameters:
    strFile -
    
    Returns:
    WGFileMetaData
    
    Throws:
    
    WGAPIException
  - getFileMimeType
```
public java.lang.String getFileMimeType(java.lang.String strFile)
                                 throws WGAPIException
```
    Returns the (primary) mime-type for the file of the given name. This method will try to use a previously stored mimetype from the files WGFileMetaData. If that does not exist it will fallback to mimetype determination based on file data.
    
    Parameters:
    strFile -
    
    Returns:
    String
    
    Throws:
    
    WGAPIException
  - getFileMimeTypes
```
public java.util.Collection<java.lang.String> getFileMimeTypes(java.lang.String strFile)
                                                        throws WGAPIException
```
    Returns all mime-types for the file of the given name. This method always determines mimetypes based on the file data. For a more performant determination use getFileMimeType(String).
    
    Parameters:
    strFile -
    
    Returns:
    Collection
    
    Throws:
    
    WGAPIException
  - getFileText
```
public java.io.Reader getFileText(java.lang.String strFile)
                           throws WGAPIException
```
    Deprecated. Use getFileText(String) which allows specifying an encoding
    
    Returns the contents of a file attachment in text format. Only valid if the file contains textual information. This tries to read the file in platform encoding.
    
    Parameters:
    strFile - The file attachment
    
    Returns:
    A reader object for the text information.
    
    Throws:
    
    WGAPIException
  - getFileText
```
public java.io.Reader getFileText(java.lang.String strFile,
                         java.lang.String encoding)
                           throws WGAPIException,
                                  java.io.UnsupportedEncodingException
```
    Returns the contents of a file attachment in text format. Only valid if the file contains textual information.
    
    Parameters:
    strFile - The file attachment
    encoding - The text encoding to use when interpreting the file data as text
    
    Returns:
    A reader object for the text information.
    
    Throws:
    
    WGAPIException
    
    java.io.UnsupportedEncodingException
  - getFileSize
```
public int getFileSize(java.lang.String strFile)
                throws WGAPIException
```
    Returns the size of an attachment in bytes. Returns -1 if a file of the given name is not available.
    
    Parameters:
    strFile - The file to retrieve size information for
    
    Throws:
    
    WGAPIException
  - getFileLastModified
```
public java.util.Date getFileLastModified(java.lang.String file)
                                   throws WGAPIException
```
    Provides the best (most specific) information about the last modified date of an individual file attachment. If file metadata is available the date is retrieved from there. Else the last modified date of the whole container is returned.
    
    Parameters:
    file - Name of the file attachment
    
    Returns:
    the most accurate last modified time for that file that is available
    
    Throws:
    
    WGAPIException
  - dropCore
```
public void dropCore()
              throws WGClosedSessionException
```
    Drops the retrieved document core (i.e. backend document), if there is one. This also discards any modifications done to this document that are not saved.
    
    Throws:
    
    WGClosedSessionException
  - getPersistentStore
```
public java.util.Map<java.lang.String,java.lang.Object> getPersistentStore()
```
    Returns a map as persistent store for the implementation of this document. An implementation can store data here that is not discarded when a session closes. Not for external use outside the WGAPI.
    
    Returns:
    Returns a HashMap
  - getName
```
public static java.lang.String getName(WGDocumentCore core)
                                throws WGAPIException
```
    Retrieves the name information for the given document core. Only works with areas, content (unique name), css/js modules, content types, file containers, languages, struct entries (struct keys) and TML modules
    
    Parameters:
    core -
    
    Throws:
    
    WGAPIException
  - hasItem
```
public boolean hasItem(java.lang.String itemName)
                throws WGAPIException
```
    Tests if the document has an item of this name
    
    Throws:
    
    WGAPIException
  - getItemNames
```
public java.util.List<java.lang.String> getItemNames()
                                              throws WGAPIException
```
    Retrieves a list of the names of all content items on this document
    
    Throws:
    
    WGAPIException
  - removeItem
```
public void removeItem(java.lang.String name)
                throws WGAPIException
```
    Removes an item from the document
    
    Parameters:
    name - Name of the item
    
    Throws:
    
    WGAPIException
  - attachFile
```
public boolean attachFile(java.io.File file,
                 java.util.List<WGFileAnnotator> additionalAnnotators)
                   throws WGAPIException
```
    Attaches a file to the document. The file will be stored at the document with the same name that it has in file system.
    
    Parameters:
    file - The file on disk.
    additionalAnnotators - Additional annotators to annotate the attached file with image information or custom fields. Specify null to use no additional annotators.
    
    Throws:
    
    WGAPIException
  - innerAttachFile
```
public boolean innerAttachFile(java.io.File file)
                        throws WGAPIException,
                               WGClosedSessionException
```
    Throws:
    
    WGAPIException
    
    WGClosedSessionException
  - attachFileWithoutAnnotation
```
public boolean attachFileWithoutAnnotation(java.io.File file)
                                    throws WGAPIException
```
    Attaches a file to the document without running any annotators
    
    Parameters:
    file - The file on disk.
    
    Throws:
    
    WGAPIException
  - attachFile
```
public boolean attachFile(java.io.File file)
                   throws WGAPIException
```
    Attaches a file to the document. The file will be stored at the document with the same name that it has in file system.
    
    Parameters:
    file - The file on disk.
    
    Throws:
    
    WGAPIException
  - renameFile
```
public void renameFile(java.lang.String oldFileName,
              java.lang.String newFileName)
                throws WGAPIException,
                       java.io.IOException
```
    Renames a file exception on this document
    
    Parameters:
    oldFileName - The current file name
    newFileName - The new file name
    
    Throws:
    
    WGAPIException
    
    java.io.IOException
  - attachFile
```
public boolean attachFile(java.io.InputStream stream,
                 java.lang.String filename)
                   throws WGAPIException,
                          java.io.IOException
```
    Takes data from an input stream and attaches the data as file under the given name. This actually is a wrapper for attachFile(File) that creates a temporary file of the desired name and attaches this. This is becaues some WGAPI implementations cannot attach a data stream directly but need a physical file.
    
    Parameters:
    stream - The input stream providing the file data
    filename - The file name under which the file will be attached
    
    Throws:
    
    WGAPIException
    
    java.io.IOException
  - attachFileWithoutAnnotation
```
public boolean attachFileWithoutAnnotation(java.io.InputStream stream,
                                  java.lang.String filename)
                                    throws WGAPIException,
                                           java.io.IOException
```
    Takes data from an input stream and attaches the data as file, without running any annotators under the given name. This actually is a wrapper for attachFileWithoutAnnotation(File) that creates a temporary file of the desired name and attaches this. This is becaues some WGAPI implementations cannot attach a data stream directly but need a physical file.
    
    Parameters:
    stream - The input stream providing the file data
    filename - The file name under which the file will be attached
    
    Throws:
    
    WGAPIException
    
    java.io.IOException
  - removeFile
```
public boolean removeFile(java.lang.String name)
                   throws WGAPIException
```
    Removes a file attachment from the document Note: When this method is called you should save the document before attempting to attach a new file of the same name. Some WGAPI implementations will throw exceptions when you remove and attach files of the same name without saving in between.
    
    Parameters:
    name - Name of the file attachment
    
    Throws:
    
    WGAPIException
  - remove
```
public final boolean remove()
                     throws WGAPIException
```
    Remove the current document permanently from the database.
    
    Returns:
    false if removal does not apply to this document, true otherwise
    
    Throws:
    
    WGAPIException
  - performRemoveCheck
```
public final void performRemoveCheck()
                              throws WGAuthorisationException,
                                     WGAPIException
```
    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 mayRemove(boolean). This remove check performs no exhaustive "deep" check, like can be triggered via performRemoveCheck(boolean).
    
    Throws:
    
    WGAuthorisationException
    
    WGAPIException
  - performRemoveCheck
```
public final void performRemoveCheck(boolean deepCheck)
                              throws WGAuthorisationException,
                                     WGAPIException
```
    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 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
  - createClone
```
public abstract WGDocument createClone(WGDatabase db,
                     WGDocument ref)
                                throws WGAPIException
```
    Creates a clone of this document in another database
    
    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
  - isCachingEnabled
```
public boolean isCachingEnabled()
```
    Tests if caching for this document is enabled. If so, the document caches item and metadata values.
  - setCachingEnabled
```
public void setCachingEnabled(boolean b)
```
    Controls if item/meta caching is enabled for this document.
    
    Parameters:
    b -
  - isSaved
```
public boolean isSaved()
                throws WGAPIException
```
    Returns if the document has been saved to the database. False means that it is a new document not yet persisted.
    
    Throws:
    
    WGAPIException
  - getPastAuthors
```
public java.util.List<java.lang.String> getPastAuthors()
                                                throws WGAPIException
```
    Gets the names list for past authors of this document. The indexing of the given list corresponds to the indexes of the lists given by getPastEditDates().
    
    Throws:
    
    WGAPIException
  - getPastEditDates
```
public java.util.List<java.util.Date> getPastEditDates()
                                                throws WGAPIException
```
    Gets the list of dates, when this document was edited in the past. The indexing of the given list corresponds to the indexes of the lists given by getPastAuthors().
    
    Throws:
    
    WGAPIException
  - getRevision
```
public int getRevision()
                throws WGAPIException
```
    Returns the revision number of this document.
    
    Throws:
    
    WGAPIException
  - getMetaNames
```
public java.util.List<java.lang.String> getMetaNames()
                                              throws WGSystemException
```
    Returns all meta names that are supported by the current document type.
    
    Throws:
    
    WGSystemException
  - getNativeObject
```
public java.lang.Object getNativeObject()
                                 throws WGAPIException
```
    Returns the native backend object of this document if there is one.
    
    Throws:
    
    WGAPIException
  - isEdited
```
public boolean isEdited()
                 throws WGClosedSessionException
```
    Returns if the document was edited and the current state of the document is not yet saved.
    
    Throws:
    
    WGClosedSessionException
  - markEdited
```
public void markEdited()
                throws WGClosedSessionException
```
    Manually sets this document as being edited. This is useful for making the document show up in WGSessionContext.getEditedDocuments().
    
    Throws:
    
    WGClosedSessionException
  - pushData
```
public void pushData(WGDocument doc)
              throws WGAPIException
```
    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.
    
    Parameters:
    doc - The target document receiving the data.
    
    Throws:
    
    WGAPIException - If something goes wrong
  - mayPushExtData
```
public boolean mayPushExtData(java.lang.String extName)
```
    checks if extension data may be "pushed". Returns true per default but may be overwritten by implementations
    
    Parameters:
    extName -
    
    Returns:
    true
  - isDummy
```
public boolean isDummy()
```
    Returns, if this document is a "dummy content document", i.e. this document is nowhere stored in the database but is only temporarily created to provide a content context for the current request.
    
    Returns:
    boolean
  - getCoreRetrieved
```
public java.util.Date getCoreRetrieved()
                                throws WGClosedSessionException
```
    Returns the time when the document core was retrieved in the current session. Is null if there has no core been retrieved yet.
    
    Throws:
    
    WGClosedSessionException
  - getObjectCreated
```
public java.util.Date getObjectCreated()
```
    Returns the time that this document object was created
  - hasFile
```
public boolean hasFile(java.lang.String name)
                throws WGAPIException
```
    Tests if a file of this name is attached to the document. This method should also consider file name conversions that take place when attaching. If this method returns true then attaching a file of this name will throw an error. Vice versa if this method returns false it is safe to attach a file of this name,.
    
    Parameters:
    name - The name of file to search
    
    Returns:
    true, if a file of this name (maybe in a converted form) exists
    
    Throws:
    
    WGAPIException
  - lock
```
public void lock(LockOwner owner)
          throws WGAPIException
```
    Description copied from interface: Lockable
    
    locks the object for the given owner
    
    Specified by:
    
    lock in interface Lockable
    
    Throws:
    
    WGAPIException - - instance of LockWaitTimeoutException when the lock request timed out
    See Also:
    - instance of ParentIsLockedException when the lock cannot be obtained because the parent object is already locked - other API Exceptions on API errors
  - lock
```
public void lock()
          throws WGAPIException
```
    locks the document for the current sessionContext
    
    Throws:
    
    WGAPIException
  - unlock
```
public void unlock(LockOwner owner)
```
    Description copied from interface: Lockable
    
    unlock the object if it is locked by the given owner this method only delegates to LockOwner.releaseLock()
    
    Specified by:
    
    unlock in interface Lockable
    
    Parameters:
    owner - - the LockOwner who has obtained the lock
  - unlock
```
public void unlock()
```
    unlocks the document for the current sessioncontext
  - getLockStatus
```
public int getLockStatus(LockOwner owner)
                  throws WGAPIException
```
    Description copied from interface: Lockable
    
    returns the current lockstatus of the lockable - if parent is set and locked the lockstatus is inherited
    
    Specified by:
    
    getLockStatus in interface Lockable
    
    Parameters:
    owner - - LockOwner who wants to retrieve his lockstatus for this document
    
    Returns:
    NOT_LOCKED, LOCKED_BY_FOREIGN_OBJECT or LOCKED_BY_THIS_OBJECT
    
    Throws:
    
    WGAPIException
  - getLockStatus
```
public int getLockStatus()
                  throws WGAPIException
```
    returns the lock status for the current sessioncontext
    
    Throws:
    
    WGAPIException
  - getParentLockable
```
public abstract 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
    
    Throws:
    
    WGAPIException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - removeAllItems
```
public void removeAllItems()
                    throws WGAPIException
```
    Convenience method to remove all items from the document at once
    
    Throws:
    
    WGAPIException
  - removeAllExtensionData
```
public void removeAllExtensionData()
                            throws WGAPIException
```
    Convenience method to remove all extension data fields from the document at once
    
    Throws:
    
    WGAPIException
  - saveWithGivenTimestamps
```
public void saveWithGivenTimestamps(java.util.Date created,
                           java.util.Date modified)
                             throws WGAPIException
```
    Sets the given dates as created and modified dates of the document and saved it with them
    
    Parameters:
    created - The created date
    modified - The modified date
    
    Throws:
    
    WGAPIException
  - saveQuiet
```
public void saveQuiet()
               throws WGAPIException
```
    Saves the document without updating the last modified timestamp
    
    Throws:
    
    WGAPIException
  - hasFileMetadata
```
public boolean hasFileMetadata()
                        throws WGAPIException
```
    Determines if this document serves metadata for file attachments
    
    Returns:
    true, if file metadata is available
    
    Throws:
    
    WGAPIException
  - getExtensionData
```
public java.lang.Object getExtensionData(java.lang.String strName)
                                  throws WGAPIException
```
    Description copied from interface: WGExtensionDataContainer
    
    Returns the value of an extension data field.
    
    Specified by:
    
    getExtensionData in interface WGExtensionDataContainer
    
    Parameters:
    strName - Name of the requested field.
    
    Returns:
    Object
    
    Throws:
    
    WGAPIException
  - getExtensionDataNames
```
public java.util.List<java.lang.String> getExtensionDataNames()
                                                       throws WGAPIException
```
    Description copied from interface: WGExtensionDataContainer
    
    Returns the names of all extension data fields on this entity
    
    Specified by:
    
    getExtensionDataNames in interface WGExtensionDataContainer
    
    Throws:
    
    WGBackendException
    
    WGAPIException
  - removeExtensionData
```
public void removeExtensionData(java.lang.String strName)
                         throws WGAPIException
```
    Description copied from interface: WGExtensionDataContainer
    
    Removes an extension data field from this entity
    
    Specified by:
    
    removeExtensionData in interface WGExtensionDataContainer
    
    Parameters:
    strName - Name of the field to remove.
    
    Throws:
    
    WGAPIException
  - writeExtensionData
```
public void writeExtensionData(java.lang.String strName,
                      java.lang.Object value)
                        throws WGAPIException
```
    Description copied from interface: WGExtensionDataContainer
    
    Sets the value of an extension data field.
    
    Specified by:
    
    writeExtensionData in interface WGExtensionDataContainer
    
    Parameters:
    strName - Name of the requested field.
    value - The value of the field
    
    Throws:
    
    WGAPIException
  - getPrimaryFileName
```
public java.lang.String getPrimaryFileName()
                                    throws WGAPIException
```
    Returns the name of the primary attachment of this document The primary attachment is a file attachment that is regarded the main attachment of this document (to be interpreted in a custom way). By default the primary attachment of a documents is the first attachment that was attached to it. Not all documents must feature a primary attachment. It can be manually set/changed via setPrimaryFileName(String).
    
    Throws:
    
    WGAPIException
  - setPrimaryFileName
```
public void setPrimaryFileName(java.lang.String name)
                        throws WGAPIException
```
    Manually sets the primary attachment of this document
    
    Parameters:
    name - The name of the file to become primary attachment. Use null to remove the current primary attachment reference (not the attachment itself)
    
    Throws:
    
    WGAPIException
  - getFileDerivates
```
public java.util.List<WGFileDerivateMetaData> getFileDerivates(java.lang.String fileName)
                                                        throws WGAPIException
```
    Returns a list of all available derivates for the specified file
    
    Parameters:
    fileName - The name of the file
    
    Returns:
    List of derivate metadata objects
    
    Throws:
    
    WGAPIException
  - markMetaDataModified
```
public void markMetaDataModified(WGFileMetaData md)
                          throws WGAPIException
```
    Description copied from interface: WGFileMetaDataContext
    
    Informs the parent resource that the file metadata object is modified, so it is saveable
    
    Specified by:
    
    markMetaDataModified in interface WGFileMetaDataContext
    
    Throws:
    
    WGAPIException
  - getFileDerivateMetaData
```
public WGFileDerivateMetaData getFileDerivateMetaData(java.lang.String id)
                                               throws WGAPIException
```
    Returns the metadata of a file derivate
    
    Parameters:
    id - ID of the derivate
    
    Throws:
    
    WGAPIException
  - writeFileDerivateMetaData
```
public void writeFileDerivateMetaData(WGFileDerivateMetaData md)
                               throws WGAPIException
```
    Write modifications to derivate metadata to the derivate
    
    Parameters:
    md - The modified metadata
    
    Throws:
    
    WGAPIException
  - getFileDerivateData
```
public java.io.InputStream getFileDerivateData(java.lang.String id)
                                        throws WGAPIException
```
    Returns the data of a file derivate
    
    Parameters:
    id - The derivate id
    
    Throws:
    
    WGAPIException
  - createFileDerivate
```
public WGFileDerivateMetaData createFileDerivate(java.lang.String fileName,
                                        java.lang.String creator,
                                        java.lang.String name,
                                        java.io.File file,
                                        java.lang.String usage,
                                        java.util.List<WGFileAnnotator> additionalAnnotators)
                                          throws WGAPIException
```
    Creates a new file derivate for an existing original file attachment
    
    Parameters:
    fileName - The name of the original file on the document
    creator - An ID of the creator class
    name - The name of the derivate to create
    file - The derivate data as file
    usage - The usage type of the derivate
    additionalAnnotators - Additional annotators to annotate the attached derivate with image information or custom fields. Specify null to use no additional annotators.
    
    Returns:
    Metadata of the created file derivate
    
    Throws:
    
    WGAPIException
  - createFileDerivate
```
public WGFileDerivateMetaData createFileDerivate(java.lang.String fileName,
                                        java.lang.String creator,
                                        java.lang.String derivateName,
                                        java.io.InputStream in,
                                        java.lang.String usage,
                                        java.util.List<WGFileAnnotator> additionalAnnotators)
                                          throws WGAPIException,
                                                 java.io.IOException
```
    Creates a new file derivate for an existing original file attachment
    
    Parameters:
    fileName - The name of the original file on the document
    creator - An ID of the creator class
    derivateName - The name of the derivate to create
    in - The data of the derivate
    usage - The usage type of the derivate
    additionalAnnotators - Additional annotators to run on the new derivate
    
    Returns:
    Metadata of the created file derivate
    
    Throws:
    
    java.io.IOException
    
    WGAPIException
  - removeFileDerivate
```
public void removeFileDerivate(java.lang.String id)
                        throws WGAPIException
```
    Deletes an existing file derivate
    
    Parameters:
    id - The derivate ID
    
    Throws:
    
    WGAPIException
  - getLastUpdates
```
public de.innovationgate.utils.SkippingIterator<WGUpdateLog> getLastUpdates()
                                                                     throws WGAPIException
```
    Returns update logs for the last updates done to this document, in descending chronological order
    
    Throws:
    
    WGAPIException
  - getFileParent
```
public WGDocument getFileParent()
```
    Description copied from interface: WGFileMetaDataContext
    
    Returns the parent document holding the file attachment, if possible
    
    Specified by:
    
    getFileParent in interface WGFileMetaDataContext
  - afterSave
```
public void afterSave(WGDocument.SaveAction action)
               throws WGAPIException
```
    Adds an action that will be executed after the document is saved the next time on this database session. This will also be done if that save happens in a transaction.
    
    Parameters:
    action - The action to execute
    
    Throws:
    
    WGAPIException
  - autoSave
```
public void autoSave()
              throws WGAPIException
```
    Marks the document to be automatically saved at the end of the session
    
    Throws:
    
    WGAPIException
  - setItem
```
public WGDocument setItem(java.lang.String name,
                 java.lang.Object value)
                   throws WGAPIException
```
    Throws:
    
    WGAPIException
  - setItems
```
public WGDocument setItems(java.util.Map<java.lang.String,java.lang.Object> values)
                    throws WGAPIException
```
    Throws:
    
    WGAPIException
  - setMeta
```
public WGDocument setMeta(java.lang.String name,
                 java.lang.Object value)
                   throws WGAPIException
```
    Throws:
    
    WGAPIException
  - setMetas
```
public WGDocument setMetas(java.util.Map<java.lang.String,java.lang.Object> values)
                    throws WGAPIException
```
    Throws:
    
    WGAPIException
  - setValues
```
public WGDocument setValues(java.util.Map<java.lang.String,java.lang.Object> values)
                     throws WGAPIException
```
    Throws:
    
    WGAPIException

Class WGDocument

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DERIVATE_NAME_PATTERN

CSFEATURE_EXTDATA

META_CREATED

METAINFO_CREATED

META_LASTMODIFIED

METAINFO_LASTMODIFIED

META_REVISION

METAINFO_REVISION

META_PASTAUTHORS

METAINFO_PASTAUTHORS

META_PASTEDITDATES

METAINFO_PASTEDITDATES

DOCKEY_DIVIDER

TYPE_CONTENT

TYPE_STRUCTENTRY

TYPE_AREA

TYPE_LANGUAGE

TYPE_CONTENTTYPE

TYPE_TML

TYPE_CSSJS

TYPE_FILECONTAINER

TYPE_USERPROFILE

TYPE_ACLENTRY

TYPE_DBMETADATA

TYPE_FILEDERIVATE

TYPENAME_CONTENT

TYPENAME_STRUCTENTRY

TYPENAME_AREA

TYPENAME_LANGUAGE

TYPENAME_CONTENTTYPE

TYPENAME_TML

TYPENAME_CSSJS

TYPENAME_FILECONTAINER

TYPENAME_USERPROFILE

TYPENAME_ACLENTRY

TYPENAME_DBMETADATA

TYPENAME_FILEDERIVATE

EXTDATA_META_PREFIX

EXT_PRIMARY_ATTACHMENT

NOONE_ALLOWED

PAGERESTRICTION_UNSPECIFIED

PAGERESTRICTION_NONE

PAGERESTRICTION_ANY

PAGERESTRICTION_FIXEDTYPES

Constructor Detail

WGDocument

WGDocument

Method Detail

getMetaInfo

getMetaInfoByType

getExpectedMetaClass

isListMeta

validateMetas

validateMetas

setMetaToDefault

buildDocumentKey

getDocumentKey

getDocumentKeyObj

doctypeNameToNumber

doctypeNumberToClass

docTypeClassToNumber

doctypeNumberToName

dropCache

getItemText

getItemValue

getItemValueList

getItemNumber

getItemDate

setItemValue

setMetaData

save

performSaveCheck

maySave