WGDatabase

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

All Implemented Interfaces:

AuthenticationSourceListener, Lockable, PageHierarchyNode, WGDesignChangeListener, WGExtensionDataContainer
```
public class WGDatabase
extends java.lang.Object
implements Lockable, WGDesignChangeListener, PageHierarchyNode, AuthenticationSourceListener, WGExtensionDataContainer
```
Represents a WGA Database. Can be a content database, design database, repository database, user profile database or a mixture of it. The Roles of a database give info about it's contents. Can be retrieved via getRoles().

Usage patterns:

Simple use:

This is recommended, when there are is only one stream of operation to be done and the used databases will not be opened again for a time.
WGDatabase db = WGFactory.getInstance().openDatabase(dbtype, dbpath, username, password, options); ... db actions ... db.close();
After db.close() the database object must not be used further.

Recurring and multithreaded use:

This is recommended when the opened databases should be reused at later time and/or will be used by multiple threads. This mode introduces the "database session", that will open a WGDatabase object for usage and can be closed without completely closing the database object and opened again later.
// Initial opening - Opens the database and implicitly a session too WGDatabase db = WGFactory.getInstance().openDatabase(dbtype, dbpath, username, password, options); ... db actions ... db.closeSession(); ... // Recurring opening - maybe in another thread using the same db object db.openSession(username, password) ... db actions ... db.closeSession(); ... // Final closing at the end of the program - No further WGA processing after that db.close();
This mode not only allows the WGAPI to keep database connections but also allows for caching of field values.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`WGDatabase.AccessLevel` Represents an ACL Access Level
`static class`	`WGDatabase.AccessLevelPrivilege` Represents an ACL privilege for an ACL level
`class`	`WGDatabase.AllDocumentsHierarchy`
`static interface`	`WGDatabase.ConnectAction`
`static interface`	`WGDatabase.DatabaseAction` An interface defining an action that can be execute on certain database events.
`class`	`WGDatabase.DocumentCollectionHierarchy`
`class`	`WGDatabase.FreeContentVersionFinder` Util class for finding the next free content version
`class`	`WGDatabase.NoItemBehaviour` Defines a behaviour for WGDatabases how they should respond to requests for nonexistent items
`class`	`WGDatabase.QueryCacheEntry` Represents an Entry in Query cache with all neccessary info
`class`	`WGDatabase.QueryCacheKey` Represents the key of a query cache entry, containing query type, query string and parameter
`class`	`WGDatabase.ReconfigurationAccessor`
`class`	`WGDatabase.SessionStatistic` Contains statistics about a WGA session.
`class`	`WGDatabase.WGCascadedTransaction`
`class`	`WGDatabase.WGDatabaseStatistics` Collects various statistics about this database.
`class`	`WGDatabase.WGFakeTransaction`
`class`	`WGDatabase.WGRealTransaction`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESSLEVEL_AUTHOR` User can create content documents but has no access to content documents, not created by him
`static int`	`ACCESSLEVEL_CHIEF_EDITOR` Full functional rights, restricted technical rights
`static int`	`ACCESSLEVEL_EDITOR` User can create new content documents, and edit existing ones that he didn't create.
`static int`	`ACCESSLEVEL_MANAGER` Full access, creation and administration rights.
`static int`	`ACCESSLEVEL_NOACCESS` User has not access to the database.
`static int`	`ACCESSLEVEL_NOTLOGGEDIN` User nas no valid login
`static int`	`ACCESSLEVEL_READER` User can read documents but cannot create or edit them.
`static java.util.Map<java.lang.Integer,WGDatabase.AccessLevel>`	`ACCESSLEVELS` Map of all access levels.
`static java.lang.String`	`ALNAME_AUTHOR` Accesslevel-Name for ACCESSLEVEL_AUTHOR
`static java.lang.String`	`ALNAME_CHIEF_EDITOR` Accesslevel-Name for ACCESSLEVEL_CHIEF_EDITOR
`static java.lang.String`	`ALNAME_EDITOR` Accesslevel-Name for ACCESSLEVEL_EDITOR
`static java.lang.String`	`ALNAME_MANAGER` Accesslevel-Name for ACCESSLEVEL_MANAGER
`static java.lang.String`	`ALNAME_NOACCESS` Accesslevel-Name for ACCESSLEVEL_NOACCESS
`static java.lang.String`	`ALNAME_NOTLOGGEDIN` Accesslevel-Name for ACCESSLEVEL_NOTLOGGEDIN
`static java.lang.String`	`ALNAME_READER` Accesslevel-Name for ACCESSLEVEL_READER
`static java.lang.String`	`ANONYMOUS_USER` Anonymous user name
`static java.lang.String`	`ATTRIB_UPDATED` Special DB attribute that is to be set while a batch process (e.g.
`static java.lang.String`	`AUTHENTICATED_GROUP` Name of the implicit "authenticated" group holding all users that were able to authenticate themselves
`static java.lang.String`	`BACKENDSERVICE_CLEAR_CONTENT` Service to clear all areas, struct entries and content documents from the content store in one fast batch operation.
`static java.lang.String`	`BACKENDSERVICE_CLEAR_CONTENT_AND_SCHEMA` Service to clear all content (areas, structs and contents) and schema (contenttypes and language definitions) from the content store in one fast batch operation.
`static java.lang.String`	`BACKENDSERVICE_CLEAR_DATABASE` Completely clears all data from the database, including all documents, the ACL, database metadata, historylog.
`static java.lang.String`	`BACKENDSERVICE_CLEAR_USERPROFILES` Service to clear all user profiles of the personalisation database in one fast batch operation.
`static java.lang.String`	`BACKENDSERVICE_DAILY_MAINTENANCE` A backend service defining some daily maintenance operation, to execute on the first event thread run each day
`static java.lang.String`	`BACKENDSERVICE_FETCH_MULTI_CONTENT` Fetches multiple contents in one backend call by their content key
`static java.lang.String`	`BACKENDSERVICE_NEW_CONTENT_VERSION` Service to effectively determine the version number for a new content document
`static java.lang.String`	`BACKENDSERVICE_PROBE_CONTENT` Checks if a content document for a certain page exists in a given language and status
`static java.lang.String`	`BACKENDSERVICE_SELECT_PENDINGRELEASE_DOCS` Selects all documents that are pending release.
`static java.lang.String`	`COPTION_ALLOWCACHEMAINTENANCE` Defines, if incremental cache maintenance is allowed for this database.
`static java.lang.String`	`COPTION_AUTOAPPROVE` Predefined creation option, controlling if the WGA workflow should automatically approve a document in workflow if it's publisher is also the approver
`static java.lang.String`	`COPTION_CACHELATENCY` Determines the latency of regular caches that expire after the given time (in minutes).
`static java.lang.String`	`COPTION_CACHEOVERFLOW` Deprecated.
`static java.lang.String`	`COPTION_CACHING_ENABLED` Defines if caching is globally enabled for this database, defaults to true.
`static java.lang.String`	`COPTION_CLUSTERED` Option to configure if this database is clustered if used in an OpenWGA server cluster
`static java.lang.String`	`COPTION_CONTENT_STORE_VERSION` Option to directly determine the content store version of this database
`static java.lang.String`	`COPTION_DBREFERENCE` Sets a db reference directly at creation time, so the WGAPI might use it from the start
`static java.lang.String`	`COPTION_DELETIONCHECK` Defines if an online deletion check for documents should be enabled which costs performance.
`static java.lang.String`	`COPTION_DESIGNPROVIDERTYPES` Specifies the document types that a design provider for the current db should provide, taking a commaseparated list of typenames of design documents.
`static java.lang.String`	`COPTION_DISABLE_CERTAUTH` Option to disable certificate authentication even when the auth module to use has certauth enabled
`static java.lang.String`	`COPTION_DOCUMENTCACHESIZE` Option to configure the maximum number of document objects to be kept in document cache
`static java.lang.String`	`COPTION_FAKE_CERTAUTH` Option to fake certificate authentication.
`static java.lang.String`	`COPTION_LEGACY_DBCP_MONITORING` Option to enable legacy DBCP 1 JMX monitoring, provided by WGA-own beans (actually only for databases using DBCP, ergo JDBC databases)
`static java.lang.String`	`COPTION_LIST_CACHE_REBUILD_THRESHOLD` Number of documents in a cache list that may need to be retrieved to rebuild the cache.
`static java.lang.String`	`COPTION_MANDATORY_READERS` Option to define users/groups/roles that should be able to read all documents no matter the contents of reader fields
`static java.lang.String`	`COPTION_MAXCORES` Predefined creation option, that defines how many "cores" (i.e. backend documents) a session may retrieve at once.
`static java.lang.String`	`COPTION_MEMORYCACHESIZE` Deprecated.
`static java.lang.String`	`COPTION_MONITORLASTCHANGE` Predefined creation option, that determines if the LastChange-Date of this database should be monitored to drop cache when it changes.
`static java.lang.String`	`COPTION_NAMECACHESIZE` Option to configure the maximum number of document names to be kept in name cache
`static java.lang.String`	`COPTION_NOITEMBEHAVIOUR` Determines the behaviour of this database and functionalitites that use this database regarding the retrieval of nonexistent items.
`static java.lang.String`	`COPTION_PAGEREADERS_ENABLED` Predefined creation option, controlling if hierarchical reader fields on areas and pages are in effect, defaulting to true.
`static java.lang.String`	`COPTION_PAGERIGHTSFILTER` Class name of a type that implements `PageRightsFilter` and is to be used as this
`static java.lang.String`	`COPTION_PROJECTMODE` Enables/Disables project mode.
`static java.lang.String`	`COPTION_QUERYCACHESIZE` Option to configure the maximum number of query results to be kept in query cache
`static java.lang.String`	`COPTION_READERPROFILECREATION` Determines if users at access level "READER" are allowed to create user profiles in this database
`static java.lang.String`	`COPTION_SHAREDPOOL` Determines if this database may use a shared connection pool on servers which have one available.
`static java.lang.String`	`COPTION_UPDATETIMEOUT` Predefined creation option, determining how many seconds the update monitoring should pause after an update has been processed.
`static java.lang.String`	`COPTION_USERCACHELATENCY` Determines the latency of user specific caches that expire after the given time (in minutes).
`static java.lang.String`	`COPTION_USERCACHES_ENABLED` Controls usage of user caches, which will cache user authorisation results for some time.
`static java.lang.String`	`COPTION_WORKFLOWENGINE` Predefined creation option, that determines the class name of a workflow engine to use.
`static java.lang.String`	`COPTION_XML` Deprecated.
`static double`	`CSVERSION_NO_CONTENTSTORE` Content store version identifying a database that is no content store at all
`static double`	`CSVERSION_WGA3` Content store version identifying a content store used as of WGA version 3.0
`static double`	`CSVERSION_WGA4_1` Content store version identifying a content store used as of WGA version 4.1, including optimized file handling
`static double`	`CSVERSION_WGA5` Content store version identifying a content store used as of WGA version 5
`static java.lang.String`	`DEFAULT_MEDIAKEY` The default media key
`static int`	`DOCUMENTCACHE_SIZE_DEFAULT`
`static java.lang.String`	`EXTDATA_CS_SYNC_RUNNING`
`static java.lang.String`	`EXTDATA_DATABASE_UUID`
`static java.lang.String`	`EXTDATA_DERIVATE_CREATORS`
`static java.lang.String`	`EXTDATA_DERIVATE_REVISION`
`static java.lang.String`	`EXTDATA_PATCH_LEVEL`
`static java.lang.String`	`FEATURE_ACCEPTS_STRUCTKEYS` Controls if this implementation's newly created struct entries can accept keys from the creator
`static java.lang.String`	`FEATURE_ACL_MANAGEABLE` ACL of this database is manageable via WGAPI
`static java.lang.String`	`FEATURE_AUTOCASCADES_DELETIONS` Automatically cascades deletions (i.e. deletes all dependent documents), so that the WGAPI doesn't need to do that
`static java.lang.String`	`FEATURE_COMPLEXVALUES` Content database can store complex values beyond string, number an dates and performs type checking itself
`static java.lang.String`	`FEATURE_CONTENT_FILE_DERIVATES` Determines if the database is able to store derivates to content file attachments
`static java.lang.String`	`FEATURE_CONTENT_READ_PROTECTION` Indicates if the database knows any kind of user-specific content read protection, so that content caches must be individual for every user
`static java.lang.String`	`FEATURE_CONTENT_RELATIONS` determines if the database supports real content relations
`static java.lang.String`	`FEATURE_CREATEABLE` Use the WGAPI to create a new database of this type (Method WGFactory.createDatabase())
`static java.lang.String`	`FEATURE_DIRECT_ENTITY_READDING` Determines if the database supports removing and re-adding a subentity (item, relation, file attachments) without intermittent save
`static java.lang.String`	`FEATURE_DISABLE_META_LOWERCASING` Enabling this feature will disable the lowercasing of metadata field values for fields that normally enforce this.
`static java.lang.String`	`FEATURE_EDITABLE` Database is editable i.e. can modify data of it's backend
`static java.lang.String`	`FEATURE_EXTERNAL_AUTHENTICATION` Shows if this database relies on authentication modules for external authentication.
`static java.lang.String`	`FEATURE_FIND_UPDATED_DOCS` Find updated documents since a cutoff date by core-method getUpdateDocumentsSince
`static java.lang.String`	`FEATURE_FULLCONTENTFEATURES` Content database has content types, struct entries, is multilingual and maintains content versioning, so content document creation must receive and generate all this info.
`static java.lang.String`	`FEATURE_GENERATES_STRUCTKEYS` Controls, if this implementations's newly created struct entries can generate their own keys
`static java.lang.String`	`FEATURE_HIERARCHICAL` Content can be navigated hierarchical / is hierarchically ordered
`static java.lang.String`	`FEATURE_LASTCHANGED` Content database maintains a last changed property, that should be monitored to track database changes.
`static java.lang.String`	`FEATURE_LOADBALANCE` determines that the underlying core has the feature to loadbalance connections to multiple db servers, in this case connections are by default readonly and each db updates have to be initialized by calling beginUpdate()
`static java.lang.String`	`FEATURE_MILLISECOND_PRECISION` determines if the database implementation has the ability to return document changes and modified dates on millisecond precision
`static java.lang.String`	`FEATURE_MULTILANGUAGE` Controls, if this implementation holds content in multiple languages
`static java.lang.String`	`FEATURE_NATIVEEXPRESSIONS` DB has a native expression language
`static java.lang.String`	`FEATURE_ORDERED_NAVIGATION_RESULTS` Determines if a database returns ordered results on hierarchy navigation methods `WGDatabaseCore.getRootEntries(WGArea, WGPageOrderSet)` and `WGDatabaseCore.getChildEntries(WGStructEntry, WGPageOrderSet)`, allowing the fetching of partial results
`static java.lang.String`	`FEATURE_PERFORMS_BACKEND_LOGIN` Controls if this implementation is able to perform a backend login, i.e. the core itself logs in with the user's login data.
`static java.lang.String`	`FEATURE_PROVIDE_PORTLETITEM_STORAGE` Determines if a database is able to return meta `WGUserProfile.META_PORTLETITEMSTORAGE`, a storage service for items of transient portlets
`static java.lang.String`	`FEATURE_QUERY_PROFILES` Shows, if this implementation supports querying user profiles by method queryUserProfileNames
`static java.lang.String`	`FEATURE_QUERYABLE` Content supports query languages.
`static java.lang.String`	`FEATURE_REDUCE_CALLBACKS` This feature instructs the WGAPI to reduce callbacks to the database on some occassions where it is unlikely necessary to connect (Should increase performance on implementations with slow database connections)
`static java.lang.String`	`FEATURE_RETRIEVE_ALL_CONTENTKEYS` Controls if this WGAPI implementation implements the getAllContentKeys() method
`static java.lang.String`	`FEATURE_SELF_PERSONALIZABLE` The content store is able to also store user profiles and be its own "personalisation database"
`static java.lang.String`	`FEATURE_SESSIONTOKEN` Controls if this implementation can take session tokens for a login
`static java.lang.String`	`FEATURE_STORESVARS` Content database needs temporary storage of webtml variables in content documents (e.g. to allow native expression languages to access them)
`static java.lang.String`	`FEATURE_TRANSACTIONS` Content database supports transactions
`static java.lang.String`	`FEATURE_UNLIMITED_CORES` Feature that will prevent the WGAPI from limiting the fetched cores for a session Should be set for DBs where limiting on WGAPI level makes no sense
`static java.lang.String`	`FEATURE_UNPATCHEABLE` Marks databases that should not be patched, f.e. because they are read-only
`static java.lang.String`	`FEATURE_USE_OBJECTS_AS_REFERENCES` Controls the behaviour when setting object relations for newly created objects.
`static java.lang.String`	`FEATURE_VALIDATE_ATTACHMENTS` determines if documents in this database has the ability to validate file attachments by calling doc.validateAttachments();
`static java.lang.String`	`MASTER_USERNAME` The user name that is returned for the user of a WGA master session
`static int`	`NAMECACHE_SIZE_DEFAULT`
`static java.lang.String`	`PORTLETREGISTRYMODE_PERSISTENT` Portlet registry mode "persistent" where registrations are stored on the user profile and persisted.
`static java.lang.String`	`PORTLETREGISTRYMODE_TRANSIENT` Portlet registry mode "transient", where registrations are only kept for each individual request.
`static java.lang.String`	`PROFILEQUERY_TYPE_ALL` Query type for `queryUserProfileNames(String, String, Map)` that retrieves all existent user profiles
`static java.util.List<java.lang.String>`	`PROTECTED_DATABASE_EXTDATA` Extension data fields on the database which are no regular data and do not represent any database state and should be protected from data deletion operations
`static int`	`QUERYCACHE_SIZE_DEFAULT`
`static java.lang.String`	`QUERYOPTION_CACHERESULT` Cache the results of queries.
`static java.lang.String`	`QUERYOPTION_ENHANCE` Enhance the query with default settings (e.g. not to retrieve documents that are set invisible).
`static java.lang.String`	`QUERYOPTION_EXCLUDEDOCUMENT` When set, excludes the WGContent object given as option value from the query result
`static java.lang.String`	`QUERYOPTION_FETCHSIZE` A query option used on non-iterating query types, determining the size of a results fetch page to retrieve from the backend
`static java.lang.String`	`QUERYOPTION_LANGUAGES` Injects a priority list of languages to return in the query.
`static java.lang.String`	`QUERYOPTION_MAXRESULTS` Controls the maximum results of the query.
`static java.lang.String`	`QUERYOPTION_NATIVEOPTIONS` Takes native options for the database implementation as commaseparated key=value-Pairs.
`static java.lang.String`	`QUERYOPTION_ONLYLANGUAGE` Set to a specific language code to reduce query results to content of this language
`static java.lang.String`	`QUERYOPTION_ONLYRELEASED` Set to Boolean(true), to reduce query results to only released content
`static java.lang.String`	`QUERYOPTION_QUERY_PARAMETERS` This query option contains a map with query parameters, whose values should be used by the underlying query mechanism to fill parameter parts in the query text.
`static java.lang.String`	`QUERYOPTION_RETURNQUERY` This is an output option set by the implementation, that carries the complete query that was executed, as it was modified by the implementation.
`static java.lang.String`	`QUERYOPTION_ROLE` Set to the role, that this query should act as, filtering contents that should be invisible to that role.
`static java.lang.String`	`QUERYOPTION_USEDCACHE` The occurence of this queryoption in the query parameters after the execution of the query shows, that the result set was retrieved from query cache
`static java.util.Map<java.lang.Integer,WGDatabase.AccessLevel>`	`REAL_ACCESSLEVELS` Map of "real" access levels, which are available for new ACLs entries
`static java.lang.String`	`ROLE_CONTENT` Database serves content and supplementary docs like content type, language if it is a full content store
`static java.lang.String`	`ROLE_DESIGN` Database servers design documents (WebTML, CSS/JS)
`static java.lang.String`	`ROLE_REPOSITORY` Database serves file containers
`static java.lang.String`	`ROLE_USERPROFILES` Database servers user profiles
`static java.lang.String`	`SESSIONTOKEN_USER` Dummy user name that is used in openSession-Method to insert a session token.
`static java.lang.String`	`SYSPROPERTY_MAINTAIN_OPERATIONKEYS` Java system property to enable/disable automatic operation key maintaining
`static java.lang.String`	`SYSPROPERTY_VERBOSE_BACKENDACCESS` Sysproperty to enable verbose backend access
`static java.lang.String`	`SYSPROPERTY_VERBOSE_BACKENDACCESS_DOCTYPES` Sysproperty to configure the doctypes for verbose backend access, as commaseparated typename list
`static java.lang.String`	`SYSPROPERTY_VERBOSE_CACHEMANAGEMENT` Java system property for turning on verbose cachemanagement in applog
`static java.lang.String`	`SYSPROPERTY_VERBOSE_MUTABLECLONING` Java system property for turning on verbose output when a mutable object needs to be cloned in WGAPI
`static java.lang.String`	`UNKNOWN_REMOTE_USER` Dummy user name that is used on request based authmodules if request.getRemoteUser() returns 'null'
`static java.util.Set<java.lang.String>`	`USER_BACKENDSERVICES` Backend services that are allowed to be called under user session

Method Summary

Methods
Modifier and Type	Method and Description
`static WGDatabase.AccessLevel`	`accessLevel(int levelCode)` Returns access level information for the given access level code
`static int`	`accessLevelCode(java.lang.String levelName)` Converts access level names WGDatabase.ALNAME_... to codes WGDatabase.ACCESSLEVEL_...
`static java.lang.String`	`accessLevelText(int levelCode)` Converts access level access level names WGDatabase.ALNAME_... to codes WGDatabase.ACCESSLEVEL_...
`void`	`addBackendChangeListener(WGBackendChangeListener listener)` Adds a listener for backend changes to the database
`void`	`addContentEventListener(WGContentEventListener listener)` Adds a listener for content events to the database.
`void`	`addDatabaseConnectListener(WGDatabaseConnectListener listener)` Adds a listener for the connection of this database to its backend.
`void`	`addDatabaseEventListener(WGDatabaseEventListener listener)` Registers a listerer for database events.
`void`	`addDesignChangeListener(WGDesignChangeListener changeListener)` Adds a design change listener to this database.
`void`	`addWorkflowEventListener(WGWorkflowEventListener listener)` Adds a listener for workflow events to the database
`void`	`annotateMetadata(java.io.File file, WGFileMetaData meta, java.util.List<WGFileAnnotator> additionalAnnotators)` Tool method for annotating a metadata object based on the given file, using the default and optionally given additional annotators
`static boolean`	`anyoneAllowed(java.util.List users)` Given a list of user/group names from an access control field (e.g.
`static boolean`	`anyoneAllowed(java.util.List users, boolean emptyMeansYes)` Given a list of user/group names from an access control field (e.g.
`void`	`authenticationDataChanged()` Callback method on a change in the authentication data backend
`boolean`	`beginTransaction()` Deprecated. Use `startTransaction()`
`void`	`beginUpdate()` Notify database of the beginning of update operations via this connection.
`java.lang.Object`	`callBackendService(java.lang.String serviceName, java.lang.Object[] params)` Calls a backend service whose support is optional.
`java.lang.Comparable`	`catchupBackendChanges()` checks for backend changes
`boolean`	`certAuthEnabled()` Determines if certificate authentication is enabled for this database
`void`	`clearContentData()` Completely clears this document of all content related documents, which is all contents, struct entries, areas, content types and languages WARNING (in case this has not yet become clear): This single method call will delete ALL documents of the given types in the database!
`void`	`clearUserCaches()` Clears all user-specific caches.
`void`	`close()` Completely closes this database object.
`void`	`closeSession()` Closes the database session.
`boolean`	`commitTransaction()` Deprecated. Use `WGTransaction.commit()`
`WGArea`	`createArea(java.lang.String name)` Creates a new area definition.
`WGContent`	`createContent()` Creates a simple content document.
`WGContent`	`createContent(java.lang.String title)` Creates a simple content document.
`WGContent`	`createContent(WGArea area, java.lang.Object key, java.lang.String title)` Creates a simple content document with the content key given.
`WGContent`	`createContent(WGStructEntry entry, WGLanguage language, java.lang.String title)` Creates a new content document.
`WGContentType`	`createContentType(java.lang.String name)` Creates a new content type.
`WGCSSJSModule`	`createCSSJSModule(java.lang.String name, java.lang.String type)` Creates a new Script module
`WGContent`	`createDraftCopy(WGContent content)` Creates a draft copy of the given content document, keeping it's language
`WGContent`	`createDraftCopy(WGContent content, WGLanguage language)` Creates a draft copy of the given content, using the language given as parameter.
`WGFileContainer`	`createFileContainer(java.lang.String name)` Creates a new file container.
`WGLanguage`	`createLanguage(java.lang.String name)` Creates a new language definition only by name, which is also used as title
`WGLanguage`	`createLanguage(java.lang.String name, java.lang.String title)` Creates a new language definition.
`WGCSSJSModule`	`createMetadataModule(java.lang.String name)` Creates a new metadata module.
`void`	`createPageSequence(WGStructEntry struct, boolean forceCreate)`
`WGSchemaDefinition`	`createSchemaDefinition()` Creates a schema definition containing all content types and areas in this database with their current metadata.
`WGScriptModule`	`createScriptModule(java.lang.String name, java.lang.String type)` Create a new script module.
`WGStructEntry`	`createStructEntry(java.lang.Object key, WGDocument parent, WGContentType contentType, java.lang.String title)` Creates a new struct entry
`WGStructEntry`	`createStructEntry(WGDocument parent, WGContentType contentType, java.lang.String title)` Equivalent to calling createStructKey(null, parent, contentType, title).
`WGTMLModule`	`createTMLModule(java.lang.String name, java.lang.String mediaKey)` Creates a new TML module.
`WGUserProfile`	`createUserProfile(java.lang.String userNameWish, int type)` Creates a new user profile.
`WGUserProfile`	`createUserProfile(java.lang.String userNameWish, int type, boolean forceNew)` Creates a new user profile.
`WGUserDetails`	`defaultBuildUserDetails(AuthenticationSession authSession)` Default implementation for building user details for an authentication session.
`boolean`	`defaultIsMemberOfUserList(java.util.List userList)` Default implementation for determining user list membership.
`static boolean`	`defaultIsMemberOfUserList(java.util.List userListOrig, WGUserDetails userDetails)` Default implementation for determining user list membership against any custom user details object.
`void`	`designChanged(WGDesignChangeEvent event)` The design of a design core provider or the database has changed.
`void`	`determineDefaultLanguage()` Trigger the determination of a default language.
`void`	`dropAllDocumentCores(boolean untimelyDispose)` Called to drop all retrieved document cores for this session at once.
`void`	`enforceSchema(WGSchemaDefinition schemaDef)` Enforces the given schema definition on the database
`void`	`enforceVersionCompliance(java.lang.String compliance, boolean enforceNoItemBehaviour)` Enforces the given version compliance behaviour on this database
`java.util.List`	`fireWorkflowEvent(WGWorkflowEvent event)` Fires a workflow event.
`WGACL`	`getACL()` Retrieves a WGACL object which manages the access control to this database.
`java.util.Iterator<WGContent>`	`getAllContent()` Returns an Iterator iterating over all content documents in this database does not include archived documents
`java.util.Iterator<WGContent>`	`getAllContent(boolean includeArchived)` Returns an Iterator iterating over all content documents in this database
`java.util.List`	`getAllContentKeys(boolean includeArchived)` Returns a list of all content keys in the current database.
`java.util.Iterator`	`getAllUserProfileNames()` Returns the names of all user profiles that are stored in the personalisation database
`WGContent`	`getAnyContentByName(java.lang.String name)` Returns a content with the given name in any language.
`WGArea`	`getArea(java.lang.String strName)` Returns the area with the given name
`WGAreaMap`	`getAreas()` Returns a map of all areas of this database, mapped by their area name.
`java.lang.Object`	`getAttribute(java.lang.String name)` Returns a custom attribute set to this database.
`java.util.Set`	`getAttributeNames()` Returns the names of all database attributes as a Set
`AuthenticationModule`	`getAuthenticationModule()` Returns the authentication module used to authenticate sessions, if this database supports and uses a auth module.
`java.lang.Comparable`	`getBackendRevision()` Returns the revision state of the database backend.
`boolean`	`getBooleanAttribute(java.lang.String name, boolean defaultValue)` Returns the boolean value of an attribute, accepting boolean objects and those string representations that are converted by WGUtils.stringToBoolean().
`de.innovationgate.utils.SkippingIterator<PageHierarchyNode>`	`getChildNodeIterator(int pageSize)` Returns an iterator for the child nodes of this hierarchy node
`java.util.List`	`getChildNodes()` Returns the child nodes of this hierarchy node
`java.lang.Class`	`getChildNodeType()` Return the class type of child nodes
`Version`	`getComplianceVersion()` Returns the WGA version whose behaviour is enforced on this database via `enforceVersionCompliance(String, boolean)`
`WGContent`	`getContentByKey(java.lang.String keyStr)` Return a content document by content key string.
`WGContent`	`getContentByKey(WGContentKey key)` Return a content document by content key
`WGContent`	`getContentByName(java.lang.String name)` Retrieves a content by it's unique name in the database's default language.
`WGContent`	`getContentByName(java.lang.String strName, java.lang.String strLanguage)` Retrieves a content by it's unique name.
`java.util.List`	`getContentEventListeners()` Returns the list of content event listeners for this database.
`int`	`getContentStorePatchLevel()` Returns the patch level of this content store.
`double`	`getContentStoreVersion()` Returns the version of content store that this database represents, i.e the version of its storage format.
`WGContentType`	`getContentType(java.lang.String name)` Returns a content type document of the given name
`java.util.List<WGContentType>`	`getContentTypes()` Returns a list with all content types stored in this database
`WGDatabaseCore`	`getCore()` Returns the core implementation object of this database.
`java.util.Map`	`getCreationOptions()` Returns the map of creation options provided to this database when it was initially opened
`WGScriptModule`	`getCSSJSModule(java.lang.String name)` Returns the script module of the given name.
`WGScriptModule`	`getCSSJSModule(java.lang.String name, java.lang.String type)` Returns the script module of the given name and type
`java.util.List`	`getCSSJSModules()` Returns the script modules in this database.
`java.util.List`	`getCurrentBackendOperations()` Returns the operation keys of backend operations that are currently running
`java.lang.String`	`getDbReference()` Returns a database reference to be used throughout the application (in WGA: the database key)
`java.lang.String`	`getDefaultLanguage()` Returns the default language of this database
`WGDesignDocument`	`getDesignObject(int type, java.lang.String strName)` Returns a design object with the given information.
`WGDesignDocument`	`getDesignObject(int type, java.lang.String strName, java.lang.String mediaKey)` Returns a design object with the given information
`java.util.List<? extends WGDesignDocument>`	`getDesignObjects(int type)` Returns all design objects of a specific type.
`WGDesignProvider`	`getDesignProvider()` Returns an external design provider that was set to this database, if available
`WGDocument`	`getDocumentByDocumentKey(java.lang.String key)` Deprecated. Use `getDocumentByKey(String)` instead
`WGDocument`	`getDocumentByDocumentKeyFromCache(java.lang.String documentKeyStr)` Returns a document by it's document key, only if it is contained in cache.
`WGDocument`	`getDocumentByDocumentKeyFromCache(WGDocumentKey documentKey)` Returns a document by it's document key, only if it is contained in cache.
`WGDocument`	`getDocumentByKey(java.lang.String key)` Returns a document by the given document key.
`WGDocument`	`getDocumentByKey(WGDocumentKey documentKey)` Returns a document by the given document key.
`WGContent`	`getDummyContent(java.lang.String language)` Retrieves a dummy content object.
`WGUserProfile`	`getDummyProfile(java.lang.String name)` Returns a dummy profile object that does not store information.
`java.lang.Object`	`getExtensionData(java.lang.String name)` Retrieves the value of an extension data field stored in this database.
`java.util.List<java.lang.String>`	`getExtensionDataNames()` Returns the names of stored extension data fields on this database This feature is only available in WGA Content Stores of Version 5 or higher.
`java.util.List<WGFileAnnotator>`	`getFileAnnotators()` Returns the currently active file annotators on this database
`WGFileContainer`	`getFileContainer(java.lang.String name)` Return the file container of the given name
`java.util.List<WGFileContainer>`	`getFileContainers()` Returns the list of file containers in this database
`WGFileConverter`	`getFileConverter()`
`WGContent`	`getFirstReleasedContent(java.lang.String language)` Returns the first released content of the given language to be found in this database.
`WGContent`	`getFirstReleasedContent(java.lang.String language, boolean onlyRoots)` Returns the first released content document of this database in the specified language.
`WGContent`	`getFirstReleasedContent(WGLanguageChooser chooser, boolean onlyRoots)` Returns the first released content document of this database.
`WGLanguage`	`getLanguage(java.lang.String name)` Returns the language of that name (code) if it exists.
`WGLanguage`	`getLanguageForLocale(java.util.Locale locale)` Retrieves the best matching language definition for the given locale.
`java.util.Map<java.lang.String,WGLanguage>`	`getLanguages()` Returns a map of WGLanguage objects, mapped by their language name (code)
`java.util.Date`	`getLastCacheMaintenance()` Returns the system time where the last cache maintenance happened
`java.util.Date`	`getLastChanged()` Returns date, where data in the database was last changed.
`int`	`getLockStatus()` gets the lockstatus 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.util.List<java.lang.String>`	`getMandatoryReaders()` Returns a list of readers that automatically have read access to all read-protected documents
`java.lang.String`	`getMasterLoginName()` Gets the name of the master login, which is the login user name used with the initial call to WGDatabase.open().
`java.lang.String`	`getMasterLoginPassword()` Returns the password of the master login used to open this database.
`int`	`getMaxCores()` Returns the maximum cores (i.e. backend document) that a session is allowed to hold at once.
`WGScriptModule`	`getMetadataModule(java.lang.String name)` A metadata module is a special version of a script module that is used to store metadata about the state of the database.
`java.lang.Object`	`getNativeObject()` Returns the native backend object for this database if there is one.
`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.
`WGDatabase.NoItemBehaviour`	`getNoItemBehaviour()` Returns the currently configured behaviour of this database regarding the request of nonexistent items
`java.util.Map`	`getOperationKeys()` Returns a map of operation keys currently or recently in usage
`PageRightsFilter`	`getPageRightsFilter()`
`WGStructEntry`	`getParentEntry(WGStructEntry entry)` Returns the parent entry to the given struct entry
`Lockable`	`getParentLockable()` returns the parent lockable of this lockable for e.g.
`PageHierarchyNode`	`getParentNode()` Return the parent of this node in hierarchy.
`java.lang.String`	`getPath()` Returns the database path, given as parameter of the method WGDatabase.open()
`WGPersonalisationDatabaseCore`	`getPersonalisationCore()` Returns the personalisation core implementation of this database, if it is a personalisation database.
`java.util.List`	`getRecentBackendOperations()` Returns the operation keys of backend operations that have run and are not yet cleant up
`java.lang.Comparable`	`getRevision()` Returns the revision state of the database.
`java.util.Date`	`getRevisionDate(java.lang.Comparable lastModified)` Retrieve the datetime where a given database revision was done.
`WGDatabaseRevision`	`getRevisionObject()` Returns the revision state of the database as an high level object, usable for revision comparison and storage independently from the concrete backend type of revision value Just like `getRevision()` this returns the revision state of the database that is safely represented by all caches.
`java.util.List`	`getRoles()` Returns the roles of this db implementation, describing what documents can be found in it.
`WGSchemaDefinition`	`getSchemaDefinition()` Returns the schema definition in effect on this database
`WGCSSJSModule`	`getScriptModule(java.lang.String name)` Returns the script module of the given name and any codetype
`WGScriptModule`	`getScriptModule(java.lang.String name, java.lang.String codetype)` Returns the script module of the given name and codetype
`java.util.List<WGScriptModule>`	`getScriptModules()` Returns the script modules in this database.
`WGSequence`	`getSequence(java.lang.String sequenceName)` Returns an WGAPI sequence object for the given sequence name.
`WGDatabaseServer`	`getServer()` Returns the server used to connect to this database
`java.lang.String`	`getServerName()` Returns the name of the database server (if there is one).
`WGSessionContext`	`getSessionContext()` Returns the session context, providing all data about the currently opened database session.
`org.apache.commons.collections.SortedBag`	`getSessionStatistics()` Returns collected statistics of sessions that exceeded the maxdocs threshold.
`WGDatabase.WGDatabaseStatistics`	`getStatistics()` Returns an object containing internal statistics about the database
`WGStructEntry`	`getStructEntryByKey(java.lang.Object structKey)` Returns a struct entry by it's struct key
`WGStructEntry`	`getStructEntryByName(java.lang.String strName)` Retrieves a struct entry which has the given unique name This method will only return struct entries if they themselves own the unique name, not if any content of them owns it.
`WGStructEntry`	`getStructEntryBySequence(long seq)` Returns a struct entry by it's page sequence
`java.lang.String`	`getTitle()` Returns the title of this database (if there is one).
`WGTMLModule`	`getTMLModule(java.lang.String name, java.lang.String mediaKey)` Returns the TML module for the given name and media key
`java.util.List<WGTMLModule>`	`getTMLModules()` Returns the list of TML modules in this database.
`java.lang.String`	`getType()` Returns the imlementation type (i.e. the class name of the database core implementation)
`java.lang.String`	`getTypeName()` Returns a descriptive type name of the database implementation used.
`java.util.List<WGUpdateLog>`	`getUpdatedDocumentsSince(java.lang.Comparable cutoff)` Retrieves logs of documents that were modified since a cutoff revision.
`java.util.List<java.lang.String>`	`getUsedSequenceNames()` Returns the names of sequences that are initialized and/or in use
`de.innovationgate.utils.UserHashMap`	`getUserCache()` Returns a HashMap that will store userdefined data for the currently logged in user.
`int`	`getUserCacheLatency()` Returns the user cache latency in minutes.
`de.innovationgate.utils.UserHashMapGroup`	`getUserHashMapGroup()` Returns the group of UserHashMaps for this database.
`WGUserProfile`	`getUserProfile(java.lang.String name)` Retrieves a user profile for the given profile name.
`java.lang.String`	`getUUID()` Returns a universal ID for the current database.
`WGWorkflowEngine`	`getWorkflowEngine()` Gets the workflow engine object for this database.
`boolean`	`hasAttribute(java.lang.String name)` Tests if the database contains an attribute of the given name
`boolean`	`hasContents(WGStructEntry entry)` Returns if the given struct entry contains a content document.
`boolean`	`hasFeature(java.lang.String featureName)` Queries the database for specific features.
`boolean`	`isAllowDesignModification()` Returns if this database allows modification of design documents for the current session This method returs false if any of the doctypes file container, script or tml module are not modifiable.
`boolean`	`isAnonymousAccessible()` Returns if the database can be accessed by anonymous users
`boolean`	`isAutoApprove()` Returns if automatic approval is enabled, see `COPTION_AUTOAPPROVE`.
`boolean`	`isBackendServiceSupported(java.lang.String serviceName)` Returns if a backend service is supported
`boolean`	`isCachingEnabled()` Indicates, if document caching is enabled globally for the database
`boolean`	`isConnected()` Returns if this database is already connected to its backend.
`boolean`	`isContentEmpty()` Returns if this database has neither content hierarchy (areas, struct entries, contents) nor content schema documents (content types, languages) and can be regarded "content-empty"
`boolean`	`isContentRole()` Returns, if the database contains content
`boolean`	`isDatabaseUpdatedInBackground()` Returns if the database has been updated in background and caches may not reflect the most up-to-date state, because cache management has not yet processed these updates
`boolean`	`isDeletionCheck()` Returns if backend deletion checks are enabled, see `COPTION_DELETIONCHECK`
`static boolean`	`isDesignDocumentType(int docType)` Tests if the given document type is the type of a design document, i.e.
`boolean`	`isDesignEmpty()` Returns if this database has no design documents (file containers, script modules, WebTML modules) and can be regarded "design-empty".
`boolean`	`isDesignRole()` Returns if the database contains design documents
`boolean`	`isDoctypeModifiable(int type)` Tests if documents of a given doctypes are modifiable for the current session
`boolean`	`isEmpty()` Determines if this database is completely empty of (content store) documents.
`boolean`	`isMemberOfUserList(java.util.List list)` Tests, if the current user can be associated with any entry in the list.
`boolean`	`isPageReadersEnabled()` Returns if visibility constraints of the hierarchical reader fields on areas and pages are enabled
`boolean`	`isProjectMode()` Returns if project mode is enabled, see `COPTION_PROJECTMODE`
`boolean`	`isReaderProfileCreation()` Returns if users with reader access to this profile database may create profile documents.
`boolean`	`isReady()` Returns, if the database is ready for work.
`boolean`	`isRepositoryRole()` Returns if if the database contains file containers.
`boolean`	`isSessionOpen()` Indicates if a database session is open
`boolean`	`isUserProfilesRole()` Indicates if the database contains user profiles
`void`	`lock()` locks the database for the current sessioncontext
`void`	`lock(LockOwner owner)` locks the object for the given owner
`void`	`maintenance(boolean fullMaintenance)`
`boolean`	`monitorLastChange()` Shows, if the database monitors the last change date of the backend database to maintain caches.
`boolean`	`moveStructEntry(WGStructEntry entry, WGDocument newParent)` Moves a struct entry to a new position.
`WGOperationKey`	`obtainOperationKey(int operation, java.lang.Object key)` Returns on operation key for syncing of backend access.
`boolean`	`onConnect(WGDatabase.ConnectAction action)` Deprecated. Use `onConnect(DatabaseAction)`
`boolean`	`onConnect(WGDatabase.DatabaseAction action)` Registers an action that should be executed when the database is connected.
`int`	`openAnonymousSession()` Opens a session as anonymous user
`int`	`openAnonymousSession(java.lang.String accessFilter)` Opens a session as anonymous user, including an access filter
`int`	`openSession()` Opens a new session with master login.
`int`	`openSession(java.lang.String user, java.lang.Object credentials)` Opens a new session.
`int`	`openSession(java.lang.String user, java.lang.Object credentials, java.lang.String filter)`
`int`	`openSession(java.lang.String user, java.lang.Object credentials, java.lang.String filter, javax.servlet.http.HttpServletRequest request)` Opens a new session.
`int`	`openSession(java.security.cert.X509Certificate cert, java.lang.String filter)` Opens a new session using a certificate for login.
`java.lang.Object`	`parseStructKey(java.lang.String key)` Parses the string representation of a struct key (e.g. used in a URL) to the real internal struct key format
`void`	`performContentCreationCheck(WGStructEntry entry, WGLanguage language)` Controls if the current user may create a content document with the given data.
`void`	`performDesignCreationCheck(int type, java.lang.String name, java.lang.String mediaKey)` Controls if the current user may create a design document with the given data.
`void`	`performStructCreationCheck(java.lang.Object key, WGDocument parent, WGContentType contentType)` Controls if the current user may create a struct entry with the given data.
`void`	`performStructMoveCheck(WGStructEntry entry, WGDocument newParent)` Controls if the current user may move a struct entry to the given new parent.
`static void`	`putDefaultOption(java.util.Map options, java.lang.String key, java.lang.Object value)` Sets an option to a map if it is not already set
`WGAbstractResultSet`	`query(java.lang.String type, java.lang.String query, java.util.Map parameters)` Executes a query in the database giving a result set of content documents in return.
`java.util.List`	`queryUserProfileNames(java.lang.String query)` Queries a user profile database for stored profiles, based on their data.
`java.util.List`	`queryUserProfileNames(java.lang.String type, java.lang.String query, java.util.Map params)` Queries a user profile database for stored profiles, based on their data.
`void`	`refresh()` Refreshes the data in database, testing for changes in the backend and clearing all caches.
`void`	`releasePendingContents()` Fetches all content documents pending release and releases those that are ready to be released
`java.lang.Object`	`removeAttribute(java.lang.String name)` Removes a database attribute.
`void`	`removeBackendChangeListener(WGBackendChangeListener listener)` Removes a listener for backend changes from the database
`void`	`removeContentEventListener(WGContentEventListener listener)` Removes a content event listener.
`void`	`removeDatabaseConnectListener(WGDatabaseConnectListener listener)` Removes a listener for the connection of this database to its backend
`void`	`removeDatabaseEventListener(WGDatabaseEventListener listener)` Removes a database event listener.
`void`	`removeDesignChangeListener(WGDesignChangeListener changeListener)` Removes a design change listener to this database.
`void`	`removeExtensionData(java.lang.String name)` Removes a extension data field from the database.
`void`	`removeWorkflowEventListener(WGWorkflowEventListener listener)` Removes a workflow event listener.
`int`	`reopenSession()` Closes and reopens the session with the current logged in user.
`int`	`reopenSession(java.lang.String username, java.lang.Object credentials)` Closes and reopens the session with the given user information
`int`	`reopenSession(java.lang.String username, java.lang.Object credentials, java.lang.String filter)` Closes and reopens the session with the given user information
`boolean`	`rollbackTransaction()` Deprecated. use `WGTransaction.rollback()`
`void`	`setAllowDesignModification(boolean allowDesignUpdates)` Sets if this database should allow modification of design documents This call equals calling `setDoctypeModifiable(int, boolean)` for the doctypes file container, script and tml module to false.
`void`	`setAttribute(java.lang.String name, java.lang.Object obj)` Sets a custom attribute to the database.
`void`	`setAuthenticationModule(AuthenticationModule authenticationModule)` Injects an authentication module to the database that should be used to authenticate users.
`void`	`setAutoApprove(boolean autoApprove)` Sets if automatic approval is enabled
`void`	`setCachingEnabled(boolean b)` Controls if the document caching is enabled for this database.
`void`	`setDbReference(java.lang.String dbReference)` Sets a reference for this database to use throughout the application.
`void`	`setDefaultLanguage(java.lang.String defaultLanguage)` Manually set a default language for this database
`void`	`setDesignProvider(WGDesignProvider designProvider)` Sets an external design provider from which this database should retrieve design documents.
`void`	`setDoctypeModifiable(int type, boolean modifiable)` Sets if documents of a given doctype are modifiable for non-master sessions Functionalities that feed the design of a database with external data might want to disable modifiability of those types that are served.
`void`	`setFileAnnotators(java.util.List<WGFileAnnotator> annotators)` Sets annotators which are called when files are attached to this database and is able to annotate the file with additional information
`void`	`setFileConverter(WGFileConverter conv)`
`void`	`setPageRightsFilter(PageRightsFilter pageRightsFilter)`
`void`	`setTitle(java.lang.String string)` Sets the title of the database.
`WGTransaction`	`startTransaction()` Starts a transaction and returns a transaction object.
`java.lang.String`	`toLowerCaseMeta(java.lang.String meta)` Lowercases a metadata field value for this database if metadata lowercasing is not disabled
`void`	`unlock()` unlocks the database 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()
`void`	`visit(WGPageVisitor visitor)` Implements the visitor pattern on the page hierarchy.
`void`	`writeExtensionData(java.lang.String name, java.lang.Object value)` Writes a extension data field.

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

- Field Detail
  - EXTDATA_DATABASE_UUID
```
public static final java.lang.String EXTDATA_DATABASE_UUID
```
    See Also:
    Constant Field Values
  - EXTDATA_PATCH_LEVEL
```
public static final java.lang.String EXTDATA_PATCH_LEVEL
```
    See Also:
    Constant Field Values
  - EXTDATA_DERIVATE_CREATORS
```
public static final java.lang.String EXTDATA_DERIVATE_CREATORS
```
    See Also:
    Constant Field Values
  - EXTDATA_DERIVATE_REVISION
```
public static final java.lang.String EXTDATA_DERIVATE_REVISION
```
    See Also:
    Constant Field Values
  - EXTDATA_CS_SYNC_RUNNING
```
public static final java.lang.String EXTDATA_CS_SYNC_RUNNING
```
    See Also:
    Constant Field Values
  - PROTECTED_DATABASE_EXTDATA
```
public static final java.util.List<java.lang.String> PROTECTED_DATABASE_EXTDATA
```
    Extension data fields on the database which are no regular data and do not represent any database state and should be protected from data deletion operations
  - DOCUMENTCACHE_SIZE_DEFAULT
```
public static final int DOCUMENTCACHE_SIZE_DEFAULT
```
    See Also:
    Constant Field Values
  - NAMECACHE_SIZE_DEFAULT
```
public static final int NAMECACHE_SIZE_DEFAULT
```
    See Also:
    Constant Field Values
  - QUERYCACHE_SIZE_DEFAULT
```
public static final int QUERYCACHE_SIZE_DEFAULT
```
    See Also:
    Constant Field Values
  - CSVERSION_NO_CONTENTSTORE
```
public static final double CSVERSION_NO_CONTENTSTORE
```
    Content store version identifying a database that is no content store at all
    
    See Also:
    Constant Field Values
  - CSVERSION_WGA3
```
public static final double CSVERSION_WGA3
```
    Content store version identifying a content store used as of WGA version 3.0
    
    See Also:
    Constant Field Values
  - CSVERSION_WGA4_1
```
public static final double CSVERSION_WGA4_1
```
    Content store version identifying a content store used as of WGA version 4.1, including optimized file handling
    
    See Also:
    Constant Field Values
  - CSVERSION_WGA5
```
public static final double CSVERSION_WGA5
```
    Content store version identifying a content store used as of WGA version 5
    
    See Also:
    Constant Field Values
  - AUTHENTICATED_GROUP
```
public static final java.lang.String AUTHENTICATED_GROUP
```
    Name of the implicit "authenticated" group holding all users that were able to authenticate themselves
    
    See Also:
    Constant Field Values
  - COPTION_MEMORYCACHESIZE
```
public static final java.lang.String COPTION_MEMORYCACHESIZE
```
    Deprecated.
    
    Predefined creation option, determining how many cache entries the WGAPI cache is allowed to hold in memory. Defaults to 2000.
    
    See Also:
    Constant Field Values
  - COPTION_CACHEOVERFLOW
```
public static final java.lang.String COPTION_CACHEOVERFLOW
```
    Deprecated.
    
    Predefined creation option, controlling of the WGAPI Cache is allowed to use disk overflow functionality, as far as the implementation supports this. Defaults to false.
    
    See Also:
    Constant Field Values
  - COPTION_AUTOAPPROVE
```
public static final java.lang.String COPTION_AUTOAPPROVE
```
    Predefined creation option, controlling if the WGA workflow should automatically approve a document in workflow if it's publisher is also the approver
    
    See Also:
    Constant Field Values
  - COPTION_PAGEREADERS_ENABLED
```
public static final java.lang.String COPTION_PAGEREADERS_ENABLED
```
    Predefined creation option, controlling if hierarchical reader fields on areas and pages are in effect, defaulting to true. Setting this to false may improve performance but will let those feld be ignored.
    
    See Also:
    Constant Field Values
  - COPTION_USERCACHES_ENABLED
```
public static final java.lang.String COPTION_USERCACHES_ENABLED
```
    Controls usage of user caches, which will cache user authorisation results for some time. Disable this if your user may have differing aliases, groups and roles with each request.
    
    See Also:
    Constant Field Values
  - COPTION_PAGERIGHTSFILTER
```
public static final java.lang.String COPTION_PAGERIGHTSFILTER
```
    Class name of a type that implements PageRightsFilter and is to be used as this
    
    See Also:
    Constant Field Values
  - SYSPROPERTY_VERBOSE_CACHEMANAGEMENT
```
public static final java.lang.String SYSPROPERTY_VERBOSE_CACHEMANAGEMENT
```
    Java system property for turning on verbose cachemanagement in applog
    
    See Also:
    Constant Field Values
  - SYSPROPERTY_VERBOSE_MUTABLECLONING
```
public static final java.lang.String SYSPROPERTY_VERBOSE_MUTABLECLONING
```
    Java system property for turning on verbose output when a mutable object needs to be cloned in WGAPI
    
    See Also:
    Constant Field Values
  - SYSPROPERTY_MAINTAIN_OPERATIONKEYS
```
public static final java.lang.String SYSPROPERTY_MAINTAIN_OPERATIONKEYS
```
    Java system property to enable/disable automatic operation key maintaining
    
    See Also:
    Constant Field Values
  - SYSPROPERTY_VERBOSE_BACKENDACCESS
```
public static final java.lang.String SYSPROPERTY_VERBOSE_BACKENDACCESS
```
    Sysproperty to enable verbose backend access
    
    See Also:
    Constant Field Values
  - SYSPROPERTY_VERBOSE_BACKENDACCESS_DOCTYPES
```
public static final java.lang.String SYSPROPERTY_VERBOSE_BACKENDACCESS_DOCTYPES
```
    Sysproperty to configure the doctypes for verbose backend access, as commaseparated typename list
    
    See Also:
    Constant Field Values
  - COPTION_UPDATETIMEOUT
```
public static final java.lang.String COPTION_UPDATETIMEOUT
```
    Predefined creation option, determining how many seconds the update monitoring should pause after an update has been processed. Defaults to 5 seconds.
    
    See Also:
    Constant Field Values
  - COPTION_DBREFERENCE
```
public static final java.lang.String COPTION_DBREFERENCE
```
    Sets a db reference directly at creation time, so the WGAPI might use it from the start
    
    See Also:
    Constant Field Values
  - ALNAME_NOTLOGGEDIN
```
public static final java.lang.String ALNAME_NOTLOGGEDIN
```
    Accesslevel-Name for ACCESSLEVEL_NOTLOGGEDIN
    
    See Also:
    Constant Field Values
  - ALNAME_READER
```
public static final java.lang.String ALNAME_READER
```
    Accesslevel-Name for ACCESSLEVEL_READER
    
    See Also:
    Constant Field Values
  - ALNAME_NOACCESS
```
public static final java.lang.String ALNAME_NOACCESS
```
    Accesslevel-Name for ACCESSLEVEL_NOACCESS
    
    See Also:
    Constant Field Values
  - ALNAME_MANAGER
```
public static final java.lang.String ALNAME_MANAGER
```
    Accesslevel-Name for ACCESSLEVEL_MANAGER
    
    See Also:
    Constant Field Values
  - ALNAME_EDITOR
```
public static final java.lang.String ALNAME_EDITOR
```
    Accesslevel-Name for ACCESSLEVEL_EDITOR
    
    See Also:
    Constant Field Values
  - ALNAME_CHIEF_EDITOR
```
public static final java.lang.String ALNAME_CHIEF_EDITOR
```
    Accesslevel-Name for ACCESSLEVEL_CHIEF_EDITOR
    
    See Also:
    Constant Field Values
  - ALNAME_AUTHOR
```
public static final java.lang.String ALNAME_AUTHOR
```
    Accesslevel-Name for ACCESSLEVEL_AUTHOR
    
    See Also:
    Constant Field Values
  - ACCESSLEVELS
```
public static final java.util.Map<java.lang.Integer,WGDatabase.AccessLevel> ACCESSLEVELS
```
    Map of all access levels. This also includes access levels not allowed for usage in ACL entries, like NOTLOGGEDIN, and duplicate mappings because of obsolete access levels
  - REAL_ACCESSLEVELS
```
public static final java.util.Map<java.lang.Integer,WGDatabase.AccessLevel> REAL_ACCESSLEVELS
```
    Map of "real" access levels, which are available for new ACLs entries
  - ANONYMOUS_USER
```
public static final java.lang.String ANONYMOUS_USER
```
    Anonymous user name
    
    See Also:
    Constant Field Values
  - SESSIONTOKEN_USER
```
public static final java.lang.String SESSIONTOKEN_USER
```
    Dummy user name that is used in openSession-Method to insert a session token. The token then should be entered as password.
    
    See Also:
    Constant Field Values
  - UNKNOWN_REMOTE_USER
```
public static final java.lang.String UNKNOWN_REMOTE_USER
```
    Dummy user name that is used on request based authmodules if request.getRemoteUser() returns 'null'
    
    See Also:
    Constant Field Values
  - DEFAULT_MEDIAKEY
```
public static final java.lang.String DEFAULT_MEDIAKEY
```
    The default media key
    
    See Also:
    Constant Field Values
  - ACCESSLEVEL_NOTLOGGEDIN
```
public static final int ACCESSLEVEL_NOTLOGGEDIN
```
    User nas no valid login
    
    See Also:
    Constant Field Values
  - ACCESSLEVEL_NOACCESS
```
public static final int ACCESSLEVEL_NOACCESS
```
    User has not access to the database.
    
    See Also:
    Constant Field Values
  - ACCESSLEVEL_READER
```
public static final int ACCESSLEVEL_READER
```
    User can read documents but cannot create or edit them.
    
    See Also:
    Constant Field Values
  - ACCESSLEVEL_AUTHOR
```
public static final int ACCESSLEVEL_AUTHOR
```
    User can create content documents but has no access to content documents, not created by him
    
    See Also:
    Constant Field Values
  - ACCESSLEVEL_EDITOR
```
public static final int ACCESSLEVEL_EDITOR
```
    User can create new content documents, and edit existing ones that he didn't create.
    
    See Also:
    Constant Field Values
  - ACCESSLEVEL_CHIEF_EDITOR
```
public static final int ACCESSLEVEL_CHIEF_EDITOR
```
    Full functional rights, restricted technical rights
    
    See Also:
    Constant Field Values
  - ACCESSLEVEL_MANAGER
```
public static final int ACCESSLEVEL_MANAGER
```
    Full access, creation and administration rights.
    
    See Also:
    Constant Field Values
  - QUERYOPTION_ENHANCE
```
public static final java.lang.String QUERYOPTION_ENHANCE
```
    Enhance the query with default settings (e.g. not to retrieve documents that are set invisible). Set to Boolean(true/false).
    
    See Also:
    Constant Field Values
  - QUERYOPTION_ONLYRELEASED
```
public static final java.lang.String QUERYOPTION_ONLYRELEASED
```
    Set to Boolean(true), to reduce query results to only released content
    
    See Also:
    Constant Field Values
  - QUERYOPTION_ONLYLANGUAGE
```
public static final java.lang.String QUERYOPTION_ONLYLANGUAGE
```
    Set to a specific language code to reduce query results to content of this language
    
    See Also:
    Constant Field Values
  - QUERYOPTION_EXCLUDEDOCUMENT
```
public static final java.lang.String QUERYOPTION_EXCLUDEDOCUMENT
```
    When set, excludes the WGContent object given as option value from the query result
    
    See Also:
    Constant Field Values
  - QUERYOPTION_RETURNQUERY
```
public static final java.lang.String QUERYOPTION_RETURNQUERY
```
    This is an output option set by the implementation, that carries the complete query that was executed, as it was modified by the implementation.
    
    See Also:
    Constant Field Values
  - QUERYOPTION_MAXRESULTS
```
public static final java.lang.String QUERYOPTION_MAXRESULTS
```
    Controls the maximum results of the query. Specify as new Integer(value). A value of 0 means unlimited results.
    
    See Also:
    Constant Field Values
  - QUERYOPTION_CACHERESULT
```
public static final java.lang.String QUERYOPTION_CACHERESULT
```
    Cache the results of queries.
    
    See Also:
    Constant Field Values
  - QUERYOPTION_NATIVEOPTIONS
```
public static final java.lang.String QUERYOPTION_NATIVEOPTIONS
```
    Takes native options for the database implementation as commaseparated key=value-Pairs. E.g. option1=value1,option2=value2...
    
    See Also:
    Constant Field Values
  - QUERYOPTION_ROLE
```
public static final java.lang.String QUERYOPTION_ROLE
```
    Set to the role, that this query should act as, filtering contents that should be invisible to that role. Default is WGContent.DISPLAYTYPE_SEARCH. Compare WGContent.isHiddenFrom(). Use Constants WGContent.DISPLAYTYPE_... as values.
    
    See Also:
    Constant Field Values
  - QUERYOPTION_USEDCACHE
```
public static final java.lang.String QUERYOPTION_USEDCACHE
```
    The occurence of this queryoption in the query parameters after the execution of the query shows, that the result set was retrieved from query cache
    
    See Also:
    Constant Field Values
  - QUERYOPTION_LANGUAGES
```
public static final java.lang.String QUERYOPTION_LANGUAGES
```
    Injects a priority list of languages to return in the query. Should override QUERYOPTION_ONLYLANGUAGE if available.
    
    See Also:
    Constant Field Values
  - QUERYOPTION_QUERY_PARAMETERS
```
public static final java.lang.String QUERYOPTION_QUERY_PARAMETERS
```
    This query option contains a map with query parameters, whose values should be used by the underlying query mechanism to fill parameter parts in the query text.
    
    See Also:
    Constant Field Values
  - PROFILEQUERY_TYPE_ALL
```
public static final java.lang.String PROFILEQUERY_TYPE_ALL
```
    Query type for queryUserProfileNames(String, String, Map) that retrieves all existent user profiles
    
    See Also:
    Constant Field Values
  - ROLE_CONTENT
```
public static final java.lang.String ROLE_CONTENT
```
    Database serves content and supplementary docs like content type, language if it is a full content store
    
    See Also:
    Constant Field Values
  - ROLE_DESIGN
```
public static final java.lang.String ROLE_DESIGN
```
    Database servers design documents (WebTML, CSS/JS)
    
    See Also:
    Constant Field Values
  - ROLE_REPOSITORY
```
public static final java.lang.String ROLE_REPOSITORY
```
    Database serves file containers
    
    See Also:
    Constant Field Values
  - ROLE_USERPROFILES
```
public static final java.lang.String ROLE_USERPROFILES
```
    Database servers user profiles
    
    See Also:
    Constant Field Values
  - FEATURE_QUERYABLE
```
public static final java.lang.String FEATURE_QUERYABLE
```
    Content supports query languages.
    
    See Also:
    Constant Field Values
  - FEATURE_SELF_PERSONALIZABLE
```
public static final java.lang.String FEATURE_SELF_PERSONALIZABLE
```
    The content store is able to also store user profiles and be its own "personalisation database"
    
    See Also:
    Constant Field Values
  - FEATURE_NATIVEEXPRESSIONS
```
public static final java.lang.String FEATURE_NATIVEEXPRESSIONS
```
    DB has a native expression language
    
    See Also:
    Constant Field Values
  - FEATURE_EDITABLE
```
public static final java.lang.String FEATURE_EDITABLE
```
    Database is editable i.e. can modify data of it's backend
    
    See Also:
    Constant Field Values
  - FEATURE_HIERARCHICAL
```
public static final java.lang.String FEATURE_HIERARCHICAL
```
    Content can be navigated hierarchical / is hierarchically ordered
    
    See Also:
    Constant Field Values
  - FEATURE_LASTCHANGED
```
public static final java.lang.String FEATURE_LASTCHANGED
```
    Content database maintains a last changed property, that should be monitored to track database changes.
    
    See Also:
    Constant Field Values
  - FEATURE_COMPLEXVALUES
```
public static final java.lang.String FEATURE_COMPLEXVALUES
```
    Content database can store complex values beyond string, number an dates and performs type checking itself
    
    See Also:
    Constant Field Values
  - FEATURE_STORESVARS
```
public static final java.lang.String FEATURE_STORESVARS
```
    Content database needs temporary storage of webtml variables in content documents (e.g. to allow native expression languages to access them)
    
    See Also:
    Constant Field Values
  - FEATURE_FULLCONTENTFEATURES
```
public static final java.lang.String FEATURE_FULLCONTENTFEATURES
```
    Content database has content types, struct entries, is multilingual and maintains content versioning, so content document creation must receive and generate all this info.
    
    See Also:
    Constant Field Values
  - FEATURE_USE_OBJECTS_AS_REFERENCES
```
public static final java.lang.String FEATURE_USE_OBJECTS_AS_REFERENCES
```
    Controls the behaviour when setting object relations for newly created objects. If feature present, the objects themselves will be passed as metadata. If not, only the name/key will be passed
    
    See Also:
    Constant Field Values
  - FEATURE_GENERATES_STRUCTKEYS
```
public static final java.lang.String FEATURE_GENERATES_STRUCTKEYS
```
    Controls, if this implementations's newly created struct entries can generate their own keys
    
    See Also:
    Constant Field Values
  - FEATURE_ACCEPTS_STRUCTKEYS
```
public static final java.lang.String FEATURE_ACCEPTS_STRUCTKEYS
```
    Controls if this implementation's newly created struct entries can accept keys from the creator
    
    See Also:
    Constant Field Values
  - FEATURE_UNLIMITED_CORES
```
public static final java.lang.String FEATURE_UNLIMITED_CORES
```
    Feature that will prevent the WGAPI from limiting the fetched cores for a session Should be set for DBs where limiting on WGAPI level makes no sense
    
    See Also:
    Constant Field Values
  - FEATURE_PERFORMS_BACKEND_LOGIN
```
public static final java.lang.String FEATURE_PERFORMS_BACKEND_LOGIN
```
    Controls if this implementation is able to perform a backend login, i.e. the core itself logs in with the user's login data. If this feature is activated and the database has no authentication module configured, the login information is given to WGDatabaseCore.openSession(AuthenticationSession, Object, boolean) as BackendAuthSession.
    
    See Also:
    Constant Field Values
  - FEATURE_EXTERNAL_AUTHENTICATION
```
public static final java.lang.String FEATURE_EXTERNAL_AUTHENTICATION
```
    Shows if this database relies on authentication modules for external authentication.
    
    See Also:
    Constant Field Values
  - FEATURE_RETRIEVE_ALL_CONTENTKEYS
```
public static final java.lang.String FEATURE_RETRIEVE_ALL_CONTENTKEYS
```
    Controls if this WGAPI implementation implements the getAllContentKeys() method
    
    See Also:
    Constant Field Values
  - FEATURE_QUERY_PROFILES
```
public static final java.lang.String FEATURE_QUERY_PROFILES
```
    Shows, if this implementation supports querying user profiles by method queryUserProfileNames
    
    See Also:
    Constant Field Values
  - FEATURE_AUTOCASCADES_DELETIONS
```
public static final java.lang.String FEATURE_AUTOCASCADES_DELETIONS
```
    Automatically cascades deletions (i.e. deletes all dependent documents), so that the WGAPI doesn't need to do that
    
    See Also:
    Constant Field Values
  - FEATURE_SESSIONTOKEN
```
public static final java.lang.String FEATURE_SESSIONTOKEN
```
    Controls if this implementation can take session tokens for a login
    
    See Also:
    Constant Field Values
  - FEATURE_MULTILANGUAGE
```
public static final java.lang.String FEATURE_MULTILANGUAGE
```
    Controls, if this implementation holds content in multiple languages
    
    See Also:
    Constant Field Values
  - FEATURE_TRANSACTIONS
```
public static final java.lang.String FEATURE_TRANSACTIONS
```
    Content database supports transactions
    
    See Also:
    Constant Field Values
  - FEATURE_REDUCE_CALLBACKS
```
public static final java.lang.String FEATURE_REDUCE_CALLBACKS
```
    This feature instructs the WGAPI to reduce callbacks to the database on some occassions where it is unlikely necessary to connect (Should increase performance on implementations with slow database connections)
    
    See Also:
    Constant Field Values
  - FEATURE_ACL_MANAGEABLE
```
public static final java.lang.String FEATURE_ACL_MANAGEABLE
```
    ACL of this database is manageable via WGAPI
    
    See Also:
    Constant Field Values
  - FEATURE_FIND_UPDATED_DOCS
```
public static final java.lang.String FEATURE_FIND_UPDATED_DOCS
```
    Find updated documents since a cutoff date by core-method getUpdateDocumentsSince
    
    See Also:
    Constant Field Values
  - FEATURE_CREATEABLE
```
public static final java.lang.String FEATURE_CREATEABLE
```
    Use the WGAPI to create a new database of this type (Method WGFactory.createDatabase())
    
    See Also:
    Constant Field Values
  - FEATURE_LOADBALANCE
```
public static final java.lang.String FEATURE_LOADBALANCE
```
    determines that the underlying core has the feature to loadbalance connections to multiple db servers, in this case connections are by default readonly and each db updates have to be initialized by calling beginUpdate()
    
    See Also:
    Constant Field Values
  - FEATURE_VALIDATE_ATTACHMENTS
```
public static final java.lang.String FEATURE_VALIDATE_ATTACHMENTS
```
    determines if documents in this database has the ability to validate file attachments by calling doc.validateAttachments();
    
    See Also:
    Constant Field Values
  - FEATURE_CONTENT_RELATIONS
```
public static final java.lang.String FEATURE_CONTENT_RELATIONS
```
    determines if the database supports real content relations
    
    See Also:
    Constant Field Values
  - FEATURE_MILLISECOND_PRECISION
```
public static final java.lang.String FEATURE_MILLISECOND_PRECISION
```
    determines if the database implementation has the ability to return document changes and modified dates on millisecond precision
    
    See Also:
    Constant Field Values
  - FEATURE_DISABLE_META_LOWERCASING
```
public static final java.lang.String FEATURE_DISABLE_META_LOWERCASING
```
    Enabling this feature will disable the lowercasing of metadata field values for fields that normally enforce this.
    
    See Also:
    Constant Field Values
  - FEATURE_DIRECT_ENTITY_READDING
```
public static final java.lang.String FEATURE_DIRECT_ENTITY_READDING
```
    Determines if the database supports removing and re-adding a subentity (item, relation, file attachments) without intermittent save
    
    See Also:
    Constant Field Values
  - FEATURE_ORDERED_NAVIGATION_RESULTS
```
public static final java.lang.String FEATURE_ORDERED_NAVIGATION_RESULTS
```
    Determines if a database returns ordered results on hierarchy navigation methods WGDatabaseCore.getRootEntries(WGArea, WGPageOrderSet) and WGDatabaseCore.getChildEntries(WGStructEntry, WGPageOrderSet), allowing the fetching of partial results
    
    See Also:
    Constant Field Values
  - FEATURE_PROVIDE_PORTLETITEM_STORAGE
```
public static final java.lang.String FEATURE_PROVIDE_PORTLETITEM_STORAGE
```
    Determines if a database is able to return meta WGUserProfile.META_PORTLETITEMSTORAGE, a storage service for items of transient portlets
    
    See Also:
    Constant Field Values
  - FEATURE_CONTENT_READ_PROTECTION
```
public static final java.lang.String FEATURE_CONTENT_READ_PROTECTION
```
    Indicates if the database knows any kind of user-specific content read protection, so that content caches must be individual for every user
    
    See Also:
    Constant Field Values
  - FEATURE_CONTENT_FILE_DERIVATES
```
public static final java.lang.String FEATURE_CONTENT_FILE_DERIVATES
```
    Determines if the database is able to store derivates to content file attachments
    
    See Also:
    Constant Field Values
  - FEATURE_UNPATCHEABLE
```
public static final java.lang.String FEATURE_UNPATCHEABLE
```
    Marks databases that should not be patched, f.e. because they are read-only
    
    See Also:
    Constant Field Values
  - COPTION_XML
```
public static final java.lang.String COPTION_XML
```
    Deprecated.
    
    Predefined creation option to specify configuration XML.
    
    See Also:
    Constant Field Values
  - COPTION_CACHING_ENABLED
```
public static final java.lang.String COPTION_CACHING_ENABLED
```
    Defines if caching is globally enabled for this database, defaults to true. If false, the database will cache no document data. In this state the WGAPI locking functions are not effective.
    
    See Also:
    Constant Field Values
  - COPTION_MAXCORES
```
public static final java.lang.String COPTION_MAXCORES
```
    Predefined creation option, that defines how many "cores" (i.e. backend documents) a session may retrieve at once. If more are retrieved, the first cores will be dropped to stay under this threshold.
    
    See Also:
    Constant Field Values
  - COPTION_MONITORLASTCHANGE
```
public static final java.lang.String COPTION_MONITORLASTCHANGE
```
    Predefined creation option, that determines if the LastChange-Date of this database should be monitored to drop cache when it changes.
    
    See Also:
    Constant Field Values
  - COPTION_DESIGNPROVIDERTYPES
```
public static final java.lang.String COPTION_DESIGNPROVIDERTYPES
```
    Specifies the document types that a design provider for the current db should provide, taking a commaseparated list of typenames of design documents. This option must be enforced by the provider itself.
    
    See Also:
    Constant Field Values
  - COPTION_WORKFLOWENGINE
```
public static final java.lang.String COPTION_WORKFLOWENGINE
```
    Predefined creation option, that determines the class name of a workflow engine to use. If this is not set, the default workflow engine of the implementation is used
    
    See Also:
    Constant Field Values
  - COPTION_NOITEMBEHAVIOUR
```
public static final java.lang.String COPTION_NOITEMBEHAVIOUR
```
    Determines the behaviour of this database and functionalitites that use this database regarding the retrieval of nonexistent items. Allowed values: - "straight" - The default. Always return null. - "compatible" - Compatibility with WGA 3.3. Use the values used there which differ by DB implementation and functionality
    
    See Also:
    Constant Field Values
  - COPTION_USERCACHELATENCY
```
public static final java.lang.String COPTION_USERCACHELATENCY
```
    Determines the latency of user specific caches that expire after the given time (in minutes). If 0 the caches never expire.
    
    See Also:
    Constant Field Values
  - COPTION_CACHELATENCY
```
public static final java.lang.String COPTION_CACHELATENCY
```
    Determines the latency of regular caches that expire after the given time (in minutes). If 0 the caches will never expire.
    
    See Also:
    Constant Field Values
  - COPTION_SHAREDPOOL
```
public static final java.lang.String COPTION_SHAREDPOOL
```
    Determines if this database may use a shared connection pool on servers which have one available. Databases implicitly use a shared pool when one is available, unless this setting is disabled.
    
    See Also:
    Constant Field Values
  - COPTION_READERPROFILECREATION
```
public static final java.lang.String COPTION_READERPROFILECREATION
```
    Determines if users at access level "READER" are allowed to create user profiles in this database
    
    See Also:
    Constant Field Values
  - COPTION_CONTENT_STORE_VERSION
```
public static final java.lang.String COPTION_CONTENT_STORE_VERSION
```
    Option to directly determine the content store version of this database
    
    See Also:
    Constant Field Values
  - COPTION_MANDATORY_READERS
```
public static final java.lang.String COPTION_MANDATORY_READERS
```
    Option to define users/groups/roles that should be able to read all documents no matter the contents of reader fields
    
    See Also:
    Constant Field Values
  - ATTRIB_UPDATED
```
public static final java.lang.String ATTRIB_UPDATED
```
    Special DB attribute that is to be set while a batch process (e.g. synchronization) is currently updating the database.
    
    See Also:
    Constant Field Values
  - COPTION_ALLOWCACHEMAINTENANCE
```
public static final java.lang.String COPTION_ALLOWCACHEMAINTENANCE
```
    Defines, if incremental cache maintenance is allowed for this database. Defaults to true (if the database type supports it). If set to false, the database will completely clear all caches once the data is manipulated in the background
    
    See Also:
    Constant Field Values
  - COPTION_DELETIONCHECK
```
public static final java.lang.String COPTION_DELETIONCHECK
```
    Defines if an online deletion check for documents should be enabled which costs performance. This is disabled by default.
    
    See Also:
    Constant Field Values
  - COPTION_PROJECTMODE
```
public static final java.lang.String COPTION_PROJECTMODE
```
    Enables/Disables project mode. In project mode no versioning and workflows are used.
    
    See Also:
    Constant Field Values
  - PORTLETREGISTRYMODE_TRANSIENT
```
public static final java.lang.String PORTLETREGISTRYMODE_TRANSIENT
```
    Portlet registry mode "transient", where registrations are only kept for each individual request.
    
    See Also:
    Constant Field Values
  - PORTLETREGISTRYMODE_PERSISTENT
```
public static final java.lang.String PORTLETREGISTRYMODE_PERSISTENT
```
    Portlet registry mode "persistent" where registrations are stored on the user profile and persisted.
    
    See Also:
    Constant Field Values
  - MASTER_USERNAME
```
public static final java.lang.String MASTER_USERNAME
```
    The user name that is returned for the user of a WGA master session
    
    See Also:
    Constant Field Values
  - COPTION_LIST_CACHE_REBUILD_THRESHOLD
```
public static final java.lang.String COPTION_LIST_CACHE_REBUILD_THRESHOLD
```
    Number of documents in a cache list that may need to be retrieved to rebuild the cache. If more docs need to be retrieved the cache will not be used.
    
    See Also:
    Constant Field Values
  - COPTION_DISABLE_CERTAUTH
```
public static final java.lang.String COPTION_DISABLE_CERTAUTH
```
    Option to disable certificate authentication even when the auth module to use has certauth enabled
    
    See Also:
    Constant Field Values
  - COPTION_FAKE_CERTAUTH
```
public static final java.lang.String COPTION_FAKE_CERTAUTH
```
    Option to fake certificate authentication. Database will enable certauth, no matter the auth module, and accept all X509 certificates verification
    
    See Also:
    Constant Field Values
  - QUERYOPTION_FETCHSIZE
```
public static final java.lang.String QUERYOPTION_FETCHSIZE
```
    A query option used on non-iterating query types, determining the size of a results fetch page to retrieve from the backend
    
    See Also:
    Constant Field Values
  - COPTION_DOCUMENTCACHESIZE
```
public static final java.lang.String COPTION_DOCUMENTCACHESIZE
```
    Option to configure the maximum number of document objects to be kept in document cache
    
    See Also:
    Constant Field Values
  - COPTION_NAMECACHESIZE
```
public static final java.lang.String COPTION_NAMECACHESIZE
```
    Option to configure the maximum number of document names to be kept in name cache
    
    See Also:
    Constant Field Values
  - COPTION_QUERYCACHESIZE
```
public static final java.lang.String COPTION_QUERYCACHESIZE
```
    Option to configure the maximum number of query results to be kept in query cache
    
    See Also:
    Constant Field Values
  - COPTION_CLUSTERED
```
public static final java.lang.String COPTION_CLUSTERED
```
    Option to configure if this database is clustered if used in an OpenWGA server cluster
    
    See Also:
    Constant Field Values
  - COPTION_LEGACY_DBCP_MONITORING
```
public static final java.lang.String COPTION_LEGACY_DBCP_MONITORING
```
    Option to enable legacy DBCP 1 JMX monitoring, provided by WGA-own beans (actually only for databases using DBCP, ergo JDBC databases)
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_CLEAR_USERPROFILES
```
public static final java.lang.String BACKENDSERVICE_CLEAR_USERPROFILES
```
    Service to clear all user profiles of the personalisation database in one fast batch operation. As this operation invalidates all existing profiles attached to sessions it should not be executed on productive environments. This operation will leave no trace in historylog.
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_NEW_CONTENT_VERSION
```
public static final java.lang.String BACKENDSERVICE_NEW_CONTENT_VERSION
```
    Service to effectively determine the version number for a new content document
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_CLEAR_CONTENT
```
public static final java.lang.String BACKENDSERVICE_CLEAR_CONTENT
```
    Service to clear all areas, struct entries and content documents from the content store in one fast batch operation. This operation will leave no trace in historylog. Schema from design may not be enforced after this service. Enforce manually or reopen the database to enforce again.
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_CLEAR_CONTENT_AND_SCHEMA
```
public static final java.lang.String BACKENDSERVICE_CLEAR_CONTENT_AND_SCHEMA
```
    Service to clear all content (areas, structs and contents) and schema (contenttypes and language definitions) from the content store in one fast batch operation. This operation will leave no trace in historylog. Schema from design may not be enforced after this service. Enforce manually or reopen the database to enforce again.
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_CLEAR_DATABASE
```
public static final java.lang.String BACKENDSERVICE_CLEAR_DATABASE
```
    Completely clears all data from the database, including all documents, the ACL, database metadata, historylog. Also resets system and custom sequences. This operation will leave no trace in historylog (well, besides clearing it) Schema from design may not be enforced after this service. Enforce manually or reopen the database to enforce again.
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_DAILY_MAINTENANCE
```
public static final java.lang.String BACKENDSERVICE_DAILY_MAINTENANCE
```
    A backend service defining some daily maintenance operation, to execute on the first event thread run each day
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_SELECT_PENDINGRELEASE_DOCS
```
public static final java.lang.String BACKENDSERVICE_SELECT_PENDINGRELEASE_DOCS
```
    Selects all documents that are pending release. Returns a WGAbstractResultSet.
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_PROBE_CONTENT
```
public static final java.lang.String BACKENDSERVICE_PROBE_CONTENT
```
    Checks if a content document for a certain page exists in a given language and status
    
    See Also:
    Constant Field Values
  - BACKENDSERVICE_FETCH_MULTI_CONTENT
```
public static final java.lang.String BACKENDSERVICE_FETCH_MULTI_CONTENT
```
    Fetches multiple contents in one backend call by their content key
    
    See Also:
    Constant Field Values
  - USER_BACKENDSERVICES
```
public static final java.util.Set<java.lang.String> USER_BACKENDSERVICES
```
    Backend services that are allowed to be called under user session
- Method Detail
  - monitorLastChange
```
public boolean monitorLastChange()
```
    Shows, if the database monitors the last change date of the backend database to maintain caches.
  - accessLevelText
```
public static java.lang.String accessLevelText(int levelCode)
```
    Converts access level access level names WGDatabase.ALNAME_... to codes WGDatabase.ACCESSLEVEL_...
    
    Parameters:
    levelCode - The access level code to convert
    
    Returns:
    The access level name. If code is unknown returns "(unknown)"
  - accessLevelCode
```
public static int accessLevelCode(java.lang.String levelName)
```
    Converts access level names WGDatabase.ALNAME_... to codes WGDatabase.ACCESSLEVEL_...
    
    Parameters:
    levelName - The access level name to convert
    
    Returns:
    The code. If the name is unknown returns WGDatabase.ACCESSLEVEL_NOTLOGGEDIN
  - accessLevel
```
public static WGDatabase.AccessLevel accessLevel(int levelCode)
```
    Returns access level information for the given access level code
    
    Parameters:
    levelCode -
  - isDatabaseUpdatedInBackground
```
public boolean isDatabaseUpdatedInBackground()
                                      throws WGAPIException
