de.innovationgate.webgate.api

Interface WGDatabaseCore

All Known Subinterfaces:

WGDatabaseCoreFeatureReturnHierarchyCount, WGDatabaseCoreFeatureSequenceProvider, WGPersonalisationDatabaseCore, WGReconfigurableDatabaseCore

All Known Implementing Classes:

BeanAdapter, QueryableSource, SimpleContentSource, SimpleRSS, WGDatabaseImpl, WGFakeContentStore, WGFakeDatabase

public interface WGDatabaseCore

Represents the core of a WGA database. WGDatabase wraps implementations of this interface and uses them to communicate with WGA content stores, design stores, data repositories or user profile stores. WGDatabaseCore implementations should be "thread-safe", so they should expect that they will be concurrently used by multiple threads.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	beginTransaction() Called when a transaction should begin.
void	beginUpdate() Notifies the backend database that the session will update data from now on.
java.lang.Object	callBackendService(java.lang.String serviceName, java.lang.Object[] params) Calls a backend service whose support is optional.
void	clearSessionCache() Is called when the cache of the current WGAPI session is cleared.
void	close() Called when a database implementation is completely closed and all cached data of it is dropped.
void	closeSession() Called when a database session is closed, i.e. the current thread/user stops working with this database for the logged in user.
boolean	commitTransaction() Called when a running transaction should get submitted Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.
java.lang.String	convertFileNameForAttaching(java.lang.String name) Returns a file name like it would be converted when a file of this name got attached to a document.
WGDocumentCore	createContent(WGStructEntry structEntry, WGLanguage language, java.lang.String title, int version) Called to create a content document.
WGDocumentCore	createCopy(WGDocumentCore original) Create a copy of the given doc core.
WGDocumentCore	createDesignDocument(int type, java.lang.String name, java.lang.String mediaKey) Create a design document of the given type and keys.
WGDocumentCore	createStructEntry(java.lang.Object key, WGDocument reference, WGContentType contentType) Creates a struct entry.
WGDocumentCore	fastAccess(int type, java.lang.Object key) Called for fast re-retrieval of a document core, if that core on first instantiation specified a fast access key.
WGACLCore	getACL() Retrieves the ACL if implementation supports WGDatabase.FEATURE_ACL_MANAGEABLE
java.util.List<WGDocumentCore>	getAllContent(WGStructEntry structEntry, boolean includeArchived) Retrieves a list of all content unter the specified struct entry.
java.util.List	getAllContentKeys(boolean includeArchived) Retrieves all content keys of all contents in this database as list.
java.util.Iterator<WGDocumentCore>	getChildEntries(WGStructEntry structEntry, WGPageOrderSet order) Retrieves all child struct entries for the provided struct entry.
WGDocumentCore	getContentByKey(WGContentKey key) Retrieves the content for the provided content key.
WGDocumentCore	getContentByName(java.lang.String strName, java.lang.String strLanguage) Retrieves a content by it's unique name for the given language.
int	getContentCount(WGStructEntry entry) Returns the number of total contents on this struct entry, including those that are not visible to the user.
int	getContentStorePatchLevel() Returns the patch level of the storage format of this WGA Content Store.
double	getContentStoreVersion() Returns the version of WGA Content Store that this backend represents.
java.lang.Class	getDedicatedWorkflowEngine() Retrieves the class of a dedicated workflow engine for this implementation.
WGDocumentCore	getDesignObject(int type, java.lang.String name, java.lang.String strMediaKey) Retrieves a design object by it's doc class and unique name.
java.util.List	getDesignObjects(int type) Retrieves all design objects of the given doc class.
WGDocumentCore	getDummyContent(java.lang.String language) Creates a "dummy content" object, that is used, when rendering WebTML without a content context.
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() Retrieves names of all extension data fields stored in this database.
java.util.List<WGRelationData>	getIncomingRelations(java.lang.Object structKey, java.lang.String language, java.lang.String sourceContentClass, java.lang.String relName, java.lang.String relGroupName, java.lang.Boolean includeUnreleased, WGColumnSet order) Must Return the relations that point to the given released content document
java.lang.Object	getNativeObject() Retrieves the native backend object for this database if there is any.
WGDocumentCore	getParentEntry(WGStructEntry entry) Retrieves the parent struct enty for the given entry.
java.lang.Comparable	getRevision() Returns an revision indicator of the last change done to this database This may be a anything that indicates the revision of the current database, like some java.util.Date or a sequence number.
java.util.Date	getRevisionDate(java.lang.Comparable lastChanged) Returns a date object corresponding to the given revision indicator Use this method to get concrete dates for the revisions returned by getRevision().
java.util.List	getRoles() Returns the roles that this database complies.
java.util.Iterator<WGDocumentCore>	getRootEntries(WGArea area, WGPageOrderSet pageOrder) Retrieves the root entries (i.e. entries without parents) of the given area.
java.lang.String	getServerName() Returns the name of the server for the backend database (if there is one)
WGDocumentCore	getStructEntryByKey(java.lang.Object key) Retrieves a struct entry for the given struct key
WGDocumentCore	getStructEntryByName(java.lang.String strName) Returns a struct entry by it's unique name
java.lang.String	getTitle() Retrieves a descriptive database title.
java.lang.String	getTypeName() Returns a description of this core implementation type.
java.util.List<WGUpdateLog>	getUpdateLogs(java.lang.Comparable cutoff) Retrieves list of update logs - i.e. the operations done on documents - since a cutoff revision in ascending order of operation times.
boolean	hasFeature(java.lang.String feature) Returns information on specific features, that this database implements.
boolean	isBackendServiceSupported(java.lang.String serviceName) Returns if a backend service is supported
boolean	isContentTypeUsed(WGContentType ct) Tests if the given content type is still in usage, i.e. if there are struct entries referencing it
boolean	isLanguageUsed(WGLanguage lang) Tests if the given language is still in usage, i.e. if there are contents referencing it
boolean	isMemberOfUserList(java.util.List userList) Determines if the currently logged in user is a member of the given user/group/role list.
boolean	moveStructEntry(WGStructEntry entry, WGDocument newParent) Moves a struct entry to a new parent document, either another struct entry of an area.
WGUserAccess	open(WGDatabase db, java.lang.String path, java.lang.String user, java.lang.String pwd, boolean prepareOnly) Opens a database initially.
WGUserAccess	openSession(AuthenticationSession authSession, java.lang.Object credentials, boolean master) Opens a session for the given user/thread.
java.lang.Object	parseStructKey(java.lang.String key) Parses the string representation of a struct key (as used in URLs) to the implementation specific format.
WGResultSetCore	query(java.lang.String type, java.lang.String query, java.util.Map parameters) Queries the database for content.
void	refresh() Is called when a database refresh is performed The core should perform necessary cleanups of cached data and held resources If the database supports WGAPI transactions it should reduce the impact of this method to the current session while in a transaction
void	removeExtensionData(java.lang.String name) Removes an extension data field from this database
boolean	resultIsFalse(java.lang.Object result, WGDocument doc) Tests, if an native expression result equals false in the native expression language.
boolean	resultIsTrue(java.lang.Object result, WGDocument doc) Tests, if an native expression result equals true in the native expression language.
boolean	rollbackTransaction() Called when a started transaction should be rolled back.
void	setCurrentSession(WGSessionContext context) Method to inject the current session context to the core.
void	writeExtensionData(java.lang.String name, java.lang.Object value) Writes an extension data field to in this database.