```
    Returns if the database has been updated in background and caches may not reflect the most up-to-date state, because cache management has not yet processed these updates
    
    Throws:
    
    WGAPIException
  - refresh
```
public void refresh()
             throws WGAPIException
```
    Refreshes the data in database, testing for changes in the backend and clearing all caches.
    
    Throws:
    
    WGAPIException
  - closeSession
```
public void closeSession()
                  throws WGAPIException
```
    Closes the database session. The database object and all child objects.
    
    Throws:
    
    WGAPIException
  - dropAllDocumentCores
```
public void dropAllDocumentCores(boolean untimelyDispose)
```
    Called to drop all retrieved document cores for this session at once.
    
    Parameters:
    untimelyDispose -
  - reopenSession
```
public int reopenSession(java.lang.String username,
                java.lang.Object credentials)
                  throws WGAPIException
```
    Closes and reopens the session with the given user information
    
    Parameters:
    username -
    credentials -
    
    Returns:
    the access level of the new session
    
    Throws:
    
    WGAPIException
  - reopenSession
```
public int reopenSession(java.lang.String username,
                java.lang.Object credentials,
                java.lang.String filter)
                  throws WGAPIException
```
    Closes and reopens the session with the given user information
    
    Parameters:
    username -
    credentials -
    filter - ID of the user access filter to apply. Specify null for none.
    
    Returns:
    the access level of the new session
    
    Throws:
    
    WGAPIException
  - reopenSession
```
public int reopenSession()
                  throws WGAPIException
```
    Closes and reopens the session with the current logged in user. If no session is open, opens a master session.
    
    Returns:
    The access level in the new session
    
    Throws:
    
    WGAPIException
  - getArea
```
public WGArea getArea(java.lang.String strName)
               throws WGAPIException
```
    Returns the area with the given name
    
    Parameters:
    strName - Name of the area
    
    Returns:
    WGArea
    
    Throws:
    
    WGAPIException
  - getAreas
```
public WGAreaMap getAreas()
                   throws WGAPIException
```
    Returns a map of all areas of this database, mapped by their area name.
    
    Returns:
    WGAreaMap
    
    Throws:
    
    WGAPIException
  - getStructEntryBySequence
```
public WGStructEntry getStructEntryBySequence(long seq)
                                       throws WGAPIException
```
    Returns a struct entry by it's page sequence
    
    Parameters:
    seq - The page sequence number
    
    Returns:
    WGStructEntry The found struct entry, null if there is none with that key.
    
    Throws:
    
    WGAPIException
  - getStructEntryByKey
```
public WGStructEntry getStructEntryByKey(java.lang.Object structKey)
                                  throws WGAPIException
```
    Returns a struct entry by it's struct key
    
    Parameters:
    structKey - The struct key to find a struct entry for.
    
    Returns:
    WGStructEntry The found struct entry, null if there is none with that key.
    
    Throws:
    
    WGAPIException
  - obtainOperationKey
```
public WGOperationKey obtainOperationKey(int operation,
                                java.lang.Object key)