Method Detail

open

WGUserAccess open(WGDatabase db,
                java.lang.String path,
                java.lang.String user,
                java.lang.String pwd,
                boolean prepareOnly)
                  throws WGAPIException

Opens a database initially. It is ensured, that this method is to be called before any work on this database core is done. The implementation should also open a database session implicitly.

Parameters:

db - The WGDatabase object, that will wrap this database core.

path - The path of the database, that should be opened. Interpretation of the path is up to the specific database core

user - The user name for opening the initial session.

pwd - The password for the given username

prepareOnly - Flag if the database should only be prepared for opening

Returns:

The access level for the opened database under the current user session. Use constants WGDatabase.ACCESSLEVEL_.... as return. Return WGDatabase.ACCESSLEVEL_NOTLOGGEDIN, if the opening failed due to wrong path information or login.

Throws:

WGAPIException

openSession

WGUserAccess openSession(AuthenticationSession authSession,
                       java.lang.Object credentials,
                       boolean master)
                         throws WGAPIException

Opens a session for the given user/thread. Sessions are specific to single java threads and cannot be used across threads. It is ensured, that this method is to be called after each call of closeSession, before work on this database core starts again in the current thread.

Parameters:

authSession - The authentication session of the current user. If there is no authentication module configured this is of type BackendAuthSession