```
    Returns on operation key for syncing of backend access. Should not be used outside the WGAPI.
    
    Parameters:
    operation -
    key -
    
    Returns:
    The key for the given operation. Can be a new created one or an existing key for this operation, if there was one.
  - getDesignObject
```
public WGDesignDocument getDesignObject(int type,
                               java.lang.String strName,
                               java.lang.String mediaKey)
                                 throws WGAPIException
```
    Returns a design object with the given information
    
    Parameters:
    type - document type choosing, which kind of design object to retrieve. Use constants WGDocument.TYPE_...
    strName - Name of the design object
    mediaKey - media key of the design object. If design object has no media key, provide null.
    
    Returns:
    WGDesignDocument
    
    Throws:
    
    WGAPIException
  - getDesignObject
```
public WGDesignDocument getDesignObject(int type,
                               java.lang.String strName)
                                 throws WGAPIException
```
    Returns a design object with the given information. In this method the media key is omitted. Therefor it is not suitable to retrieve WebTML Modules
    
    Parameters:
    type - document type choosing, which kind of design object to retrieve. Use constants WGDocument.TYPE_...
    strName - Name of the design object
    
    Returns:
    WGDesignDocument
    
    Throws:
    
    WGAPIException
  - getTitle
```
public java.lang.String getTitle()
```
    Returns the title of this database (if there is one).
    
    Returns:
    String
  - addDatabaseEventListener
```
public void addDatabaseEventListener(WGDatabaseEventListener listener)
```
    Registers a listerer for database events.
    
    Parameters:
    listener - The listener to register.
  - addDatabaseConnectListener
```
public void addDatabaseConnectListener(WGDatabaseConnectListener listener)
```
    Adds a listener for the connection of this database to its backend.
    
    Parameters:
    listener -
  - removeDatabaseConnectListener
```
public void removeDatabaseConnectListener(WGDatabaseConnectListener listener)
```
    Removes a listener for the connection of this database to its backend
    
    Parameters:
    listener -
  - addContentEventListener
```
public void addContentEventListener(WGContentEventListener listener)
```
    Adds a listener for content events to the database.
    
    Parameters:
    listener -
  - addWorkflowEventListener
```
public void addWorkflowEventListener(WGWorkflowEventListener listener)
```
    Adds a listener for workflow events to the database
    
    Parameters:
    listener -
  - removeDatabaseEventListener
```
public void removeDatabaseEventListener(WGDatabaseEventListener listener)
```
    Removes a database event listener.
  - removeContentEventListener
```
public void removeContentEventListener(WGContentEventListener listener)
```
    Removes a content event listener.
  - removeWorkflowEventListener
```
public void removeWorkflowEventListener(WGWorkflowEventListener listener)
```
    Removes a workflow event listener.
  - fireWorkflowEvent
```
public java.util.List fireWorkflowEvent(WGWorkflowEvent event)
                                 throws WGAPIException