credentials - The credentials that the user gave for authenticating

master - States, that the used login is the master login

Returns:

The access object, containing the access level of the current user session. Use constants WGDatabase.ACCESSLEVEL_.... as return. Returns WGDatabase.ACCESSLEVEL_NOTLOGGEDIN, if the opening failed due to wrong login.

Throws:

WGAPIException

close

void close()
           throws WGAPIException

Called when a database implementation is completely closed and all cached data of it is dropped. Should release all resources.

Throws:

WGAPIException

closeSession

void closeSession()
                  throws WGAPIException

Called when a database session is closed, i.e. the current thread/user stops working with this database for the logged in user.

Throws:

WGAPIException

getTitle

java.lang.String getTitle()
                          throws WGBackendException

Retrieves a descriptive database title.

Returns:

String

Throws:

WGBackendException

getTypeName

java.lang.String getTypeName()

Returns a description of this core implementation type. Normally in format "dbplatform/dbdesign/furtherInfos/..."

Returns:

The implementation description

getRevision

java.lang.Comparable getRevision()
                                 throws WGAPIException

Returns an revision indicator of the last change done to this database This may be a anything that indicates the revision of the current database, like some java.util.Date or a sequence number. If the database implementation does not maintain such a date, it should return the creation date of the database. In that case the change dates of the documents are used to control cache dropping.

Returns:

Date

Throws:

WGAPIException

getRevisionDate

java.util.Date getRevisionDate(java.lang.Comparable lastChanged)
                               throws WGAPIException,
                                      WGWrongRevisionException

Returns a date object corresponding to the given revision indicator Use this method to get concrete dates for the revisions returned by getRevision(). This method is obliged to throw a WGWrongRevisionException if the revision type does not match this database of the given revision is not known.

Parameters:

lastChanged - A revision indicator returned by getRevision()

Returns:

A date

Throws:

WGAPIException

WGWrongRevisionException - if the given revision is no revision of the current database

getExtensionData

java.lang.Object getExtensionData(java.lang.String name)
                                  throws WGAPIException

Retrieves the value of an extension data field stored in this database. This feature is only available in WGA Content Stores of Version 5 or higher.

Parameters:

name - The name of the field.

Returns:

The value of the requested field for this database core.

Throws:

WGAPIException

getExtensionDataNames

java.util.List<java.lang.String> getExtensionDataNames()
                                                       throws WGAPIException

Retrieves names of all extension data fields stored in this database. This feature is only available in WGA Content Stores of Version 5 or higer.

Returns:

List of field names

Throws:

WGAPIException

writeExtensionData

void writeExtensionData(java.lang.String name,
                      java.lang.Object value)
                        throws WGAPIException

Writes an extension data field to in this database. This writes a custom data value to the database. The value is immediately stored. This feature is only available in WGA Content Stores of Version 5 or higher.

Parameters:

name - The name of the field.

value - The value to store

Throws:

WGAPIException

removeExtensionData

void removeExtensionData(java.lang.String name)
                         throws WGAPIException

Removes an extension data field from this database

Parameters:

name - The name of the field to remove

Throws:

WGAPIException

getRoles

java.util.List getRoles()

Returns the roles that this database complies. Based on this information, the WGAPI decides, which methods can be called on this database core.

Returns:

A list containing the constants WGDatabase.ROLE_.... for the roles, that this database complies.

hasFeature

boolean hasFeature(java.lang.String feature)

Returns information on specific features, that this database implements.

Parameters:

feature - The requested feature. The constants WGDatabase.FEATURE_... are used here.

Returns:

true, if this feature is implemented

getChildEntries

java.util.Iterator<WGDocumentCore> getChildEntries(WGStructEntry structEntry,
                                                 WGPageOrderSet order)
                                                   throws WGAPIException

Retrieves all child struct entries for the provided struct entry.

Parameters:

structEntry - The struct entry, whose children are to be retrieved

order - Instructions about the desired order

Returns:

An iterator of all child entries, ordered by their intended default order

Throws:

WGAPIException

getRootEntries

java.util.Iterator<WGDocumentCore> getRootEntries(WGArea area,
                                                WGPageOrderSet pageOrder)
                                                  throws WGAPIException

Retrieves the root entries (i.e. entries without parents) of the given area.

Parameters:

area - The area, whose root entries are to be retrieved

pageOrder - Order set denoting the order in which entries should be served, null for default order (position, title, both ascending)

Returns:

An iterator of root entries in their intended default order

Throws:

WGAPIException

getStructEntryByKey

WGDocumentCore getStructEntryByKey(java.lang.Object key)
                                   throws WGAPIException

Retrieves a struct entry for the given struct key

Parameters:

key -

Returns:

The struct entry of that key. Null if no struct entry has this key.

Throws:

WGAPIException

getParentEntry

WGDocumentCore getParentEntry(WGStructEntry entry)
                              throws WGAPIException

Retrieves the parent struct enty for the given entry.

Parameters:

entry - The struct entry, whose parent is to be retrieved

Returns:

The parent entry. Null if the parameter entry is a root entry and therefor has no parent.

Throws:

WGAPIException

getAllContent

java.util.List<WGDocumentCore> getAllContent(WGStructEntry structEntry,
                                           boolean includeArchived)
                                             throws WGAPIException

Retrieves a list of all content unter the specified struct entry.

Parameters:

structEntry - The struct entry, whose content is to be retrieved.

includeArchived - Decides, if archived documents should be also retrieved

Returns:

An unordered list of all content for this struct entry. An empty list, if there is no content for this struct entry.

Throws:

WGAPIException

getContentByKey

WGDocumentCore getContentByKey(WGContentKey key)
                               throws WGAPIException

Retrieves the content for the provided content key. If the version of the content key is 0 then the released content of the given struct and language must be retrieved.

Parameters:

key - The content key

Returns:

The retrieved content. Null, if there is no content for this key.

Throws:

WGAPIException

getContentByName

WGDocumentCore getContentByName(java.lang.String strName,
                              java.lang.String strLanguage)
                                throws WGAPIException

Retrieves a content by it's unique name for the given language. If language is null, the default language of the content store is used.

Parameters:

strName - The unique name

strLanguage - The language name (i.e. short code). If null, the default language of the content store is to be used.

Returns:

The retrieved content for this name. Null if there is no content with this unique name.

Throws:

WGAPIException

getStructEntryByName

WGDocumentCore getStructEntryByName(java.lang.String strName)
                                    throws WGAPIException

Returns a struct entry by it's unique name

Parameters:

strName - The unique name

Returns:

A struct entry of that name or null

Throws:

WGAPIException

getDummyContent

WGDocumentCore getDummyContent(java.lang.String language)
                               throws WGAPIException

Creates a "dummy content" object, that is used, when rendering WebTML without a content context. May return the "fake" document core implementation, if no native expression language is needed.