```
    Fires a workflow event. Not to be called outside the WGAPI.
    
    Parameters:
    event -
    
    Returns:
    A list of results that were returned by the event recipients
    
    Throws:
    
    WGAPIException
  - openSession
```
public int openSession(java.lang.String user,
              java.lang.Object credentials)
                throws WGAPIException
```
    Opens a new session.
    
    Parameters:
    user - The username for the new session. Specify null for master login.
    credentials - The password to the username. Specify null for master login.
    
    Returns:
    The access level to the database, as constant WGDatabase.ACCESSLEVEL_...
    
    Throws:
    
    WGAPIException
  - openAnonymousSession
```
public int openAnonymousSession()
                         throws WGAPIException
```
    Opens a session as anonymous user
    
    Throws:
    
    WGAPIException
  - openAnonymousSession
```
public int openAnonymousSession(java.lang.String accessFilter)
                         throws WGAPIException
```
    Opens a session as anonymous user, including an access filter
    
    Parameters:
    accessFilter - The filter id
    
    Throws:
    
    WGAPIException
  - openSession
```
public int openSession(java.lang.String user,
              java.lang.Object credentials,
              java.lang.String filter,
              javax.servlet.http.HttpServletRequest request)
                throws WGAPIException
```
    Opens a new session.
    
    Parameters:
    user - The username for the new session. Specify null for master login.
    credentials - The password to the username. Specify null for master login.
    filter - A user access filter to reduce the user rights
    
    Returns:
    The access level to the database, as constant WGDatabase.ACCESSLEVEL_...
    
    Throws:
    
    WGAPIException
  - openSession
```
public int openSession(java.lang.String user,
              java.lang.Object credentials,
              java.lang.String filter)
                throws WGAPIException
```
    Throws:
    
    WGAPIException
  - openSession
```
public int openSession(java.security.cert.X509Certificate cert,
              java.lang.String filter)
                throws WGAPIException
```
    Opens a new session using a certificate for login. To use certificate authentication you must use a CertAuthCapableAuthModule with enabled certificate authentication
    
    Parameters:
    cert - The certificate used to login.
    filter - A user access filter to reduce user rights
    
    Returns:
    The access level to the database, as constant WGDatabase.ACCESSLEVEL_...
    
    Throws:
    
    WGAPIException
  - openSession
```
public int openSession()
                throws WGAPIException
```
    Opens a new session with master login.
    
    Throws:
    
    WGAPIException
  - getType
```
public java.lang.String getType()
```
    Returns the imlementation type (i.e. the class name of the database core implementation)
  - getTypeName
```
public java.lang.String getTypeName()
```
    Returns a descriptive type name of the database implementation used.
  - getDesignObjects
```
public java.util.List<? extends WGDesignDocument> getDesignObjects(int type)
                                                            throws WGAPIException
```
    Returns all design objects of a specific type.
    
    Parameters:
    type - The type of design objects to retrieve. Use constants WGDocument.TYPE_...
    
    Returns:
    ArrayList List of WGDesignObject objects
    
    Throws:
    
    WGAPIException
  - getContentByName
```
public WGContent getContentByName(java.lang.String strName,
                         java.lang.String strLanguage)
                           throws WGAPIException
```
    Retrieves a content by it's unique name.
    
    Parameters:
    strName - Unique name of the content
    strLanguage - Language of the content
    
    Returns:
    WGContent Content matching unique name and language, null if none exists.
    
    Throws:
    
    WGAPIException
  - getStructEntryByName
```
public WGStructEntry getStructEntryByName(java.lang.String strName)
                                   throws WGAPIException
```
    Retrieves a struct entry which has the given unique name This method will only return struct entries if they themselves own the unique name, not if any content of them owns it.
    
    Parameters:
    strName - Unique name
    
    Returns:
    A struct entry of this name or null if the name is not given to any struct entry.
    
    Throws:
    
    WGAPIException
  - getContentByName
```
public WGContent getContentByName(java.lang.String name)
                           throws WGAPIException
```
    Retrieves a content by it's unique name in the database's default language.
    
    Parameters:
    name - Unique name of the content
    
    Returns:
    WGContent Content matching unique name, null if none exists.
    
    Throws:
    
    WGAPIException
  - setAttribute
```
public void setAttribute(java.lang.String name,
                java.lang.Object obj)
```
    Sets a custom attribute to the database. These attributes remain at the database object forever and can even be retrieved when no session is open. The attributes can later be retrieved via getAttribute().
    
    Parameters:
    name - The custom attribute name
    obj - The attribute value.
  - removeAttribute
```
public java.lang.Object removeAttribute(java.lang.String name)
```
    Removes a database attribute.
    
    Parameters:
    name - Name of the attribute to remove
    
    Returns:
    The removed attribute value, if there was one, null otherwise
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String name)
```
    Returns a custom attribute set to this database.
    
    Parameters:
    name - Name of the attribute
    
    Returns:
    Object Value of the attribute
  - hasAttribute
```
public boolean hasAttribute(java.lang.String name)
```
    Tests if the database contains an attribute of the given name
    
    Parameters:
    name - Attribute name
    
    Returns:
    true, if attribute exists, false (suprise) if not
  - getBooleanAttribute
```
public boolean getBooleanAttribute(java.lang.String name,
                          boolean defaultValue)
```
    Returns the boolean value of an attribute, accepting boolean objects and those string representations that are converted by WGUtils.stringToBoolean().
    
    Parameters:
    name - The name of the Attribute
    defaultValue - The default value to return, if the attribute is not interpretable as boolean
    
    Returns:
    The boolean value of the attribute, or the default value if the attribute was not present or it's boolean value was not determinable
  - query
```
public WGAbstractResultSet query(java.lang.String type,
                        java.lang.String query,
                        java.util.Map parameters)
                          throws WGAPIException
```
    Executes a query in the database giving a result set of content documents in return.
    
    Parameters:
    type - The type of query. Available types vary by database implementation.
    query - The query. Format depends on query type.
    parameters - Additional parameters for the query. Use Constants WGDatabase.QUERYOPTION_... as map keys.
    
    Returns:
    A result set containing the contents matching the query
    
    Throws:
    
    WGAPIException
  - hasFeature
```
public boolean hasFeature(java.lang.String featureName)
```
    Queries the database for specific features.
    
    Parameters:
    featureName - The feature to query. Use Constants WGDatabase.FEATURE_...
    
    Returns:
    true if the database implementation supports this feature, false otherwise
  - getRoles
```
public java.util.List getRoles()
```
    Returns the roles of this db implementation, describing what documents can be found in it.
    
    Returns:
    List List of constants WGDatabase.ROLE_...
    WGDatabase.ROLE_CONTENT: Database contains content documents and related (WGContent, WGStructEntry, WGArea)
    WGDatabase.ROLE_DESIGN: Database contains design documents (WGTMLModule, WGCSSJSLibrary)
    WGDatabase.ROLE_REPOSITORY: Database contains file containers (WGFileContainer)
    WGDatabase.ROLE_USERPROFILES: Database contains user profiles (WGUserProfile)
  - addBackendChangeListener
```
public void addBackendChangeListener(WGBackendChangeListener listener)
```
    Adds a listener for backend changes to the database
    
    Parameters:
    listener -
  - removeBackendChangeListener
```
public void removeBackendChangeListener(WGBackendChangeListener listener)
```
    Removes a listener for backend changes from the database
    
    Parameters:
    listener -
  - performContentCreationCheck
```
public void performContentCreationCheck(WGStructEntry entry,
                               WGLanguage language)
                                 throws WGAPIException,
                                        ResourceIsLockedException,
                                        WGAuthorisationException,
                                        WGIllegalStateException
```
    Controls if the current user may create a content document with the given data. If so the method exists normally. If not an exception is thrown.
    
    Parameters:
    entry - The struct entry under which to create the content. If given null all struct entry data checks are bypassed.
    language - The language in which to create it
    
    Throws:
    
    WGAPIException - If the user may not create the document. The exception informs about the reason.
    
    ResourceIsLockedException
    
    WGAuthorisationException
    
    WGIllegalStateException
  - createContent
```
public WGContent createContent(WGStructEntry entry,
                      WGLanguage language,
                      java.lang.String title)
                        throws WGAPIException
```
    Creates a new content document. This method flavor is meant for "complete" content stores with struct entry hierarchy.
    
    Parameters:
    entry - The struct entry for the new content
    language - The language of the new content
    title - The title of the new content
    
    Returns:
    The newly created content document.
    
    Throws:
    
    WGAPIException
  - createContent