Returns:

WGDocumentCore

Throws:

WGAPIException

query

WGResultSetCore query(java.lang.String type,
                    java.lang.String query,
                    java.util.Map parameters)
                      throws WGAPIException

Queries the database for content. For full content store implementations: The native query implementation should itself enforce the query option WGDatabase.QUERYOPTION_ENHANCE, if set as parameter, regarding the following field: - "ishiddenfrom" regarding the role given as query option WGDatabase.QUERYOPTION_ROLE It might choose to enforce more visibility fields to optimize performance, but is not obliged to do so.

Parameters:

type - Type of query. Interpretation is up to the specific core implementation.

query - The query

parameters - Query options as Map influencing the query result. See WGDatabase.QUERYOPTION_... for options keys.

Returns:

WGResultSetCore The result set of this query as a specific WGResultSetCore implementation containing content.

Throws:

WGAPIException

fastAccess

WGDocumentCore fastAccess(int type,
                        java.lang.Object key)
                          throws WGAPIException

Called for fast re-retrieval of a document core, if that core on first instantiation specified a fast access key.

Parameters:

key - The fast access key, that the document core provided, when it was instantiated the first time.

Returns:

Another instance of the document core for this fast access key. Null, if none could be retrieved.

Throws:

WGAPIException

parseStructKey

java.lang.Object parseStructKey(java.lang.String key)
                                throws WGAPIException

Parses the string representation of a struct key (as used in URLs) to the implementation specific format.

Parameters:

key - The string representation of the struct key

Returns:

The struct key object to be used with this implementation.

Throws:

WGAPIException

createDesignDocument

WGDocumentCore createDesignDocument(int type,
                                  java.lang.String name,
                                  java.lang.String mediaKey)
                                    throws WGAPIException

Create a design document of the given type and keys.

Parameters:

type - Design document type. Use constants WGDocument.TYPE_...

name - Unique name of design object. Use only A-Z,a-z,0-9 and _

mediaKey - Media key, if the document type is a TML module

Returns:

The new created design document

Throws:

WGAPIException

createStructEntry

WGDocumentCore createStructEntry(java.lang.Object key,
                               WGDocument reference,
                               WGContentType contentType)
                                 throws WGAPIException

Creates a struct entry.

Parameters:

key - Key of the struct entry if the implementation supports using explicit keys. Leave null otherwise.

reference - Reference document, which can be an WGArea (struct will be root in this area) or another WGStructEntry (struct will be child of that)

contentType - Content type for this struct entry

Returns:

The newly created struct entry

Throws:

WGAPIException

createContent

WGDocumentCore createContent(WGStructEntry structEntry,
                           WGLanguage language,
                           java.lang.String title,
                           int version)
                             throws WGAPIException

Called to create a content document. Usage of parameters may vary according to the subset of WGA features implemented by this database core

Parameters:

structEntry - The structentry for the content

language - The language of the content

title - The title of the content

version - The version of the content if this should explicitly be set (only in clone creation!). Leave null for normal creation.

Returns:

The newly created content object.

Throws:

WGAPIException

getDedicatedWorkflowEngine

java.lang.Class getDedicatedWorkflowEngine()

Retrieves the class of a dedicated workflow engine for this implementation. Return null to use the default engine of the runtime.

isMemberOfUserList

boolean isMemberOfUserList(java.util.List userList)
                           throws WGAPIException

Determines if the currently logged in user is a member of the given user/group/role list.

Parameters:

userList -

Returns:

true if so, false otherwise.

Throws:

WGAPIException

createCopy

WGDocumentCore createCopy(WGDocumentCore original)
                          throws WGAPIException

Create a copy of the given doc core. Optional feature needed for methods WGDatabase.createDraftCopy and WGDatabase.createCopy

Parameters:

original -

Returns:

The copy.

Throws:

WGAPIException

beginTransaction

boolean beginTransaction()
                         throws WGAPIException

Called when a transaction should begin. Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.

Returns:

true, if the operation succeeded, false otherwise

Throws:

WGAPIException

rollbackTransaction

boolean rollbackTransaction()
                            throws WGAPIException

Called when a started transaction should be rolled back. Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.

Throws:

WGAPIException

commitTransaction

boolean commitTransaction()
                          throws WGAPIException

Called when a running transaction should get submitted Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.

Returns:

true, if the operation succeeded, false otherwise

Throws:

WGAPIException

getServerName

java.lang.String getServerName()
                               throws WGAPIException

Returns the name of the server for the backend database (if there is one)

Throws:

WGAPIException

getContentStoreVersion

double getContentStoreVersion()
                              throws WGAPIException

Returns the version of WGA Content Store that this backend represents. The features available for this database are dependent on the content store version. This method returns values of constants WGDatabase.CSVERSION_...

Throws:

WGAPIException

getContentStorePatchLevel

int getContentStorePatchLevel()
                              throws WGAPIException

Returns the patch level of the storage format of this WGA Content Store. Databases not representing content stores and not offering automatic patching should return 0.

Throws:

WGAPIException

getACL

WGACLCore getACL()

Retrieves the ACL if implementation supports WGDatabase.FEATURE_ACL_MANAGEABLE

getNativeObject

java.lang.Object getNativeObject()
                                 throws WGAPIException

Retrieves the native backend object for this database if there is any.

Throws:

WGBackendException

WGAPIException

resultIsTrue

boolean resultIsTrue(java.lang.Object result,
                   WGDocument doc)

Tests, if an native expression result equals true in the native expression language.

Parameters:

result - The expression result, retrieved by a call to evaluateExpression

doc - The document, against which the expression was evaluated

Returns:

boolean

resultIsFalse

boolean resultIsFalse(java.lang.Object result,
                    WGDocument doc)

Tests, if an native expression result equals false in the native expression language.

Parameters:

result - The expression result, retrieved by a call to evaluateExpression

doc - The document, against which the expression was evaluated

Returns:

boolean

refresh

void refresh()
             throws WGAPIException

Is called when a database refresh is performed The core should perform necessary cleanups of cached data and held resources If the database supports WGAPI transactions it should reduce the impact of this method to the current session while in a transaction

Throws:

WGAPIException

clearSessionCache

void clearSessionCache()
                       throws WGAPIException

Is called when the cache of the current WGAPI session is cleared. Should therefor clear all cached data and held resources for the current session. This may throw away make unsaved changes to backend classes.

Throws:

WGClosedSessionException - If currently no session is open

WGAPIException

moveStructEntry

boolean moveStructEntry(WGStructEntry entry,
                      WGDocument newParent)
                        throws WGAPIException

Moves a struct entry to a new parent document, either another struct entry of an area. May return false if this operation is not supported.

Parameters:

entry - The entry to move

newParent - The new parent document, which can be either an WGStructEntry or a WGArea object

Returns:

true if the operation succeeded, false if it is not supported by this WGAPI implementation.

Throws:

WGAPIException

getContentCount

int getContentCount(WGStructEntry entry)
                    throws WGAPIException

Returns the number of total contents on this struct entry, including those that are not visible to the user. This is helpful to determine if there are contents unknown to the current user, which may prevent some operations like deletions

Parameters:

entry - The entry to test

Returns:

true if there are contents, false otherwise

Throws:

WGNotSupportedException - If the database implementation does not support this operation

WGBackendException - On all other backend related errors

WGAPIException

setCurrentSession

void setCurrentSession(WGSessionContext context)

Method to inject the current session context to the core. This gives the core the ability to associate internal threadlocal resources to the corresponding session context.

Parameters:

context -

getDesignObjects

java.util.List getDesignObjects(int type)
                                throws WGAPIException

Retrieves all design objects of the given doc class.

Parameters:

type - The doc class. See constants WGDocument.FDC_...

Returns:

An unordered list of all design objects for this doc class. An empty list if there are no design objects of that class.

Throws:

WGAPIException

getDesignObject

WGDocumentCore getDesignObject(int type,
                             java.lang.String name,
                             java.lang.String strMediaKey)
                               throws WGAPIException

Retrieves a design object by it's doc class and unique name.

Parameters:

type - The doc class of the design object. See Constants under WGDocument.FDC_...

name - The unique name of the design

strMediaKey - For media key specific design objects (e.g. WebTML-Modules), the media key of the design object to be retrieved

Returns:

The retrieved design object.

Throws:

WGAPIException

convertFileNameForAttaching

java.lang.String convertFileNameForAttaching(java.lang.String name)

Returns a file name like it would be converted when a file of this name got attached to a document. WGAPI implementations are allowed to convert the name of an attached file in some ways, e.g. convert the name to lowercase or replace some unallowed characters. This method is used to convert names of files to attach before they are attached. It can also be used to test attaching behaviour. Implementations that do not support file attaching should return null here.

Parameters:

name -

getAllContentKeys

java.util.List getAllContentKeys(boolean includeArchived)
                                 throws WGAPIException

Retrieves all content keys of all contents in this database as list. Optional feature. Implementations that do not implement this method shoud return false on hasFeature(WGDatabase.FEATURE_RETRIEVE_ALL_CONTENTKEYS).

Parameters:

includeArchived - Specifies if archived content should be included in the list

Returns:

A list of objects #WGContentKey

Throws:

WGAPIException

beginUpdate

void beginUpdate()
                 throws WGAPIException

Notifies the backend database that the session will update data from now on. This is only neccessary in cluster environments when the underlying database connections are kept "readOnly" until a real update happens.

Throws:

WGAPIException

getUpdateLogs

java.util.List<WGUpdateLog> getUpdateLogs(java.lang.Comparable cutoff)
                                          throws WGAPIException

Retrieves list of update logs - i.e. the operations done on documents - since a cutoff revision in ascending order of operation times. Needed if database supports WGDatabase.FEATURE_FIND_UPDATED_DOCS.

Parameters:

cutoff -

Returns:

List of objects of type WGUpdateLog

Throws:

WGAPIException

getIncomingRelations

java.util.List<WGRelationData> getIncomingRelations(java.lang.Object structKey,
                                                  java.lang.String language,
                                                  java.lang.String sourceContentClass,
                                                  java.lang.String relName,
                                                  java.lang.String relGroupName,
                                                  java.lang.Boolean includeUnreleased,
                                                  WGColumnSet order)
                                                    throws WGAPIException

Must Return the relations that point to the given released content document

Parameters:

structKey - The structkey of the content

language - The language of the content

sourceContentClass - content class of the content owning the relation. null for contents of all content classes

relName - Name of the relation coming in. null should retrieve relations of all names

relGroupName - Group name of the relation coming in. null should retrieve relations of all groups

includeUnreleased - Specify true to also retrieve documents in draft or approval state. False will retrieve only published documents.

order - Optionally order in which to return relations, evaluated against the relation source documents, null for no order

Returns:

List of incoming relations in no particular order

Throws:

WGAPIException

isContentTypeUsed

boolean isContentTypeUsed(WGContentType ct)
                          throws WGAPIException

Tests if the given content type is still in usage, i.e. if there are struct entries referencing it

Parameters:

ct - The content type to test

Returns:

true if the content type is in usage, false if not

Throws:

WGAPIException

isLanguageUsed

boolean isLanguageUsed(WGLanguage lang)
                       throws WGAPIException

Tests if the given language is still in usage, i.e. if there are contents referencing it

Parameters:

lang - The language to test

Returns:

true if the language is in usage, false if not

Throws:

WGAPIException

isBackendServiceSupported

boolean isBackendServiceSupported(java.lang.String serviceName)

Returns if a backend service is supported

Parameters:

serviceName - Name of the service

callBackendService

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.

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