```
public WGContent createContent(WGArea area,
                      java.lang.Object key,
                      java.lang.String title)
                        throws WGAPIException
```
    Creates a simple content document with the content key given. This method flavor is meant for content stores without struct entry hierarchy, like those derived from the SimpleContentSource-Class
    
    Parameters:
    area - The area to create the content in.
    key - The key of the new content.
    title - The title of the new content.
    
    Returns:
    The newly created content.
    
    Throws:
    
    WGAPIException
  - createStructEntry
```
public WGStructEntry createStructEntry(WGDocument parent,
                              WGContentType contentType,
                              java.lang.String title)
                                throws WGAPIException
```
    Equivalent to calling createStructKey(null, parent, contentType, title).
    
    Parameters:
    parent -
    contentType -
    title -
    
    Throws:
    
    WGAPIException
  - createStructEntry
```
public WGStructEntry createStructEntry(java.lang.Object key,
                              WGDocument parent,
                              WGContentType contentType,
                              java.lang.String title)
                                throws WGAPIException
```
    Creates a new struct entry
    
    Parameters:
    key - The struct key of the new entry. Can be specified when database supports feature WGDatabase.FEATURE_ACCEPTS_STRUCTKEYS. Can be left out with null, when the database supports feature WGDatabase.FEATURE_GENERATES_STRUCTKEYS.
    parent - Parent object. Can be a WGArea object (new entry will be root) or another WGStructEntry object (new entry will be child)
    contentType - Content type for contents of this struct entry
    title - Title of this struct entry
    
    Returns:
    WGStructEntry
    
    Throws:
    
    WGAPIException
  - performStructCreationCheck
```
public void performStructCreationCheck(java.lang.Object key,
                              WGDocument parent,
                              WGContentType contentType)
                                throws WGAPIException
```
    Controls if the current user may create a struct entry with the given data. If so the method exists normally. If not an exception is thrown.
    
    Parameters:
    key - A struct key that is to be determined for the new struct entry. Give null if you want the WGAPI to generate the key.
    parent - The parent of the new struct entry. May be an WGArea or another WGStructEntry.
    contentType - The content type of the new struct entry.
    
    Throws:
    
    WGAPIException - If the user may not create the document. The exception informs about the reason.
  - getLastChanged
```
public java.util.Date getLastChanged()
```
    Returns date, where data in the database was last changed. This function may not be supported by some implementations (Feature WGDatabase.FEATURE_LASTCHANGED) and return new Date(Long.MIN_VALUE).
    
    Returns:
    Date
    
    Throws:
    
    WGAPIException
  - getRevision
```
public java.lang.Comparable getRevision()
```
    Returns the revision state of the database. The return type depends on the backend database, but is normally either Long or Date. The revision here is the state that the database and all its caches currently safely represents. The actual revision on the backend may be newer. and can be retrieved using getBackendRevision(). You can use getRevisionObject() instead which provides a high-level object easier to compare to other revisions and to serialize/deserialize. To get dates corresponding to the given revision use getRevisionDate(Comparable). To directly retrieve concrete dates use getLastChanged() instead.
  - getBackendRevision
```
public java.lang.Comparable getBackendRevision()
                                        throws WGAPIException
```
    Returns the revision state of the database backend. This is the most up-to-date revision including all most recent changes, but may not yet be reflected by all caches of the WGAPI.
    
    Throws:
    
    WGAPIException
  - getRevisionObject
```
public WGDatabaseRevision getRevisionObject()
```
    Returns the revision state of the database as an high level object, usable for revision comparison and storage independently from the concrete backend type of revision value Just like getRevision() this returns the revision state of the database that is safely represented by all caches.
  - getRevisionDate
```
public java.util.Date getRevisionDate(java.lang.Comparable lastModified)
                               throws WGAPIException,
                                      WGWrongRevisionException
```
    Retrieve the datetime where a given database revision was done. The indicators given as parameter must have been retrieved by getRevision(). If the revision is of wrong datatype or is no revision known in this database the method throws a WGWrongRevisionExcception.
    
    Parameters:
    lastModified - The revision indicator
    
    Returns:
    The date that the given revision was done
    
    Throws:
    
    WGAPIException
    
    WGWrongRevisionException - if the given revision is no revision of the current database
  - getCreationOptions
```
public java.util.Map getCreationOptions()
```
    Returns the map of creation options provided to this database when it was initially opened
    
    Returns:
    Map
  - getLanguages
```
public java.util.Map<java.lang.String,WGLanguage> getLanguages()
                                                        throws WGAPIException
```
    Returns a map of WGLanguage objects, mapped by their language name (code)
    
    Returns:
    Map
    
    Throws:
    
    WGAPIException
  - getSessionContext
```
public WGSessionContext getSessionContext()
```
    Returns the session context, providing all data about the currently opened database session. Null if no session is open.
    
    Returns:
    WGSessionContext
  - close
```
public void close()
           throws WGAPIException
```
    Completely closes this database object. This object and all child objects must not be used after calling this.
    
    Throws:
    
    WGAPIException
  - getDummyContent
```
public WGContent getDummyContent(java.lang.String language)
                          throws WGAPIException
```
    Retrieves a dummy content object. Should support the native expression language of the database, if there is one.
    
    Returns:
    WGContent
    
    Throws:
    
    WGAPIException
  - getDummyProfile
```
public WGUserProfile getDummyProfile(java.lang.String name)
                              throws WGAPIException
```
    Returns a dummy profile object that does not store information.
    
    Parameters:
    name - Profile name that the dummy profile should return
    
    Throws:
    
    WGAPIException
  - parseStructKey
```
public java.lang.Object parseStructKey(java.lang.String key)
                                throws WGAPIException
```
    Parses the string representation of a struct key (e.g. used in a URL) to the real internal struct key format
    
    Parameters:
    key -
    
    Returns:
    The struct key object. Type varies by database implementation.
    
    Throws:
    
    WGAPIException
  - getContentByKey
```
public WGContent getContentByKey(WGContentKey key)
                          throws WGAPIException
```
    Return a content document by content key
    
    Parameters:
    key - Key to retrieve content for
    
    Returns:
    WGContent the found content, if none found null
    
    Throws:
    
    WGAPIException
  - getContentByKey
```
public WGContent getContentByKey(java.lang.String keyStr)
                          throws WGAPIException
```
    Return a content document by content key string.
    
    Parameters:
    keyStr - The content key in its string representation
    
    Returns:
    The content with that content key or null if it does not exist
    
    Throws:
    
    WGAPIException
  - getDocumentByDocumentKey
```
public WGDocument getDocumentByDocumentKey(java.lang.String key)
                                    throws WGAPIException
```
    Deprecated. Use getDocumentByKey(String) instead
    
    Returns a document by the given document key.
    
    Parameters:
    key - The document key for the document in its string representation
    
    Returns:
    The document of that key, null if there is none
    
    Throws:
    
    WGAPIException
  - getDocumentByKey
```
public WGDocument getDocumentByKey(WGDocumentKey documentKey)
                            throws WGAPIException
```
    Returns a document by the given document key.
    
    Parameters:
    documentKey - The document key for the document.
    
    Returns:
    The document of that key, null if there is none
    
    Throws:
    
    WGAPIException
  - getDocumentByKey
```
public WGDocument getDocumentByKey(java.lang.String key)
                            throws WGAPIException
```
    Returns a document by the given document key.
    
    Parameters:
    key - The document key for the document in its string representation
    
    Returns:
    The document of that key, null if there is none
    
    Throws:
    
    WGAPIException
  - getParentEntry
```
public WGStructEntry getParentEntry(WGStructEntry entry)
                             throws WGAPIException
```
    Returns the parent entry to the given struct entry
    
    Parameters:
    entry - The entry, whose parent is searched
    
    Returns:
    WGStructEntry
    
    Throws:
    
    WGAPIException
  - getExtensionData
```
public java.lang.Object getExtensionData(java.lang.String name)
                                  throws WGAPIException
```
    Retrieves the value of an extension data field stored in this database. Extension data fields are custom data that are persistently stored to an entity, in this case the database itself, and which may have custom purpose. This feature is only available in WGA Content Stores of Version 5 or higher.
    
    Specified by:
    
    getExtensionData in interface WGExtensionDataContainer
    
    Parameters:
    name - The name of the field.
    
    Returns:
    The value of the requested field for this database core.
    
    Throws:
    
    WGAPIException
  - getExtensionDataNames
```
public java.util.List<java.lang.String> getExtensionDataNames()
                                                       throws WGAPIException
```
    Returns the names of stored extension data fields on this database This feature is only available in WGA Content Stores of Version 5 or higher.
    
    Specified by:
    
    getExtensionDataNames in interface WGExtensionDataContainer
    
    Returns:
    List of field mnames
    
    Throws:
    
    WGAPIException
    
    WGBackendException
  - writeExtensionData
```
public void writeExtensionData(java.lang.String name,
                      java.lang.Object value)
                        throws WGAPIException
```
    Writes a extension data field. The data is immediately stored. Extension data fields are custom data that are persistently stored to an entity, in this case the database itself, and which may have custom purpose. This feature is only available in WGA Content Stores of Version 5 or higher.
    
    Specified by:
    
    writeExtensionData in interface WGExtensionDataContainer
    
    Parameters:
    name - Name of the field
    value - The value to store
    
    Throws:
    
    WGAPIException
  - removeExtensionData
```
public void removeExtensionData(java.lang.String name)
                         throws WGAPIException
```
    Removes a extension data field from the database. The removal is immediately commited. This feature is only available in WGA Content Stores of Version 5 or higher.
    
    Specified by:
    
    removeExtensionData in interface WGExtensionDataContainer
    
    Parameters:
    name - Name of the field to remove
    
    Throws:
    
    WGAPIException
  - getDefaultLanguage
```
public java.lang.String getDefaultLanguage()
                                    throws WGAPIException
```
    Returns the default language of this database
    
    Returns:
    String
    
    Throws:
    
    WGAPIException
  - determineDefaultLanguage
```
public void determineDefaultLanguage()
                              throws WGAPIException
```
    Trigger the determination of a default language. This method tries to find a reasonable safe language to use as default language with limited effort. It does not take into account which language is used the most but will take a language with root contents available.
    
    Throws:
    
    WGAPIException
  - getServerName
```
public java.lang.String getServerName()
                               throws WGAPIException
```
    Returns the name of the database server (if there is one).
    
    Returns:
    String
    
    Throws:
    
    WGAPIException
  - isReady
```
public boolean isReady()
```
    Returns, if the database is ready for work.
    
    Returns:
    Returns a boolean
  - getCore
```
public WGDatabaseCore getCore()
```
    Returns the core implementation object of this database.
    
    Returns:
    WGDatabaseCore
  - getPersonalisationCore
```
public WGPersonalisationDatabaseCore getPersonalisationCore()
                                                     throws WGNotSupportedException
```
    Returns the personalisation core implementation of this database, if it is a personalisation database.
    
    Throws:
    
    WGNotSupportedException
    
    WGNotSupportedException - If the database is no personalisation database
  - isSessionOpen
```
public boolean isSessionOpen()
```
    Indicates if a database session is open
  - getPath
```
public java.lang.String getPath()
```
    Returns the database path, given as parameter of the method WGDatabase.open()
    
    Returns:
    String
  - getFirstReleasedContent
```
public WGContent getFirstReleasedContent(java.lang.String language,
                                boolean onlyRoots)
                                  throws WGAPIException
```
    Returns the first released content document of this database in the specified language. It is up to the db implementation to decide, which document is regarded "the first" of the database.
    
    Parameters:
    language - The language of the content
    onlyRoots - Specify true, if you want to get only root documents
    
    Returns:
    WGContent The content, null if there is no content of that language.
    
    Throws:
    
    WGAPIException
  - getFirstReleasedContent
```
public WGContent getFirstReleasedContent(WGLanguageChooser chooser,
                                boolean onlyRoots)
                                  throws WGAPIException
```
    Returns the first released content document of this database. It is up to the db implementation to decide, which document is regarded "the first" of the database.
    
    Parameters:
    chooser - A language chooser object determining what language versions may be used
    onlyRoots - Specify true, if you want to get only root documents
    
    Returns:
    WGContent The content, null if there is no content of that language.
    
    Throws:
    
    WGAPIException
  - getFirstReleasedContent
```
public WGContent getFirstReleasedContent(java.lang.String language)
                                  throws WGAPIException
```
    Returns the first released content of the given language to be found in this database.
    
    Parameters:
    language -
    
    Throws:
    
    WGAPIException
  - getUserProfile
```
public WGUserProfile getUserProfile(java.lang.String name)
                             throws WGAPIException
```
    Retrieves a user profile for the given profile name.
    
    Parameters:
    name -
    
    Throws:
    
    WGAPIException
  - createUserProfile
```
public WGUserProfile createUserProfile(java.lang.String userNameWish,
                              int type,
                              boolean forceNew)
                                throws WGAPIException
```
    Creates a new user profile.
    
    Parameters:
    userNameWish - Name of the new user profile. May be null to let the personalisation database generate a name.
    type - Type of the user profile. Can be any integer chosen by the personalisation implementation to differ profile types.
    forceNew - Forces the creation of a new profile. If there is already an existing profile with the given name then a new profile with a different name is created and returned.
    
    Returns:
    The new user profile.
    
    Throws:
    
    WGAPIException - instance of WGCreationException if a profile with this name already exists or the profile creation fails otherwise WGAPIExceptions on BackendErrors
  - createUserProfile
```
public WGUserProfile createUserProfile(java.lang.String userNameWish,
                              int type)
                                throws WGAPIException
```
    Creates a new user profile.
    
    Parameters:
    userNameWish - Name of the new user profile. May be null to let the personalisation database generate a name.
    type - Type of the user profile. Can be any integer chosen by the personalisation implementation to differ profile types.
    
    Returns:
    The new user profile.
    
    Throws:
    
    WGAPIException - instance of WGCreationException if a profile with this name already exists or the profile creation fails otherwise WGAPIExceptions on BackendErrors
  - isContentRole
```
public boolean isContentRole()
```
    Returns, if the database contains content
    
    Returns:
    boolean
  - isDesignRole
```
public boolean isDesignRole()
```
    Returns if the database contains design documents
    
    Returns:
    boolean
  - isRepositoryRole
```
public boolean isRepositoryRole()
```
    Returns if if the database contains file containers.
    
    Returns:
    boolean
  - isUserProfilesRole
```
public boolean isUserProfilesRole()
```
    Indicates if the database contains user profiles
  - isEmpty
```
public boolean isEmpty()
                throws WGAPIException
```
    Determines if this database is completely empty of (content store) documents. This does not work on personalisation databases.
    
    Throws:
    
    WGAPIException
  - isDesignEmpty
```
public boolean isDesignEmpty()
                      throws WGAPIException
```
    Returns if this database has no design documents (file containers, script modules, WebTML modules) and can be regarded "design-empty".
    
    Throws:
    
    WGAPIException
  - isContentEmpty
```
public boolean isContentEmpty()
                       throws WGAPIException
```
    Returns if this database has neither content hierarchy (areas, struct entries, contents) nor content schema documents (content types, languages) and can be regarded "content-empty"
    
    Throws:
    
    WGAPIException
  - getMasterLoginName
```
public java.lang.String getMasterLoginName()
```
    Gets the name of the master login, which is the login user name used with the initial call to WGDatabase.open().
    
    Returns:
    String
  - getWorkflowEngine
```
public WGWorkflowEngine getWorkflowEngine()
                                   throws WGAPIException
```
    Gets the workflow engine object for this database.
    
    Returns:
    WGWorkflowEngine
    
    Throws:
    
    WGWorkflowException
    
    WGBackendException
    
    WGAPIException
  - getStatistics
```
public WGDatabase.WGDatabaseStatistics getStatistics()
```
    Returns an object containing internal statistics about the database
    
    Returns:
    WGDatabaseStatistics
  - isMemberOfUserList
```
public boolean isMemberOfUserList(java.util.List list)
                           throws WGAPIException
```
    Tests, if the current user can be associated with any entry in the list. This is up to the database implementation to decide since name/group/role mechanims may vary widely in different databases.
    
    Parameters:
    list -
    
    Throws:
    
    WGAPIException
  - createContent
```
public WGContent createContent(java.lang.String title)
                        throws WGAPIException
```
    Creates a simple content document. This method can only be used, when the underlying database implementation doesn't support full content features like struct entries, content types etc.
    
    Parameters:
    title - Title of the new content document.
    
    Returns:
    WGContent
    
    Throws:
    
    WGAPIException
  - createContent
```
public WGContent createContent()
                        throws WGAPIException
```
    Creates a simple content document. This variant can be used in implementations that don't have struct entries or content types and generate their own keys. (e.g. some descendants of SimpleContentSource like JDBCSource).
    
    Returns:
    The newly created content document.
    
    Throws:
    
    WGAPIException
  - getContentTypes
```
public java.util.List<WGContentType> getContentTypes()
                                              throws WGAPIException
```
    Returns a list with all content types stored in this database
    
    Returns:
    List List of WGContentType objects
    
    Throws:
    
    WGAPIException
  - getContentType
```
public WGContentType getContentType(java.lang.String name)
                             throws WGAPIException
```
    Returns a content type document of the given name
    
    Parameters:
    name - The name of the content type
    
    Returns:
    WGContentType The content type if one with that name is present, null otherwise
    
    Throws:
    
    WGAPIException
  - getTMLModules
```
public java.util.List<WGTMLModule> getTMLModules()
                                          throws WGAPIException
```
    Returns the list of TML modules in this database.
    
    Throws:
    
    WGAPIException
  - getTMLModule
```
public WGTMLModule getTMLModule(java.lang.String name,
                       java.lang.String mediaKey)
                         throws WGAPIException
```
    Returns the TML module for the given name and media key
    
    Parameters:
    name -
    mediaKey -
    
    Throws:
    
    WGAPIException
  - getLanguage
```
public WGLanguage getLanguage(java.lang.String name)
                       throws WGAPIException
```
    Returns the language of that name (code) if it exists. If the language does not exist a dummy language definition is returned to prevent NullPointers bc. of nonexistent language definitions. You can test for a dummy language definition by calling language.isDummy().
    
    Parameters:
    name - The language name
    
    Returns:
    WGLanguage
    
    Throws:
    
    WGAPIException
  - getLanguageForLocale
```
public WGLanguage getLanguageForLocale(java.util.Locale locale)
                                throws WGAPIException
```
    Retrieves the best matching language definition for the given locale. Language definitions are searched in descending details order: language_COUNTRY_VARIANT language_COUNTRY language
    
    Parameters:
    locale - The locale to match
    
    Returns:
    The language that matches the locale best, null if none could be found
    
    Throws:
    
    WGAPIException
  - createArea
```
public WGArea createArea(java.lang.String name)
                  throws WGAPIException
```
    Creates a new area definition.
    
    Parameters:
    name - The Name of the new area
    
    Returns:
    The newly created area object.
    
    Throws:
    
    WGAPIException
  - createContentType
```
public WGContentType createContentType(java.lang.String name)
                                throws WGAPIException
```
    Creates a new content type.
    
    Parameters:
    name - Name of the new content type.
    
    Returns:
    The newly created content type object.
    
    Throws:
    
    WGAPIException
  - createTMLModule
```
public WGTMLModule createTMLModule(java.lang.String name,
                          java.lang.String mediaKey)
                            throws WGAPIException
```
    Creates a new TML module.
    
    Parameters:
    name - name of the new TML module.
    mediaKey - Media key of the new TML module.
    
    Returns:
    The newly created TML module.
    
    Throws:
    
    WGAPIException
  - moveStructEntry
```
public boolean moveStructEntry(WGStructEntry entry,
                      WGDocument newParent)
                        throws WGAPIException
```
    Moves a struct entry to a new position.
    
    Parameters:
    entry - The entry to move
    newParent - The new parent of the entry. If it is an WGArea object the struct entry will become a root document in this area. If it is an WGStructEntry it will become a child entry of this entry.
    
    Returns:
    true, if the operation succeeded, false otherwise
    
    Throws:
    
    WGAPIException
  - performStructMoveCheck
```
public void performStructMoveCheck(WGStructEntry entry,
                          WGDocument newParent)
                            throws WGIllegalArgumentException,
                                   WGAPIException,
                                   WGAuthorisationException,
                                   ResourceIsLockedException
```
    Controls if the current user may move a struct entry to the given new parent. If so the method exists normally. If not an exception is thrown.
    
    Parameters:
    entry - The entry to move
    newParent - The new parent of the entry. May be an WGArea or another WGStructEntry.
    
    Throws:
    
    WGAPIException - If the user may not move the document. The exception informs about the reason.
    
    WGIllegalArgumentException
    
    WGAuthorisationException
    
    ResourceIsLockedException
  - createCSSJSModule
```
public WGCSSJSModule createCSSJSModule(java.lang.String name,
                              java.lang.String type)
                                throws WGAPIException
```
    Creates a new Script module
    
    Parameters:
    name - Name of the new module
    type - Type of the module. A constant WGCSSJSModule.CODETYPE_...
    
    Throws:
    
    WGAPIException
  - performDesignCreationCheck
```
public void performDesignCreationCheck(int type,
                              java.lang.String name,
                              java.lang.String mediaKey)
                                throws WGAPIException
```
    Controls if the current user may create a design document with the given data. If so the method exists normally. If not an exception is thrown.
    
    Parameters:
    type - The type of design document. Use constants WGDocument.TYPE_...
    name - The name of design document
    mediaKey - For WebTML modules specify media key, for script modules specify code type (Constants WGScriptModule.CODETYPE_...). For other types specify null.
    
    Throws:
    
    WGAPIException - If the creation for the given data would fail
  - getCSSJSModules
```
public java.util.List getCSSJSModules()
                               throws WGAPIException
```
    Returns the script modules in this database.
    
    Throws:
    
    WGAPIException
  - getCSSJSModule
```
public WGScriptModule getCSSJSModule(java.lang.String name)
                              throws WGAPIException
```
    Returns the script module of the given name.
    
    Parameters:
    name -
    
    Throws:
    
    WGAPIException
  - getCSSJSModule
```
public WGScriptModule getCSSJSModule(java.lang.String name,
                            java.lang.String type)
                              throws WGAPIException
```
    Returns the script module of the given name and type
    
    Parameters:
    name -
    
    Throws:
    
    WGAPIException
  - getFileContainers
```
public java.util.List<WGFileContainer> getFileContainers()
                                                  throws WGAPIException
```
    Returns the list of file containers in this database
    
    Throws:
    
    WGAPIException
  - getFileContainer
```
public WGFileContainer getFileContainer(java.lang.String name)
                                 throws WGAPIException
```
    Return the file container of the given name
    
    Parameters:
    name -
    
    Throws:
    
    WGAPIException
  - createFileContainer
```
public WGFileContainer createFileContainer(java.lang.String name)
                                    throws WGAPIException
```
    Creates a new file container.
    
    Parameters:
    name - The name of the file container.
    
    Returns:
    The newly created file container.
    
    Throws:
    
    WGAPIException
  - createLanguage
```
public WGLanguage createLanguage(java.lang.String name)
                          throws WGAPIException
```
    Creates a new language definition only by name, which is also used as title
    
    Parameters:
    name - The name (i.e. language code) of the new language. language
    
    Returns:
    The newly created language definition.
    
    Throws:
    
    WGAPIException
  - createLanguage
```
public WGLanguage createLanguage(java.lang.String name,
                        java.lang.String title)
                          throws WGClosedSessionException,
                                 WGAPIException,
                                 WGDuplicateKeyException,
                                 WGCreationException
```
    Creates a new language definition.
    
    Parameters:
    name - The name (i.e. language code) of the new language.
    
    Returns:
    The newly created language definition.
    
    Throws:
    
    WGAPIException
    
    WGClosedSessionException
    
    WGDuplicateKeyException
    
    WGCreationException
  - createDraftCopy
```
public WGContent createDraftCopy(WGContent content)
                          throws WGAPIException
```
    Creates a draft copy of the given content document, keeping it's language
    
    Parameters:
    content -
    
    Returns:
    The draft copy of the content.
    
    Throws:
    
    WGAPIException
  - createDraftCopy
```
public WGContent createDraftCopy(WGContent content,
                        WGLanguage language)
                          throws WGAPIException
```
    Creates a draft copy of the given content, using the language given as parameter.
    
    Parameters:
    content - The content to copy
    language - The language for the draft copy. Specify null to keep the language of the original.
    
    Returns:
    The draft copy. This document is already stored when it is returned.
    
    Throws:
    
    WGAPIException
  - isCachingEnabled
```
public boolean isCachingEnabled()
```
    Indicates, if document caching is enabled globally for the database
  - setCachingEnabled
```
public void setCachingEnabled(boolean b)
```
    Controls if the document caching is enabled for this database. It is enabled by default. Turning it off may speed up writing operations but will mean significant overhead to recurring reading operations.
  - beginTransaction
```
public boolean beginTransaction()
                         throws WGAPIException
```
    Deprecated. Use startTransaction()
    
    Starts a database transaction. The database must support this, which is indicated by the feature WGDatabase.FEATURE_TRANSACTIONS.
    NOTE: This transaction functionality is for WGAPI internal use only! Use startTransaction() for external use.
    
    Returns:
    If the starting of the transaction succeeds
    
    Throws:
    
    WGAPIException
  - startTransaction
```
public WGTransaction startTransaction()
                               throws WGAPIException
```
    Starts a transaction and returns a transaction object. Changes done while the transaction runs will not be written to backend until WGTransaction.commit() is called. Calling WGTransaction.rollback() will revert all changes done in the transaction. If this is called while already in a transaction it returns a cascaded transaction. The commit of the cascaded transaction will be a no-op. Rolling back will roll back the real transaction. If this is called on a database backend which does not support transaction it returns a fake transaction with no-op operations.
    
    Returns:
    The transaction object
    
    Throws:
    
    WGAPIException
  - commitTransaction
```
public boolean commitTransaction()
                          throws WGAPIException
```
    Deprecated. Use WGTransaction.commit()
    
    Commits a database transaction, executing all data changes since the start of the transaction. A transaction must be started with beginTransaction() before calling this. The database must support transactions, which is indicated by the feature WGDatabase.FEATURE_TRANSACTIONS.
    NOTE: This transaction functionality is for WGAPI internal use only! Use startTransaction() for external use.
    
    Returns:
    If the committing of the transaction succeeds
    
    Throws:
    
    WGAPIException
  - rollbackTransaction
```
public boolean rollbackTransaction()
                            throws WGAPIException
```
    Deprecated. use WGTransaction.rollback()
    
    Rolls a database transaction back, canceling all data changes done since the start of the transaction. A transaction must be started with beginTransaction() prior to doing this. The database must support transactions, which is indicated by the feature WGDatabase.FEATURE_TRANSACTIONS.
    NOTE: This transaction functionality is for WGAPI internal use only! Use startTransaction() for external use.
    
    Returns:
    If the rolling back of the transaction succeeds
    
    Throws:
    
    WGAPIException
  - getACL
```
public WGACL getACL()
```
    Retrieves a WGACL object which manages the access control to this database. Is only supported by databases with feature WGDatabase.FEATURE_ACL_MANAGEABLE
  - getUserCache
```
public de.innovationgate.utils.UserHashMap getUserCache()
```
    Returns a HashMap that will store userdefined data for the currently logged in user. Each user has his own hash map. This information persists sessions and can be fetched again in later sessions.
  - getUserHashMapGroup
```
public de.innovationgate.utils.UserHashMapGroup getUserHashMapGroup()
```
    Returns the group of UserHashMaps for this database. Should not be used outside the WGAPI.
  - getNativeObject
```
public java.lang.Object getNativeObject()
                                 throws WGAPIException
```
    Returns the native backend object for this database if there is one.
    
    Throws:
    
    WGBackendException
    
    WGAPIException
  - isDesignDocumentType
```
public static boolean isDesignDocumentType(int docType)
```
    Tests if the given document type is the type of a design document, i.e. an area, contenttype, script module, file container, language definition or tml module
    
    Parameters:
    docType -
    
    Returns:
    true, if the doctype is a design document type, false if not
  - getAuthenticationModule
```
public AuthenticationModule getAuthenticationModule()
```
    Returns the authentication module used to authenticate sessions, if this database supports and uses a auth module. If this database uses a RedirectionAuthModule this method returns the real backend module. So this method should be used to access the module if some special, non-standard, capabilities are to be used
  - getMasterLoginPassword
```
public java.lang.String getMasterLoginPassword()
```
    Returns the password of the master login used to open this database.
  - getMaxCores
```
public int getMaxCores()
```
    Returns the maximum cores (i.e. backend document) that a session is allowed to hold at once. If more are retrieved, the oldest cores will be dropped to remain under this threshold.
  - getSessionStatistics
```
public org.apache.commons.collections.SortedBag getSessionStatistics()
```
    Returns collected statistics of sessions that exceeded the maxdocs threshold. A maximum of 100 statistics is collected. After that the statistics of the top 100 statistics with the most docs retrieved are kept.
  - setTitle
```
public void setTitle(java.lang.String string)
```
    Sets the title of the database. This is not stored in the backend database but only served via "getTitle()" until the database object is closed.
    
    Parameters:
    string - The title to set
  - getUpdatedDocumentsSince
```
public java.util.List<WGUpdateLog> getUpdatedDocumentsSince(java.lang.Comparable cutoff)
                                                     throws WGAPIException
```
    Retrieves logs of documents that were modified since a cutoff revision. This is only available in databases with feature WGDatabase.FEATURE_FIND_UPDATED_DOCS. The returned list does not reflect all changes done to the documents but returns a "condensed" list of operations reflecting the current state of documents in the smallest possible way:
    - If a document has been modified multiple times in a row there will only be one update log, no matter how much updates have been done
    - If a document was moved multiple times in a row and still exists there will be one move log, no matter how much updates have been done
    Parameters:
    cutoff - The cutoff revision. Documents modified earlier will not be included in the result
    
    Returns:
    List containing the log objects of type WGUpdateLog
    
    Throws:
    
    WGAPIException
  - hasContents
```
public boolean hasContents(WGStructEntry entry)
                    throws WGAPIException
```
    Returns if the given struct entry contains a content document. This method is capable of regarding content documents that the current user is not allowed to see.
    
    Parameters:
    entry - The entry to test
    
    Returns:
    true, if there exists a content (even those that the user may not see), false otherwise
    
    Throws:
    
    WGAPIException
  - getDocumentByDocumentKeyFromCache
```
public WGDocument getDocumentByDocumentKeyFromCache(java.lang.String documentKeyStr)
                                             throws WGAPIException
```
    Returns a document by it's document key, only if it is contained in cache.
    
    Parameters:
    documentKeyStr - The document key in its string representation
    
    Returns:
    The document if it already is cached, null otherwise
    
    Throws:
    
    WGAPIException
  - getDocumentByDocumentKeyFromCache
```
public WGDocument getDocumentByDocumentKeyFromCache(WGDocumentKey documentKey)
                                             throws WGAPIException
```
    Returns a document by it's document key, only if it is contained in cache.
    
    Parameters:
    documentKey - The document key
    
    Returns:
    The document if it already is cached, null otherwise
    
    Throws:
    
    WGAPIException
  - anyoneAllowed
```
public static boolean anyoneAllowed(java.util.List users,
                    boolean emptyMeansYes)
```
    Given a list of user/group names from an access control field (e.g. META_READERS in Content) tests if anyone is allowed the operation.
    
    Parameters:
    users - The list of user/group names
    emptyMeansYes - Determines if an empty field (size = 0; first element null or empty string) should return true
    
    Returns:
    true, if regarding this user/group list anyone is allowed
  - anyoneAllowed
```
public static boolean anyoneAllowed(java.util.List users)
```
    Given a list of user/group names from an access control field (e.g. META_READERS in Content) tests if anyone is allowed the operation. In this version of the method, an empty field (size = 0 or first element null or empty string) is always treated as true.
    
    Parameters:
    users - The list of user/group names
    
    Returns:
    true, if regarding this user/group list anyone is allowed
  - getAllContent
```
public java.util.Iterator<WGContent> getAllContent()
                                            throws WGAPIException
```
    Returns an Iterator iterating over all content documents in this database does not include archived documents
    
    Throws:
    
    WGAPIException
  - getAllContent
```
public java.util.Iterator<WGContent> getAllContent(boolean includeArchived)
                                            throws WGAPIException
```
    Returns an Iterator iterating over all content documents in this database
    
    Parameters:
    includeArchived - Should archived documents been included? true/false
    
    Throws:
    
    WGAPIException
  - getDbReference
```
public java.lang.String getDbReference()
```
    Returns a database reference to be used throughout the application (in WGA: the database key)
  - setDbReference
```
public void setDbReference(java.lang.String dbReference)
```
    Sets a reference for this database to use throughout the application.
  - defaultBuildUserDetails
```
public WGUserDetails defaultBuildUserDetails(AuthenticationSession authSession)
                                      throws WGAPIException
```
    Default implementation for building user details for an authentication session. This one can be used by DB implementations that implement FEATURE_ACL_MANAGEABLE. This method is not for direct usage outside of the WGAPI.
    
    Parameters:
    authSession - The authentication session to create details for
    
    Returns:
    User details object
    
    Throws:
    
    WGBackendException
    
    WGAPIException
  - defaultIsMemberOfUserList
```
public boolean defaultIsMemberOfUserList(java.util.List userList)
                                  throws WGAPIException
```
    Default implementation for determining user list membership. This may be used by DB-Implementations that return WGUserDetails to specify detailed user information. This method is not intended for direct usage outside of the WGAPI.
    
    Parameters:
    userList - A list of user/group/rolenames to determine membership for.
    
    Returns:
    true, if the current user is member, false if not.
    
    Throws:
    
    WGAPIException
  - defaultIsMemberOfUserList
```
public static boolean defaultIsMemberOfUserList(java.util.List userListOrig,
                                WGUserDetails userDetails)
```
    Default implementation for determining user list membership against any custom user details object.
    
    Parameters:
    userListOrig - A list of user/group/rolenames to determine membership for.
    userDetails - The user details representing the users authorisations
    
    Returns:
    true, if the current user is member, false if not.
  - isAllowDesignModification
```
public boolean isAllowDesignModification()
```
    Returns if this database allows modification of design documents for the current session This method returs false if any of the doctypes file container, script or tml module are not modifiable. For getting more detailed information the method isDoctypeModifiable(int) should be used.
  - setAllowDesignModification
```
public void setAllowDesignModification(boolean allowDesignUpdates)
```
    Sets if this database should allow modification of design documents This call equals calling setDoctypeModifiable(int, boolean) for the doctypes file container, script and tml module to false.
  - getAttributeNames
```
public java.util.Set getAttributeNames()
```
    Returns the names of all database attributes as a Set
  - getDesignProvider
```
public WGDesignProvider getDesignProvider()
```
    Returns an external design provider that was set to this database, if available
  - setDesignProvider
```
public void setDesignProvider(WGDesignProvider designProvider)
                       throws WGAPIException
```
    Sets an external design provider from which this database should retrieve design documents. Which design document types are provided is up to the provider.
    
    Parameters:
    designProvider - The design provider to set.
    
    Throws:
    
    LockException
    
    WGAPIException
  - certAuthEnabled
```
public boolean certAuthEnabled()
```
    Determines if certificate authentication is enabled for this database
  - putDefaultOption
```
public static void putDefaultOption(java.util.Map options,
                    java.lang.String key,
                    java.lang.Object value)
```
    Sets an option to a map if it is not already set
    
    Parameters:
    options - the map to use
    key - the key to set to the map
    value - the value to write to the map
  - 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 database 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 database 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
```
    gets the lockstatus for the current sessioncontext
    
    Returns:
    A value indication the lock status. See constants on de.innovationgate.webgate.api.locking.Lock.
    
    Throws:
    
    WGAPIException
  - getParentLockable
```
public Lockable getParentLockable()
```
    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
  - designChanged
```
public void designChanged(WGDesignChangeEvent event)
```
    Description copied from interface: WGDesignChangeListener
    
    The design of a design core provider or the database has changed. There might be no open database session on the design's database if the event originates from a design provider
    
    Specified by:
    
    designChanged in interface WGDesignChangeListener
    
    Parameters:
    event - Event information
  - queryUserProfileNames
```
public java.util.List queryUserProfileNames(java.lang.String type,
                                   java.lang.String query,
                                   java.util.Map params)
                                     throws WGAPIException
```
    Queries a user profile database for stored profiles, based on their data. The query syntax is up to the profile database implementation.
    
    Parameters:
    type - The type of the query
    query - Query to use for searching user profiles
    params - Parameters given to the query
    
    Returns:
    A list of names of user profiles whose profile data match the query
    
    Throws:
    
    WGQueryException
    
    WGAPIException
  - getAllUserProfileNames
```
public java.util.Iterator getAllUserProfileNames()
                                          throws WGAPIException
```
    Returns the names of all user profiles that are stored in the personalisation database
    
    Throws:
    
    WGNotSupportedException - If the database is not personalisation database
    
    WGAPIException
  - queryUserProfileNames
```
public java.util.List queryUserProfileNames(java.lang.String query)
                                     throws WGAPIException
```
    Queries a user profile database for stored profiles, based on their data. The query syntax is up to the profile database implementation. This variant uses the default query language for profile queries without parameters
    
    Parameters:
    query - Query to use for searching user profiles
    
    Returns:
    A list of names of user profiles whose profile data match the query
    
    Throws:
    
    WGQueryException
    
    WGAPIException
  - isConnected
```
public boolean isConnected()
```
    Returns if this database is already connected to its backend. This may be false, when the database was opened with WGFactory.prepareDatabase() and not session has been opened since.
  - getMetadataModule
```
public WGScriptModule getMetadataModule(java.lang.String name)
                                 throws WGAPIException
```
    A metadata module is a special version of a script module that is used to store metadata about the state of the database. It has some special behaviours: - It is never stored or retrieved from a design provider but always from the original db (even if the design provider target hosts metadata modules) - It is not synchronized or migrated along with other data - It is always of code type XML Metadata modules are stored technically as normal script modules with a prefix qualifier, retrieved from constant WGDatabase.METADATA_MODULE_QUALIFIER.
    
    Parameters:
    name - The name of the metadata module
    
    Returns:
    A metadata module
    
    Throws:
    
    WGAPIException
  - createMetadataModule
```
public WGCSSJSModule createMetadataModule(java.lang.String name)
                                   throws WGAPIException
```
    Creates a new metadata module. For details about metadata modules see method getMetadataModule.
    
    Parameters:
    name - Name of the module to create
    
    Returns:
    The created module
    
    Throws:
    
    LockException
    
    WGCreationException
    
    WGAuthorisationException
    
    WGAPIException
  - getUserCacheLatency
```
public int getUserCacheLatency()
```
    Returns the user cache latency in minutes. This is the time after which all user specific caches get discarded automatically to allow changes in the authentication backend to take effect. This setting can be specified via creation option COPTION_USERCACHELATENCY. If it is 0 the user caches are kept eternal unless the database data changes.
  - clearUserCaches
```
public void clearUserCaches()
```
    Clears all user-specific caches. These caches normally contain either cached authentication/authorisation information or links to content documents that these users are allowed to see.
  - getNoItemBehaviour
```
public WGDatabase.NoItemBehaviour getNoItemBehaviour()
```
    Returns the currently configured behaviour of this database regarding the request of nonexistent items
  - isReaderProfileCreation
```
public boolean isReaderProfileCreation()
```
    Returns if users with reader access to this profile database may create profile documents. This setting is effective when WGA Content Stores are used directly as personalisation databases, where the Content Store ACL also is effective for profile creation (while normal personalisation databases are always opened via master login).
  - getAllContentKeys
```
public java.util.List getAllContentKeys(boolean includeArchived)
                                 throws WGAPIException
```
    Returns a list of all content keys in the current database. This method may use optimized backend operations for this task, which do not need to traverse through WGAPI documents.
    
    Parameters:
    includeArchived - Specify true, to also retrieve content keys for archived contents
    
    Returns:
    List of content key objects WGContentKey
    
    Throws:
    
    WGAPIException
  - getLastCacheMaintenance
```
public java.util.Date getLastCacheMaintenance()
```
    Returns the system time where the last cache maintenance happened
  - beginUpdate
```
public void beginUpdate()
                 throws WGAPIException
```
    Notify database of the beginning of update operations via this connection. This is only neccessary in cluster environments when the underlying database connections are kept "readOnly" until a real update happens.
    
    Throws:
    
    WGAPIException
  - isDeletionCheck
```
public boolean isDeletionCheck()
```
    Returns if backend deletion checks are enabled, see COPTION_DELETIONCHECK
  - getChildNodeType
```
public java.lang.Class getChildNodeType()
```
    Description copied from interface: PageHierarchyNode
    
    Return the class type of child nodes
    
    Specified by:
    
    getChildNodeType in interface PageHierarchyNode
  - getChildNodes
```
public java.util.List getChildNodes()
                             throws WGAPIException
```
    Description copied from interface: PageHierarchyNode
    
    Returns the child nodes of this hierarchy node
    
    Specified by:
    
    getChildNodes in interface PageHierarchyNode
    
    Throws:
    
    WGAPIException
  - getChildNodeIterator
```
public de.innovationgate.utils.SkippingIterator<PageHierarchyNode> getChildNodeIterator(int pageSize)
                                                                                 throws WGAPIException
```
    Description copied from interface: PageHierarchyNode
    
    Returns an iterator for the child nodes of this hierarchy node
    
    Specified by:
    
    getChildNodeIterator in interface PageHierarchyNode
    
    Parameters:
    pageSize - The size of a fetch page, if the implementation fetches childnodes page-wise
    
    Throws:
    
    WGAPIException
  - getNodeKey
```
public java.lang.String getNodeKey()
```
    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
  - getNodeTitle
```
public java.lang.String getNodeTitle(java.lang.String language)
                              throws WGAPIException
```
    Description copied from interface: PageHierarchyNode
    
    Returns the display title for the node. If multiple titles for multiple languages exist we choose a specific one for the given language.
    
    Specified by:
    
    getNodeTitle in interface PageHierarchyNode
    
    Parameters:
    language - The language whose title is wanted
    
    Returns:
    The title
    
    Throws:
    
    WGAPIException
  - getParentNode
```
public PageHierarchyNode getParentNode()
```
    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
  - isProjectMode
```
public boolean isProjectMode()
```
    Returns if project mode is enabled, see COPTION_PROJECTMODE
  - onConnect
```
public boolean onConnect(WGDatabase.DatabaseAction action)
```
    Registers an action that should be executed when the database is connected. If it already is connected the action is executed at once and the method returns true. If it is not yet connected but only prepared for connecting the method returns false. In that case the action is executed at the time the database will be connected. This action is always executed under master session rights. Exceptions occurring in the action will be logged but never thrown to the outside.
    
    Parameters:
    action - The action to execute.
    
    Returns:
    true if the action was executed immediately, false if it is not.
  - onConnect
```
public boolean onConnect(WGDatabase.ConnectAction action)
```
    Deprecated. Use onConnect(DatabaseAction)
  - isAutoApprove
```
public boolean isAutoApprove()
```
    Returns if automatic approval is enabled, see COPTION_AUTOAPPROVE.
  - setAutoApprove
```
public void setAutoApprove(boolean autoApprove)
```
    Sets if automatic approval is enabled
  - setDoctypeModifiable
```
public void setDoctypeModifiable(int type,
                        boolean modifiable)
```
    Sets if documents of a given doctype are modifiable for non-master sessions Functionalities that feed the design of a database with external data might want to disable modifiability of those types that are served. This functionality is only effective for design and schema documents, those that are retrievable via getDesignObject(int, String, String).
    
    Parameters:
    type - The doctype to set. Use WGDocument.TYPE_... constants
    modifiable - Whether to set the doctype modifiable or unmodifiable
  - isDoctypeModifiable
```
public boolean isDoctypeModifiable(int type)
```
    Tests if documents of a given doctypes are modifiable for the current session
    
    Parameters:
    type - The type to test
    
    Returns:
    true, if docs of that type are modifiable
  - getAnyContentByName
```
public WGContent getAnyContentByName(java.lang.String name)
                              throws WGAPIException
```
    Returns a content with the given name in any language. Prefers the default language of the database. If no content with that name is found it tries every language defined in the database
    
    Parameters:
    name - The name to search
    
    Returns:
    The content if any was found or null
    
    Throws:
    
    WGAPIException
  - setDefaultLanguage
```
public void setDefaultLanguage(java.lang.String defaultLanguage)
```
    Manually set a default language for this database
    
    Parameters:
    defaultLanguage - The default language
  - addDesignChangeListener
```
public void addDesignChangeListener(WGDesignChangeListener changeListener)
```
    Adds a design change listener to this database. If the database uses a design provider it is registered with the provider. Otherwise it is registered as normal WGDatabaseEventListener. Not all design change events will carry information about the document being updated.
    
    Parameters:
    changeListener -
  - removeDesignChangeListener
```
public void removeDesignChangeListener(WGDesignChangeListener changeListener)
```
    Removes a design change listener to this database. If the database uses a design provider it is removed from the provider. Otherwise it is removed as normal WGDatabaseEventListener.
    
    Parameters:
    changeListener -
  - getScriptModule
```
public WGScriptModule getScriptModule(java.lang.String name,
                             java.lang.String codetype)
                               throws WGAPIException
```
    Returns the script module of the given name and codetype
    
    Parameters:
    name -
    codetype -
    
    Throws:
    
    WGAPIException
  - getScriptModule
```
public WGCSSJSModule getScriptModule(java.lang.String name)
                              throws WGAPIException
```
    Returns the script module of the given name and any codetype
    
    Parameters:
    name -
    
    Throws:
    
    WGAPIException
  - getScriptModules
```
public java.util.List<WGScriptModule> getScriptModules()
                                                throws WGAPIException
```
    Returns the script modules in this database.
    
    Throws:
    
    WGAPIException
  - createScriptModule
```
public WGScriptModule createScriptModule(java.lang.String name,
                                java.lang.String type)
                                  throws WGAPIException
```
    Create a new script module. Same as createCSSJSModule(String, String) but better named.
    
    Parameters:
    name - Name of the script module
    type - Code type of the module. Use constants WGScriptModule.CODETYPE_...
    
    Returns:
    The newly created script module
    
    Throws:
    
    WGAPIException
  - getCurrentBackendOperations
```
public java.util.List getCurrentBackendOperations()
```
    Returns the operation keys of backend operations that are currently running
    
    Returns:
    List of WGOperationKey objects
  - getOperationKeys
```
public java.util.Map getOperationKeys()
```
    Returns a map of operation keys currently or recently in usage
  - getRecentBackendOperations
```
public java.util.List getRecentBackendOperations()
```
    Returns the operation keys of backend operations that have run and are not yet cleant up
    
    Returns:
    List of WGOperationKey objects
  - setAuthenticationModule
```
public void setAuthenticationModule(AuthenticationModule authenticationModule)
                             throws WGIllegalArgumentException
```
    Injects an authentication module to the database that should be used to authenticate users.
    
    Parameters:
    authenticationModule - The module
    
    Throws:
    
    WGIllegalArgumentException
  - authenticationDataChanged
```
public void authenticationDataChanged()
```
    Description copied from interface: AuthenticationSourceListener
    
    Callback method on a change in the authentication data backend
    
    Specified by:
    
    authenticationDataChanged in interface AuthenticationSourceListener
  - getContentStoreVersion
```
public double getContentStoreVersion()
                              throws WGAPIException
```
    Returns the version of content store that this database represents, i.e the version of its storage format. The content store version equals the (Open)WGA feature version which introduced this storage format. Returns constants CSVERSION_...
    
    Throws:
    
    WGAPIException
  - getContentStorePatchLevel
```
public int getContentStorePatchLevel()
                              throws WGAPIException
```
    Returns the patch level of this content store. The patch level indicates automatic updates to the storage format of the content store which were applied. Generally the patch level complements the content store version, fetchable via getContentStoreVersion(), to indicate the feature set of the content store. This is the patch level that is currently active on the connected database. If the backend patch level changed since the last reconnect this will not be reflected.
    
    Throws:
    
    WGAPIException
  - visit
```
public void visit(WGPageVisitor visitor)
           throws WGAPIException
```
    Implements the visitor pattern on the page hierarchy. The visitor visits all areas, all of their struct entries and all of their (non-archived) contents.
    
    Parameters:
    visitor -
    
    Throws:
    
    WGAPIException
  - getServer
```
public WGDatabaseServer getServer()
```
    Returns the server used to connect to this database
  - clearContentData
```
public void clearContentData()
                      throws WGAPIException
```
    Completely clears this document of all content related documents, which is all contents, struct entries, areas, content types and languages WARNING (in case this has not yet become clear): This single method call will delete ALL documents of the given types in the database!
    
    Throws:
    
    WGAPIException
  - isAnonymousAccessible
```
public boolean isAnonymousAccessible()
                              throws WGAPIException
```
    Returns if the database can be accessed by anonymous users
    
    Throws:
    
    WGBackendException
    
    WGAPIException
  - enforceSchema
```
public void enforceSchema(WGSchemaDefinition schemaDef)
                   throws WGAPIException
```
    Enforces the given schema definition on the database
    
    Parameters:
    schemaDef -
    
    Throws:
    
    WGAPIException
  - getSchemaDefinition
```
public WGSchemaDefinition getSchemaDefinition()
```
    Returns the schema definition in effect on this database
  - createSchemaDefinition
```
public WGSchemaDefinition createSchemaDefinition()
                                          throws WGAPIException
```
    Creates a schema definition containing all content types and areas in this database with their current metadata.
    
    Throws:
    
    WGAPIException
  - toLowerCaseMeta
```
public java.lang.String toLowerCaseMeta(java.lang.String meta)
```
    Lowercases a metadata field value for this database if metadata lowercasing is not disabled
    
    Parameters:
    meta - The value to conditionally lowercase
  - isPageReadersEnabled
```
public boolean isPageReadersEnabled()
```
    Returns if visibility constraints of the hierarchical reader fields on areas and pages are enabled
  - getMandatoryReaders
```
public java.util.List<java.lang.String> getMandatoryReaders()
```
    Returns a list of readers that automatically have read access to all read-protected documents
  - isBackendServiceSupported
```
public boolean isBackendServiceSupported(java.lang.String serviceName)
                                  throws WGAPIException
```
    Returns if a backend service is supported
    
    Parameters:
    serviceName - Name of the service
    
    Throws:
    
    WGAPIException
  - callBackendService
```
public java.lang.Object callBackendService(java.lang.String serviceName,
                                  java.lang.Object[] params)
                                    throws WGAPIException
```
    Calls a backend service whose support is optional. Should throw WGNotSupportedException if the backend service is not supported. Calling backend services is only allowed on master sessions.
    
    Parameters:
    serviceName - The service name. Use WGDatabase.BACKENDSERVICE_*
    params - The matching parameters for the called service
    
    Returns:
    An optional return value of the service
    
    Throws:
    
    WGAPIException
  - releasePendingContents
```
public void releasePendingContents()
                            throws WGAPIException
```
    Fetches all content documents pending release and releases those that are ready to be released
    
    Throws:
    
    WGAPIException
  - enforceVersionCompliance
```
public void enforceVersionCompliance(java.lang.String compliance,
                            boolean enforceNoItemBehaviour)
```
    Enforces the given version compliance behaviour on this database
    
    Parameters:
    compliance - Compliance string from CSConfig.VERSIONCOMPLIANCE_*
    enforceNoItemBehaviour - If the behaviour regarding nonexistent items for the compliance should be enforced. May be false if this was already set by a higher priority configuration.
  - getComplianceVersion
```
public Version getComplianceVersion()
```
    Returns the WGA version whose behaviour is enforced on this database via enforceVersionCompliance(String, boolean)
  - getUUID
```
public java.lang.String getUUID()
```
    Returns a universal ID for the current database. This ID is stored on the data backend as database extension data field and therefor really identifies the backend databases data set rather than the WGAPI database instance. It is initialized on the first connection that is done via WGAPI to this database. Only OpenWGA Content Stores of version 5 or higher own a UUID. On other databases this returns null.
    
    Throws:
    
    WGAPIException
  - getSequence
```
public WGSequence getSequence(java.lang.String sequenceName)
                       throws WGAPIException
```
    Returns an WGAPI sequence object for the given sequence name. The sequence does not need to exist yet. This feature is only available on WGA Content Stores of version 5 or higher.
    
    Parameters:
    sequenceName - Name of the sequence
    
    Throws:
    
    WGAPIException
  - getUsedSequenceNames
```
public java.util.List<java.lang.String> getUsedSequenceNames()
                                                      throws WGAPIException
```
    Returns the names of sequences that are initialized and/or in use
    
    Throws:
    
    WGAPIException
  - catchupBackendChanges
```
public java.lang.Comparable catchupBackendChanges()
                                           throws WGAPIException
```
    checks for backend changes
    
    Returns:
    revision
    
    Throws:
    
    WGAPIException
  - setFileAnnotators
```
public void setFileAnnotators(java.util.List<WGFileAnnotator> annotators)
```
    Sets annotators which are called when files are attached to this database and is able to annotate the file with additional information
    
    Parameters:
    annotators - The annotators
  - getFileAnnotators
```
public java.util.List<WGFileAnnotator> getFileAnnotators()
```
    Returns the currently active file annotators on this database
  - getContentEventListeners
```
public java.util.List getContentEventListeners()
```
    Returns the list of content event listeners for this database. This list is the actual event listener list used by this WGDatabase. Code using iterators of this list should synchronize against the list
  - annotateMetadata
```
public void annotateMetadata(java.io.File file,
                    WGFileMetaData meta,
                    java.util.List<WGFileAnnotator> additionalAnnotators)
                      throws WGAPIException
```
    Tool method for annotating a metadata object based on the given file, using the default and optionally given additional annotators
    
    Parameters:
    file - The file data
    meta - The metadata object to annotate
    additionalAnnotators - Additional annotators to run.
    
    Throws:
    
    WGAPIException
  - maintenance
```
public void maintenance(boolean fullMaintenance)
                 throws WGException
```
    Throws:
    
    WGException
  - getPageRightsFilter
```
public PageRightsFilter getPageRightsFilter()
```
  - setPageRightsFilter
```
public void setPageRightsFilter(PageRightsFilter pageRightsFilter)
                         throws WGAPIException
```
    Throws:
    
    WGAPIException
  - setFileConverter
```
public void setFileConverter(WGFileConverter conv)
```
  - getFileConverter
```
public WGFileConverter getFileConverter()
```
  - createPageSequence
```
public void createPageSequence(WGStructEntry struct,
                      boolean forceCreate)
                        throws WGAPIException,
                               java.lang.InstantiationException,
                               java.lang.IllegalAccessException
```
    Throws:
    
    WGAPIException
    
    java.lang.InstantiationException
    
    java.lang.IllegalAccessException

Class WGDatabase

Usage patterns:

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXTDATA_DATABASE_UUID

EXTDATA_PATCH_LEVEL

EXTDATA_DERIVATE_CREATORS

EXTDATA_DERIVATE_REVISION

EXTDATA_CS_SYNC_RUNNING

PROTECTED_DATABASE_EXTDATA

DOCUMENTCACHE_SIZE_DEFAULT

NAMECACHE_SIZE_DEFAULT

QUERYCACHE_SIZE_DEFAULT

CSVERSION_NO_CONTENTSTORE

CSVERSION_WGA3

CSVERSION_WGA4_1

CSVERSION_WGA5

AUTHENTICATED_GROUP

COPTION_MEMORYCACHESIZE

COPTION_CACHEOVERFLOW

COPTION_AUTOAPPROVE

COPTION_PAGEREADERS_ENABLED

COPTION_USERCACHES_ENABLED

COPTION_PAGERIGHTSFILTER

SYSPROPERTY_VERBOSE_CACHEMANAGEMENT

SYSPROPERTY_VERBOSE_MUTABLECLONING

SYSPROPERTY_MAINTAIN_OPERATIONKEYS

SYSPROPERTY_VERBOSE_BACKENDACCESS

SYSPROPERTY_VERBOSE_BACKENDACCESS_DOCTYPES

COPTION_UPDATETIMEOUT

COPTION_DBREFERENCE

ALNAME_NOTLOGGEDIN

ALNAME_READER

ALNAME_NOACCESS

ALNAME_MANAGER

ALNAME_EDITOR

ALNAME_CHIEF_EDITOR

ALNAME_AUTHOR

ACCESSLEVELS

REAL_ACCESSLEVELS

ANONYMOUS_USER

SESSIONTOKEN_USER

UNKNOWN_REMOTE_USER

DEFAULT_MEDIAKEY

ACCESSLEVEL_NOTLOGGEDIN

ACCESSLEVEL_NOACCESS

ACCESSLEVEL_READER

ACCESSLEVEL_AUTHOR

ACCESSLEVEL_EDITOR

ACCESSLEVEL_CHIEF_EDITOR

ACCESSLEVEL_MANAGER

QUERYOPTION_ENHANCE

QUERYOPTION_ONLYRELEASED

QUERYOPTION_ONLYLANGUAGE

QUERYOPTION_EXCLUDEDOCUMENT

QUERYOPTION_RETURNQUERY

QUERYOPTION_MAXRESULTS

QUERYOPTION_CACHERESULT

QUERYOPTION_NATIVEOPTIONS

QUERYOPTION_ROLE

QUERYOPTION_USEDCACHE

QUERYOPTION_LANGUAGES

QUERYOPTION_QUERY_PARAMETERS

PROFILEQUERY_TYPE_ALL

ROLE_CONTENT

ROLE_DESIGN

ROLE_REPOSITORY

ROLE_USERPROFILES

FEATURE_QUERYABLE

FEATURE_SELF_PERSONALIZABLE

FEATURE_NATIVEEXPRESSIONS

FEATURE_EDITABLE

FEATURE_HIERARCHICAL

FEATURE_LASTCHANGED

FEATURE_COMPLEXVALUES

FEATURE_STORESVARS

FEATURE_FULLCONTENTFEATURES