Package | Description |
---|---|
de.innovationgate.webgate.api |
Basic functionality of the WGAPI including most of the database-independent functionality.
|
de.innovationgate.webgate.api.auth |
External authentication modules for WGAPI databases.
|
de.innovationgate.webgate.api.fake |
Fake implementations for WGAPI, used by some WGAPI database types if they do not support certain document types.
|
de.innovationgate.webgate.api.locking |
This base contains classes for enabling the WGAPI locking functionality, which is used to get exclusive access to documents and databases.
|
de.innovationgate.webgate.api.mail |
Interfaces for mail services needed in the WGAPI (f.e. for delivery of workflow notification mails)
|
de.innovationgate.webgate.api.query.rss | |
de.innovationgate.webgate.api.schemadef |
Classes to create schema definitions for OpenWGA content stores
|
de.innovationgate.webgate.api.servers |
Base classes for database server functionalities in WGAPI
|
de.innovationgate.webgate.api.simple |
Generic implementations of content store templates from
de.innovationgate.webgate.api.templates |
de.innovationgate.webgate.api.templates |
Templates to create your own simple content/design/repository sources.
|
de.innovationgate.webgate.api.utils |
Utilities for WGAPI usage
|
de.innovationgate.webgate.api.workflow |
Workflow interfaces of the WGAPI including a database-independent workflow implementation, the "Straight Workflow".
|
Modifier and Type | Class and Description |
---|---|
class |
WGAuthorisationException
Thrown whenever a user tries to start an unauthorized action (e.g. create a content document).
|
class |
WGBackendException
Thrown on errors in a wgapi backend module
(e.g. connection problems to sql server, errors in backend api)
|
class |
WGCancelledException
Thrown whenever an operation was cancelled by some automatic task or the user
|
class |
WGClosedSessionException
Exception that is thrown whenever an operation is not possible because there is no open session on this database
|
class |
WGConfigurationException
Thrown when a functionality cannot be used because it has not been configured
properly.
|
class |
WGContentStoreVersionException
Thrown when a feature is used that is not available on the used OpenWGA content store version
|
class |
WGCreationException
Thrown for problems creating documents, that are no typical problems like duplicate keys, illegal state, arguments etc.
|
class |
WGDeletedException
Exception thrown when some functionality is used on an entity object whose backend entity seemingly has already been deleted
|
class |
WGDisabledException
Thrown when some backend service is disabled by configuration
|
class |
WGDocumentDoesNotExistException
Thrown on
WGDatabase.fetchDocumentListCache(WGDocumentListCache, int) to show that the searched document is marked "not available" in cache. |
class |
WGDuplicateKeyException
Thrown when an operation leads to a duplicate unique key.
|
class |
WGExpressionException
Thrown when a native expression caused an error while evaluating
|
class |
WGHierarchicalDatabaseEventCanceledException
Thrown when a HDB event is canceled by a listener using
WGHierarchicalDatabaseEvent.cancel(String, Throwable) |
class |
WGHierarchicalDatabaseEventException
thrown by WGHierarchicalDatabaseEvent to cancel() a process
|
class |
WGIllegalArgumentException
checked exception for IllegalArgumentException.
|
class |
WGIllegalDataException
Thrown when:
- Trying to retrieve data stored in a WGA database that is of illegal format and cannot be restored
- Trying to store data to a WGA database that this database type is not capable of storing
|
class |
WGIllegalStateException
checked exception corresponding to IllegalStateException.
|
class |
WGInvalidDatabaseException
Thrown whenever a WGA database cannot be opened because of invalid information
|
class |
WGNotSupportedException
Thrown, when an operation is not supported on the database type.
|
class |
WGProcedureException
Thrown, when a database procedure causes an error.
|
class |
WGQueryException
Thrown when a query results in an error, e.g. because of invalid query syntax
|
class |
WGRestrictionException
Thrown when an operation violates data restrictions
|
class |
WGSystemException
thrown on unexpected wgapi errors
|
class |
WGUnavailableException
Thrown when an error occured because of an unavailable backend service e.g. a database server
|
class |
WGUnresolveableVirtualLinkException
Thrown when a virtual link target cannot be resolved
|
class |
WGWrongRevisionException
Thrown when a revision is passed to a method that is no correct revision of the current database
|
Modifier and Type | Method and Description |
---|---|
boolean |
WGUserProfile.addHit()
Registers a "hit" (page impression) for the current user.
|
void |
WGUserProfile.addNewSession(javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpSession session)
Registers a new session for the user of this profile
|
java.lang.String |
WGContent.addRelationToGroup(java.lang.String group,
WGContent target)
Creates a new normal relation and adds it to a relation group.
|
java.lang.String |
WGContent.addRelationToGroup(java.lang.String group,
WGContent target,
int relType)
Creates a new relation and adds it to a relation group.
|
void |
WGDocument.afterSave(WGDocument.SaveAction action)
Adds an action that will be executed after the document is saved the next time on this database session.
|
void |
WGFileAnnotator.annotateFile(javax.activation.DataSource originalfileData,
WGFileAnnotations fileAnnotations)
Method annotating the file of the given data
|
void |
WGDatabase.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
|
void |
WGContent.approve(java.lang.String comment)
For a content document in status REVIEW, approves this document and continues the workflow.
|
void |
WGContent.archive(java.lang.String comment)
For a content document in Status RELEASE archives this document immediately.
|
java.util.List<WGStructEntry> |
WGStructEntryList.asList()
Returns a basic
List containing the struct entries in their order. |
java.lang.String |
WGHierarchicalDatabase.assignContentUID(WGContent con,
java.lang.String id)
Issues an UID to a content document.
|
void |
WGDocument.attachAllFiles(WGDocument doc)
Copies all attachments of the parameter document to the current document.
|
void |
WGDocument.attachAllFiles(WGDocument doc,
boolean copyExtensionData)
Copies all attachments of the parameter document to the current document
|
boolean |
WGDocument.attachFile(java.io.File file)
Attaches a file to the document.
|
boolean |
WGDocumentCore.attachFile(java.io.File file)
Attach a file from disk to the document
|
boolean |
WGDocumentCoreWrapper.attachFile(java.io.File file) |
boolean |
WGDocument.attachFile(java.io.File file,
java.util.List<WGFileAnnotator> additionalAnnotators)
Attaches a file to the document.
|
boolean |
WGDocument.attachFile(java.io.InputStream stream,
java.lang.String filename)
Takes data from an input stream and attaches the data as file
under the given name.
|
boolean |
WGDocument.attachFileWithoutAnnotation(java.io.File file)
Attaches a file to the document without running any annotators
|
boolean |
WGDocument.attachFileWithoutAnnotation(java.io.InputStream stream,
java.lang.String filename)
Takes data from an input stream and attaches the data as file, without running any annotators
under the given name.
|
void |
WGDocument.autoSave()
Marks the document to be automatically saved at the end of the session
|
boolean |
WGDatabaseCore.beginTransaction()
Called when a transaction should begin.
|
boolean |
WGDatabase.beginTransaction()
Deprecated.
|
void |
WGDatabaseCore.beginUpdate()
Notifies the backend database that the session will update data from now on.
|
void |
WGDatabase.beginUpdate()
Notify database of the beginning of update operations via this
connection.
|
static WGDocumentKey |
WGDocument.buildDocumentKey(WGDocumentCore core,
WGDatabase db)
Builds the document key for a document core.
|
java.lang.Object |
WGDatabaseCore.callBackendService(java.lang.String serviceName,
java.lang.Object[] params)
Calls a backend service whose support is optional.
|
java.lang.Object |
WGDatabase.callBackendService(java.lang.String serviceName,
java.lang.Object[] params)
Calls a backend service whose support is optional.
|
java.lang.Comparable |
WGDatabase.catchupBackendChanges()
checks for backend changes
|
void |
WGStructEntry.changeContentType(WGContentType contentType)
Change the content type for this struct entry and all its contents.
|
WGContent |
WGContentNavigator.chooseRelevantContent(WGContent retrievedContent,
WGContent previewContent)
Chooses the relevant content between a retrieved content, and a content currently previewed as draft, review or archived doc.
|
void |
WGSessionContext.clearCache()
Clears the session private cache including all fetched document cores.
|
void |
WGDatabase.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 |
WGPortletRegistry.clearItems(WGPortlet portlet)
Removes all portlet items for the given portlet
|
void |
WGContent.clearRelationGroup(java.lang.String group)
Removes all relations of the given group
|
void |
WGDatabaseCore.clearSessionCache()
Is called when the cache of the current WGAPI session is cleared.
|
void |
WGContent.clearVirtualLink()
Disables virtual link functionality for this content document and clears all fields related to it
|
void |
WGDatabaseCore.close()
Called when a database implementation is completely closed and all cached data of it is dropped.
|
void |
WGDatabase.close()
Completely closes this database object.
|
void |
WGDatabaseCore.closeSession()
Called when a database session is closed, i.e. the current thread/user stops working with this database for the logged in user.
|
void |
WGDatabase.closeSession()
Closes the database session.
|
java.util.List<WGContent> |
WGContentNavigator.collectRelevantContents(WGStructEntryList siblings)
Given a list of struct entry siblings this method retrieves the relevant contents for all siblings.
|
boolean |
WGDatabase.WGRealTransaction.commit() |
boolean |
WGDatabase.WGCascadedTransaction.commit() |
boolean |
WGDatabase.WGFakeTransaction.commit() |
boolean |
WGTransaction.commit()
Commit the transaction
|
boolean |
WGDatabaseCore.commitTransaction()
Called when a running transaction should get submitted
Needed when database supports feature WGDatabase.FEATURE_TRANSACTIONS.
|
boolean |
WGDatabase.commitTransaction()
Deprecated.
|
void |
WGContentEventListener.contentCreated(WGContentEvent contentEvent)
Triggered when a content is created.
|
void |
WGContentEventListener.contentHasBeenDeleted(WGContentEvent event)
Triggered after a content has been deleted.
|
void |
WGContentEventListener.contentHasBeenMoved(WGContentEvent event)
Triggered after a content has been moved.
|
void |
WGContentEventListener.contentHasBeenSaved(WGContentEvent event)
Triggered after a content has been saved.
|
boolean |
WGContentEventListener.contentSaved(WGContentEvent contentEvent)
Triggered just before a content is saved
|
void |
WGContentEventListener.contentStatusChanged(WGContentEvent event)
Triggered after the status a content has been changed
|
static WGContentKey |
WGContentKey.create(WGContent content)
Creates a new content key object, representing the unique content key of the parameter content.
|
static WGContentKey |
WGContentKey.create(WGContent content,
boolean unique)
Creates a new content key object, representing the content key of the parameter content.
|
static WGContentKey |
WGContentKey.create(WGDocumentCore doc)
Creates a new content key object, representing the unique content key of the parameter content core.
|
static WGContentKey |
WGContentKey.create(WGDocumentCore doc,
boolean unique)
Creates a new content key object, representing the content key of the parameter content core.
|
WGArea |
WGDatabase.createArea(java.lang.String name)
Creates a new area definition.
|
WGContentNavigator.IteratorCreator |
WGContentNavigator.createChildContentIterable(WGContent relContent,
int pageSize)
Creates an
Iterable for the child contents of the given content |
WGContentNavigator.IteratorCreator |
WGContentNavigator.createChildContentIterable(WGContent relContent,
int pageSize,
java.lang.String orderExpression)
Creates an
Iterable for the child contents of the given content |
WGStructEntry |
WGStructEntry.createChildEntry(WGContentType contentType,
java.lang.String title)
Create a child struct entry
|
WGContent |
WGContent.createChildPage(WGContentType contentType,
java.lang.String title)
Creates a new child page, including struct entry and content.
|
WGContent |
WGStructEntry.createChildPage(WGContentType contentType,
java.lang.String title,
java.lang.String language)
Creates a new child page, including struct entry and content.
|
WGFileMetaData |
WGFileMetaData.createClone()
Creates an identical clone of this metadata object
|
WGDocument |
WGCSSJSModule.createClone(WGDatabase db) |
WGDocument |
WGTMLModule.createClone(WGDatabase db) |
WGDocument |
WGFileContainer.createClone(WGDatabase db) |
abstract WGDocument |
WGDesignDocument.createClone(WGDatabase db)
Creates a clone of this design document in another database
|
WGDocument |
WGLanguage.createClone(WGDatabase db) |
WGDocument |
WGArea.createClone(WGDatabase db) |
WGDocument |
WGContentType.createClone(WGDatabase db) |
abstract WGDocument |
WGDocument.createClone(WGDatabase db,
WGDocument ref)
Creates a clone of this document in another database
|
WGDocument |
WGUserProfile.createClone(WGDatabase db,
WGDocument ref) |
WGDocument |
WGContent.createClone(WGDatabase db,
WGDocument ref) |
WGDocument |
WGStructEntry.createClone(WGDatabase db,
WGDocument ref) |
WGDocument |
WGDesignDocument.createClone(WGDatabase db,
WGDocument ref) |
WGContent |
WGDatabase.createContent()
Creates a simple content document.
|
WGContent |
WGArea.createContent()
Creates a new content as root for this area.
|
WGContent |
WGArea.createContent(java.lang.Object key,
java.lang.String title)
Creates a new content object as root in this area.
|
WGContent |
WGDatabase.createContent(java.lang.String title)
Creates a simple content document.
|
WGContent |
WGStructEntry.createContent(java.lang.String title)
Creates a new content for this struct entry, using the default language of the database.
|
WGContent |
WGStructEntry.createContent(java.lang.String language,
java.lang.String title)
Create a content document under this struct entry.
|
WGContent |
WGDatabase.createContent(WGArea area,
java.lang.Object key,
java.lang.String title)
Creates a simple content document with the content key given.
|
WGContent |
WGHierarchicalDatabase.createContent(WGContent parent)
creates a child content of the given parent with a generated title
|
WGContent |
WGHierarchicalDatabase.createContent(WGContent parent,
java.lang.String title)
creates a child content of the given parent with the given title,
|
WGContent |
WGHierarchicalDatabase.createContent(WGContent parent,
java.lang.String title,
java.lang.Object parameter)
creates a child content of the given parent with the given title,
parameter is delivered within the contentCreatedEvent
|
WGContent |
WGStructEntry.createContent(WGLanguage language,
java.lang.String title)
Create a content document under this struct entry.
|
WGContent |
WGDatabase.createContent(WGStructEntry entry,
WGLanguage language,
java.lang.String title)
Creates a new content document.
|
WGDocumentCore |
WGDatabaseCore.createContent(WGStructEntry structEntry,
WGLanguage language,
java.lang.String title,
int version)
Called to create a content document.
|
WGContentType |
WGDatabase.createContentType(java.lang.String name)
Creates a new content type.
|
WGDocumentCore |
WGDatabaseCore.createCopy(WGDocumentCore original)
Create a copy of the given doc core.
|
WGCSSJSModule |
WGDatabase.createCSSJSModule(java.lang.String name,
java.lang.String type)
Creates a new Script module
|
<T extends WGDatabaseServer> |
WGFactory.createDatabaseServer(java.lang.Class<T> serverClass,
java.util.Map<java.lang.String,java.lang.String> options)
Tool method for creating database servers when using WGAPI as library (rather than from inside WGA).
|
WGDocumentCore |
WGDatabaseCore.createDesignDocument(int type,
java.lang.String name,
java.lang.String mediaKey)
Create a design document of the given type and keys.
|
WGContent |
WGContent.createDraftCopy()
Creates a draft copy for this content that gets a new version number and starts in status "draft".
|
WGContent |
WGDatabase.createDraftCopy(WGContent content)
Creates a draft copy of the given content document, keeping it's language
|
WGContent |
WGDatabase.createDraftCopy(WGContent content,
WGLanguage language)
Creates a draft copy of the given content, using the language given as
parameter.
|
WGACLEntry |
WGACL.createEntry(java.lang.String name,
int type,
int accessLevel)
Creates a new ACL entry, that defines the access right for a user, group or role.
|
WGACLEntry |
WGACLCore.createEntry(java.lang.String name,
int type,
int accessLevel)
Create a new ACL entry.
|
WGFileContainer |
WGDatabase.createFileContainer(java.lang.String name)
Creates a new file container.
|
WGFileDerivateMetaData |
WGDocument.createFileDerivate(java.lang.String fileName,
java.lang.String creator,
java.lang.String name,
java.io.File file,
java.lang.String usage,
java.util.List<WGFileAnnotator> additionalAnnotators)
Creates a new file derivate for an existing original file attachment
|
WGFileDerivateMetaData |
WGDocumentCore.createFileDerivate(java.lang.String originalFileName,
java.lang.String creator,
java.lang.String derivateName,
java.io.InputStream in,
java.util.Map<java.lang.String,java.lang.Object> customMdFields)
Creates a derivate for the addressed file.
|
WGFileDerivateMetaData |
WGDocumentCoreWrapper.createFileDerivate(java.lang.String originalFileName,
java.lang.String creator,
java.lang.String derivateName,
java.io.InputStream in,
java.util.Map<java.lang.String,java.lang.Object> customMdFields) |
WGFileDerivateMetaData |
WGDocument.createFileDerivate(java.lang.String fileName,
java.lang.String creator,
java.lang.String derivateName,
java.io.InputStream in,
java.lang.String usage,
java.util.List<WGFileAnnotator> additionalAnnotators)
Creates a new file derivate for an existing original file attachment
|
static void |
WGHierarchicalDatabase.createInstance(WGDatabase database,
WGHierarchicalDatabaseStartup startupImpl)
creates a new hdb instance for the given WGDatabase
|
static void |
WGHierarchicalDatabase.createInstance(WGDatabase database,
WGHierarchicalDatabaseStartup startupImpl,
WGHierarchicalDatabaseListenerFactory listenerFactory)
creates a new hdb instance for the given WGDatabase
|
WGLanguage |
WGDatabase.createLanguage(java.lang.String name)
Creates a new language definition only by name, which is also used as title
|
WGLanguage |
WGDatabase.createLanguage(java.lang.String name,
java.lang.String title)
Creates a new language definition.
|
WGCSSJSModule |
WGDatabase.createMetadataModule(java.lang.String name)
Creates a new metadata module.
|
void |
WGStructEntry.createPageSequence() |
void |
WGStructEntry.createPageSequence(boolean forceCreate) |
void |
WGDatabaseCoreFeaturePageSequences.createPageSequence(WGDocumentCore struct,
boolean forceCreate) |
void |
WGDatabase.createPageSequence(WGStructEntry struct,
boolean forceCreate) |
WGContentNavigator.IteratorCreator |
WGContentNavigator.createParentContentIterable(WGContent relContent,
int pageSize)
Creates an
Iterable for the parent contents of the given content |
WGContentNavigator.IteratorCreator |
WGContentNavigator.createParentContentIterable(WGContent relContent,
int pageSize,
java.lang.String orderExpression)
Creates an
Iterable for the parent contents of the given content |
WGACLEntry |
WGACL.createRoleEntry(java.lang.String name)
Creates a new role entry in the ACL
|
WGStructEntry |
WGArea.createRootEntry(WGContentType contentType,
java.lang.String title)
Creates a new root entry for this area.
|
WGContent |
WGArea.createRootPage(WGContentType contentType,
java.lang.String title)
Variant of
WGArea.createRootPage(WGContentType, String, String) that always uses default language. |
WGContent |
WGArea.createRootPage(WGContentType contentType,
java.lang.String title,
java.lang.String language)
Creates a new root page, including struct entry and content.
|
WGSchemaDocumentDefinition |
WGSchemaDocument.createSchemaDefinition()
Creates a schema definition predefining all the metadata currently on this document
|
WGSchemaDefinition |
WGDatabase.createSchemaDefinition()
Creates a schema definition containing all content types and areas in this database with their current metadata.
|
WGScriptModule |
WGDatabase.createScriptModule(java.lang.String name,
java.lang.String type)
Create a new script module.
|
WGContent |
WGContent.createSearchResultDuplicate(SearchDetails searchDetails)
Creates a duplicate of this content object that represents a search result for some specific part of the content, identified by the given SearchDetails object
|
WGContentNavigator.IteratorCreator |
WGContentNavigator.createSiblingContentIterable(WGContent relContent,
int pageSize)
Creates an
Iterable for the sibling contents of the given content |
WGContentNavigator.IteratorCreator |
WGContentNavigator.createSiblingContentIterable(WGContent relContent,
int pageSize,
java.lang.String orderExpression)
Creates an
Iterable for the sibling contents of the given content |
WGContent |
WGHierarchicalDatabase.createStorage(java.lang.String id)
creates a storage with the given id
|
WGContent |
WGHierarchicalDatabase.createStorage(java.lang.String id,
java.lang.Object parameter)
creates a storage with the given id
|
WGContent |
WGHierarchicalDatabase.createStorage(WGContent parent,
java.lang.String id)
creates a storage with the given id as child of the given parent storage
|
WGContent |
WGHierarchicalDatabase.createStorage(WGContent parent,
java.lang.String id,
java.lang.Object parameter)
creates a storage with the given id as child of the given parent storage
|
java.lang.String |
WGHierarchicalDatabase.createStorageUID(WGContent parent,
java.lang.String id) |
WGDocumentCore |
WGDatabaseCore.createStructEntry(java.lang.Object key,
WGDocument reference,
WGContentType contentType)
Creates a struct entry.
|
WGStructEntry |
WGDatabase.createStructEntry(java.lang.Object key,
WGDocument parent,
WGContentType contentType,
java.lang.String title)
Creates a new struct entry
|
WGStructEntry |
WGDatabase.createStructEntry(WGDocument parent,
WGContentType contentType,
java.lang.String title)
Equivalent to calling createStructKey(null, parent, contentType, title).
|
WGTMLModule |
WGDatabase.createTMLModule(java.lang.String name,
java.lang.String mediaKey)
Creates a new TML module.
|
WGACLEntry |
WGACL.createUserEntry(java.lang.String name,
int accessLevel)
Creates a new ACL entry, that defines the access right for a user or group.
|
WGDocumentCore |
WGPersonalisationDatabaseCore.createUserProfile(java.lang.String name,
int type)
Called to create a new user profile.
|
WGUserProfile |
WGDatabase.createUserProfile(java.lang.String userNameWish,
int type)
Creates a new user profile.
|
WGUserProfile |
WGDatabase.createUserProfile(java.lang.String userNameWish,
int type,
boolean forceNew)
Creates a new user profile.
|
WGUserDetails |
WGDatabase.defaultBuildUserDetails(AuthenticationSession authSession)
Default implementation for building user details for an authentication
session.
|
boolean |
WGDatabase.defaultIsMemberOfUserList(java.util.List userList)
Default implementation for determining user list membership.
|
void |
WGHierarchicalDatabase.deleteContent(java.lang.String key)
deletes the content determined by the given key
|
void |
WGHierarchicalDatabase.deleteContent(java.lang.String key,
java.lang.Object parameter)
deletes the content determined by the given key
|
void |
WGHierarchicalDatabase.deleteContent(WGContent content)
deletes the given content
|
void |
WGHierarchicalDatabase.deleteContent(WGContent content,
java.lang.Object parameter)
deletes the given content
|
void |
WGDatabaseCoreFeatureSequenceProvider.deleteSequence(java.lang.String name)
Deletes a sequence, clearing all increment and initialisation data
|
void |
WGHierarchicalDatabase.deleteStorage(java.lang.String uid)
deletes the storage with the given id
|
void |
WGDatabase.determineDefaultLanguage()
Trigger the determination of a default language.
|
void |
WGDocumentCore.dispose()
Called when this core is disposed "untimely", i.e. before the current session is closed
|
void |
WGDocumentCoreWrapper.dispose() |
void |
WGDocument.dropCache()
Drops the cache of this document.
|
void |
WGContent.dropCache() |
void |
WGTMLModule.dropCache() |
void |
WGContentType.dropCache() |
void |
WGDatabase.enforceSchema(WGSchemaDefinition schemaDef)
Enforces the given schema definition on the database
|
java.lang.Object |
WGDocument.evaluateExpression(java.lang.String expression)
Evaluates a native expression with the current document as context.
|
java.lang.Object |
WGDocumentCore.evaluateExpression(java.lang.String expression)
Evaluates an expression in a database-native expression language on this document core.
|
java.lang.Object |
WGDocumentCoreWrapper.evaluateExpression(java.lang.String expression) |
WGDocumentCore |
WGDatabaseCore.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.
|
int |
WGDatabase.FreeContentVersionFinder.findNewVersion() |
java.util.List |
WGDatabase.fireWorkflowEvent(WGWorkflowEvent event)
Fires a workflow event.
|
java.util.Iterator<WGContent> |
WGDatabase.getAllContent()
Returns an Iterator iterating over all content documents in this database
does not include archived documents
|
WGContentList |
WGStructEntry.getAllContent()
Returns all active (non-archived) content under this struct entry.
|
java.util.Iterator<WGContent> |
WGDatabase.getAllContent(boolean includeArchived)
Returns an Iterator iterating over all content documents in this database
|
WGContentList |
WGStructEntry.getAllContent(boolean includeArchived)
Returns all content documents under this struct entry
|
java.util.List<WGDocumentCore> |
WGDatabaseCore.getAllContent(WGStructEntry structEntry,
boolean includeArchived)
Retrieves a list of all content unter the specified struct entry.
|
java.util.List |
WGDatabaseCore.getAllContentKeys(boolean includeArchived)
Retrieves all content keys of all contents in this database as list.
|
java.util.List |
WGDatabase.getAllContentKeys(boolean includeArchived)
Returns a list of all content keys in the current database.
|
java.util.List |
WGACL.getAllEntries()
Returns all ACL entries in this ACL.
|
java.util.List<? extends WGACLEntry> |
WGACLCore.getAllEntries()
Returns a list of all entries of this ACL (of type WGACLEntry)
|
java.util.List<java.lang.String> |
WGStructEntry.getAllowedChildTypes()
Returns the allowed content types for child pages of this struct.
|
java.util.List<java.lang.String> |
WGContentType.getAllowedChildTypes()
Returns the allowed content types for child pages on pages of this type.
|
java.util.List |
WGContentType.getAllowedPositions()
Returns the list of allowed positions for content of this type.
|
java.util.List<java.lang.String> |
WGArea.getAllowedRootTypes()
Returns the allowed content types for root pages on this area.
|
java.util.Map |
WGStructEntry.getAllReleasedContent()
Returns all released content documents under this struct entry, keyed by
their language code.
|
java.util.Iterator<java.lang.String> |
WGPersonalisationDatabaseCore.getAllUserProfileNames()
Returns the names of all user profiles stored inthe database
|
java.util.Iterator |
WGDatabase.getAllUserProfileNames()
Returns the names of all user profiles that are stored in the personalisation database
|
WGContent |
WGDatabase.getAnyContentByName(java.lang.String name)
Returns a content with the given name in any language.
|
java.util.List<WGContent> |
WGStructEntry.getArchivedContent(java.lang.String language)
Returns the archived contents for one language, as list in the order of their version numbers.
|
WGArea |
WGStructEntry.getArea()
Returns the area of this struct entry
|
WGArea |
WGDatabase.getArea(java.lang.String strName)
Returns the area with the given name
|
WGAreaMap |
WGDatabase.getAreas()
Returns a map of all areas of this database, mapped by their area name.
|
java.lang.String |
WGContent.getAuthor()
Returns the name of the content author.
|
java.lang.String |
WGContent.getAuthorEMail()
Returns the E-Mail address of the author of the current document
This method remains bc. of compatibility reasons.
|
java.lang.Comparable |
WGDatabase.getBackendRevision()
Returns the revision state of the database backend.
|
java.lang.String |
WGStructEntry.getBranchWorkflow()
Returns a workflow that was set to be used on this page and all subpages that themselves do not redefine the workflow.
|
java.lang.String |
WGContent.getBrowserTitle()
Returns the browser title of this document, the title to be shown as for the browser window when this document is loaded
|
WGStructEntry |
WGStructEntryList.getByIndex(int idx)
Retrieve a struct entry by it's index.
|
WGStructEntry |
WGStructEntryList.getByPosition(double pos)
Retrieves a struct entry by it's position number.
|
WGContent |
WGContentNavigator.getChildContent(WGContent relContent,
int idx)
Returns the nth child content of a parent content with the same language.
|
WGContent |
WGContentNavigator.getChildContent(WGContent relContent,
int idx,
int searchOrder)
Deprecated.
searchOrder argument is ineffective. Use
WGContentNavigator.getChildContent(WGContent, int) instead. |
WGHierarchyContentIterator |
WGContent.getChildContentIterator(int pageSize)
Returns an iterator over the child contents of this content
Internally the iterator fetches multiple pages at once from the backend for more performant backend retrieval processes.
|
java.util.List<WGContent> |
WGContent.getChildContents()
Collects all released contents of identical language on child struct entries.
|
java.util.List<WGContent> |
WGContent.getChildContents(int offset,
int size)
Collects a range of released contents of identical language on child struct entries.
|
java.util.List<java.lang.String> |
WGStructEntry.getChildEditors()
Returns the editors allowed to edit child entries and content of this
struct entry
|
WGStructEntryList |
WGStructEntry.getChildEntries()
Returns the child entries of this struct entry
|
WGStructEntryList |
WGStructEntry.getChildEntries(int offset,
int size)
Returns a partial list of the child entries of this struct entry
|
java.util.Iterator<WGDocumentCore> |
WGDatabaseCore.getChildEntries(WGStructEntry structEntry,
WGPageOrderSet order)
Retrieves all child struct entries for the provided struct entry.
|
int |
WGStructEntry.getChildEntryCount()
Returns the number of child entries without actually retrieving them.
|
int |
WGDatabaseCoreFeatureReturnHierarchyCount.getChildEntryCount(WGStructEntry structEntry)
Retrieves the number of child entries of the given struct entry without actually retrieving them
|
WGStructEntryIterator |
WGStructEntry.getChildEntryIterator(int pageSize)
Returns an iterator over the child entries of this struct entry
Internally the iterator fetches multiple entities at once from the backend for more performant backend retrieval processes.
|
de.innovationgate.utils.SkippingIterator<PageHierarchyNode> |
WGDatabase.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGDatabase.DocumentCollectionHierarchy.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGContent.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGStructEntry.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGCSSJSModule.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGTMLModule.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
PageHierarchyNode.getChildNodeIterator(int pageSize)
Returns an iterator for the child nodes of this hierarchy node
|
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGFileContainer.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGLanguage.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGArea.getChildNodeIterator(int pageSize) |
de.innovationgate.utils.SkippingIterator<? extends PageHierarchyNode> |
WGContentType.getChildNodeIterator(int pageSize) |
java.util.List |
WGDatabase.getChildNodes() |
java.util.List<? extends PageHierarchyNode> |
WGDatabase.DocumentCollectionHierarchy.getChildNodes() |
java.util.List<PageHierarchyNode> |
WGDatabase.AllDocumentsHierarchy.getChildNodes() |
java.util.List<PageHierarchyNode> |
WGContent.getChildNodes() |
java.util.List |
WGStructEntry.getChildNodes() |
java.util.List<PageHierarchyNode> |
WGCSSJSModule.getChildNodes() |
java.util.List<PageHierarchyNode> |
WGTMLModule.getChildNodes() |
java.util.List<? extends PageHierarchyNode> |
PageHierarchyNode.getChildNodes()
Returns the child nodes of this hierarchy node
|
java.util.List<PageHierarchyNode> |
WGFileContainer.getChildNodes() |
java.util.List<PageHierarchyNode> |
WGLanguage.getChildNodes() |
java.util.List<PageHierarchyNode> |
WGArea.getChildNodes() |
java.util.List<PageHierarchyNode> |
WGContentType.getChildNodes() |
java.lang.String |
WGStructEntry.getChildPageRestrictions()
Returns the restrictions regarding childpages of this struct.
|
java.lang.String |
WGContentType.getChildPageRestrictions()
Returns the restrictions regarding childpages on pages of this content type.
|
abstract java.util.List<WGPortlet> |
WGPortletRegistry.getChildPortlets(WGPortlet portlet)
Returns the child portlets for the given parent portlet
|
java.util.List<WGPortlet> |
WGTransientPortletRegistry.getChildPortlets(WGPortlet portlet) |
java.lang.String |
WGUserProfile.getClient()
Returns the browser client of the user
|
java.util.List |
WGContent.getCoauthors()
Returns the list of co-authors of this content.
|
java.lang.String |
WGCSSJSModule.getCode()
Returns the program code of this library.
|
java.lang.String |
WGTMLModule.getCode()
returns the WebTML-Code
|
int |
WGCSSJSModule.getCodeOffset()
Returns the line number that the first line of code in this module had in its source medium.
|
int |
WGTMLModule.getCodeOffset()
Returns the line number that the first line of code in this module had in its source medium.
|
java.lang.String |
WGCSSJSModule.getCodeType()
Returns the library type.
|
java.util.List |
WGResultSetCore.getColumnNames()
Returns the name of result row columns, if this query serves multi column results
Result set cores not supporting this type of results should return null here
|
WGContent |
WGContentEvent.getContent()
Retrieves and returns the content document that has changed.
|
WGContent |
WGHierarchicalDatabase.getContent(java.lang.String key)
returns currently published content object for the given key
|
WGContent |
WGStructEntry.getContent(java.lang.String language,
int version)
Returns a specific content of the given language and content version
|
WGContent |
WGStructEntry.getContent(java.lang.String language,
java.lang.String status)
Returns a content of the given language and status, if any exists.
|
WGContent |
WGDatabase.getContentByKey(java.lang.String keyStr)
Return a content document by content key string.
|
WGDocumentCore |
WGDatabaseCore.getContentByKey(WGContentKey key)
Retrieves the content for the provided content key.
|
WGContent |
WGDatabase.getContentByKey(WGContentKey key)
Return a content document by content key
|
WGContent |
WGDatabase.getContentByName(java.lang.String name)
Retrieves a content by it's unique name in the database's default
language.
|
WGDocumentCore |
WGDatabaseCore.getContentByName(java.lang.String strName,
java.lang.String strLanguage)
Retrieves a content by it's unique name for the given language.
|
WGContent |
WGDatabase.getContentByName(java.lang.String strName,
java.lang.String strLanguage)
Retrieves a content by it's unique name.
|
java.lang.String |
WGContent.getContentClass()
Returns the content class of this content.
|
int |
WGStructEntry.getContentCount()
Returns the number of content documents in any status or language, that are located at this struct entry.
|
int |
WGDatabaseCore.getContentCount(WGStructEntry entry)
Returns the number of total contents on this struct entry, including those that are not visible to the user.
|
java.util.List |
WGLanguage.getContentCreators()
Old version of
WGLanguage.getEditors() . |
java.util.List |
WGContentType.getContentCreators()
Deprecated.
|
WGContentKey |
WGContent.getContentKey()
Returns the unique content key of this content document.
|
WGContentKey |
WGContent.getContentKey(boolean unique)
Returns the content key of this document, either in unique mode (real version is always used) or in URL mode (0 is used as version, when document is released)
|
java.lang.Integer |
WGContentNavigator.getContentLevel(WGContent relContent)
Retrieves the hierarchical level of a content document.
|
WGContentList |
WGResultSet.getContentList()
Called to retrieve a list of all content in this result set.
|
WGContentList |
WGStandardResultSet.getContentList() |
java.util.List |
WGResultSetCore.getContentList()
Called to retrieve a list of all content in this result set.
|
java.util.List<? extends java.lang.Object> |
WGCachedResultSet.getContentList() |
WGContentList |
WGResultSet.getContentList(int start,
int length)
Called to retrieve a subset of content of this result set.
|
WGContentList |
WGStandardResultSet.getContentList(int start,
int length) |
java.util.List |
WGResultSetCore.getContentList(int start,
int length)
Called to retrieve a subset of content of this result set.
|
java.util.List<? extends java.lang.Object> |
WGCachedResultSet.getContentList(int start,
int length) |
WGStructEntry.ContentSet |
WGStructEntry.getContentSet(boolean includeArchived)
Returns the set of contents for the current WGStructEntry
|
int |
WGDatabaseCore.getContentStorePatchLevel()
Returns the patch level of the storage format of this WGA Content Store.
|
int |
WGDatabase.getContentStorePatchLevel()
Returns the patch level of this content store.
|
double |
WGDatabaseCore.getContentStoreVersion()
Returns the version of WGA Content Store that this backend represents.
|
double |
WGDatabase.getContentStoreVersion()
Returns the version of content store that this database represents, i.e the version of its storage format.
|
WGContentType |
WGStructEntry.getContentType()
Returns the content type for this struct entry
|
WGContentType |
WGHierarchicalDatabase.getContentType()
Retrieves the WGAPI Content Type that this HDB uses to construct contents
|
WGContentType |
WGDatabase.getContentType(java.lang.String name)
Returns a content type document of the given name
|
java.util.List<WGContentType> |
WGDatabase.getContentTypes()
Returns a list with all content types stored in this database
|
WGDocumentCore |
WGDocument.getCore()
Returns the core implementation object for this document.
|
java.util.Date |
WGDocument.getCreated()
Returns the creation date of this document
|
java.util.Date |
WGDocumentCore.getCreated()
Retrieves the creation date of this document.
|
java.util.Date |
WGDocumentCoreWrapper.getCreated() |
WGScriptModule |
WGDatabase.getCSSJSModule(java.lang.String name)
Returns the script module of the given name.
|
WGScriptModule |
WGDatabase.getCSSJSModule(java.lang.String name,
java.lang.String type)
Returns the script module of the given name and type
|
java.util.List |
WGDatabase.getCSSJSModules()
Returns the script modules in this database.
|
java.util.List<java.lang.String> |
WGFileAnnotations.getCustomFieldNames()
Returns the names of custom fields annotated for this file
|
java.lang.Object |
WGFileAnnotations.getCustomFieldValue(java.lang.String fieldName)
Returns the value of a custom field annotated for this file
|
java.lang.String |
WGUserProfile.getDBLogin()
Returns the database login used by the web user
|
java.lang.String |
WGDatabase.getDefaultLanguage()
Returns the default language of this database
|
java.lang.String |
WGContent.getDescription()
Returns a description for this content document
|
java.lang.String |
WGDesignDocument.getDescription()
Returns the description of this design document
|
java.util.List |
WGContentType.getDescriptionAliases()
Returns aliases for descriptions in different languages.
|
java.lang.String |
WGContentType.getDescriptionForLanguage(java.lang.String lang)
Returns a content type description for the specified language.
|
WGDesignDocument |
WGDatabase.getDesignObject(int type,
java.lang.String strName)
Returns a design object with the given information.
|
abstract WGDocumentCore |
WGConfigurableTypeDesignProvider.getDesignObject(int type,
java.lang.String name,
java.lang.String strMediaKey) |
WGDocumentCore |
WGDatabaseCore.getDesignObject(int type,
java.lang.String name,
java.lang.String strMediaKey)
Retrieves a design object by it's doc class and unique name.
|
WGDesignDocument |
WGDatabase.getDesignObject(int type,
java.lang.String strName,
java.lang.String mediaKey)
Returns a design object with the given information
|
WGDocumentCore |
WGDesignProvider.getDesignObject(int type,
java.lang.String name,
java.lang.String strMediaKey)
Retrieves a design object by it's doc class and unique name.
|
abstract java.util.List |
WGConfigurableTypeDesignProvider.getDesignObjects(int type) |
java.util.List |
WGDatabaseCore.getDesignObjects(int type)
Retrieves all design objects of the given doc class.
|
java.util.List<? extends WGDesignDocument> |
WGDatabase.getDesignObjects(int type)
Returns all design objects of a specific type.
|
java.util.List |
WGDesignProvider.getDesignObjects(int type)
Retrieves all design objects of the given doc class.
|
de.innovationgate.wga.config.DesignReference |
WGDesignDocument.getDesignReference()
Returns a design reference object that uniquely identifies the location of this design
|
int |
WGFileAnnotations.getDisplayHeight()
Returns the display height in pixels for images or videos
|
int |
WGFileAnnotations.getDisplayWidth()
Returns the display width in pixels for images or videos
|
WGDocument |
WGDocumentKey.getDocument(WGDatabase db)
Tries to retrieve the document for the document key from the given database
|
WGDocument |
WGDatabase.getDocumentByDocumentKey(java.lang.String key)
Deprecated.
Use
WGDatabase.getDocumentByKey(String) instead |
WGDocument |
WGDatabase.getDocumentByDocumentKeyFromCache(java.lang.String documentKeyStr)
Returns a document by it's document key, only if it is contained in
cache.
|
WGDocument |
WGDatabase.getDocumentByDocumentKeyFromCache(WGDocumentKey documentKey)
Returns a document by it's document key, only if it is contained in
cache.
|
WGDocument |
WGDatabase.getDocumentByKey(java.lang.String key)
Returns a document by the given document key.
|
WGDocument |
WGDatabase.getDocumentByKey(WGDocumentKey documentKey)
Returns a document by the given document key.
|
org.dom4j.Document |
WGCSSJSModule.getDOMDocument()
If codetype is XML, returns the contained XML-code as dom Document.
|
WGContent |
WGHierarchicalDatabase.getDummyContent()
Returns a dummy content object for the current database in the language that the HDB uses
|
WGDocumentCore |
WGDatabaseCore.getDummyContent(java.lang.String language)
Creates a "dummy content" object, that is used, when rendering WebTML without a content context.
|
WGContent |
WGDatabase.getDummyContent(java.lang.String language)
Retrieves a dummy content object.
|
WGUserProfile |
WGDatabase.getDummyProfile(java.lang.String name)
Returns a dummy profile object that does not store information.
|
java.util.List |
WGLanguage.getEditors()
Returns a list of names allowed to edit content for this language.
|
java.util.List |
WGArea.getEditors()
Returns a list of allowed content editors in this area.
|
java.util.List |
WGContentType.getEditors()
Returns a list of users allowed to edit content based on this content
type.
|
java.util.List<java.lang.String> |
WGStructEntry.getEffectiveAllowedChildTypes()
Returns the allowed content types for child pages of this struct that are actually effective.
|
java.util.List<java.lang.String> |
WGStructEntry.getEffectiveChildEditors()
Returns the list of currently effective child editors.
|
java.lang.String |
WGStructEntry.getEffectiveChildPageRestrictions()
Returns the effective restrictions regarding childpages of this struct.
|
java.util.List |
WGArea.getEffectiveEditors()
Returns the list of currently effective editors.
|
java.util.List<java.lang.String> |
WGStructEntry.getEffectivePageEditors()
Returns the list of currently effective page editors.
|
java.util.List<java.lang.String> |
WGStructEntry.getEffectiveReaders()
Returns the list of currently effective readers.
|
java.util.List |
WGArea.getEffectiveReaders()
Returns the list of currently effective readers.
|
WGACLEntry |
WGACL.getEntry(java.lang.String name)
Returns the entry for a given name
|
WGACLEntry |
WGACLCore.getEntry(java.lang.String name)
Returns an ACL entry of the given user/group/role name
|
WGEventScript |
WGContentType.getEventContentCreated()
Retrieves the event script for event "contentCreated"
|
WGEventScript |
WGContentType.getEventContentSaved()
Retrieves the event script for event "contentSaved"
|
WGEventScript |
WGContentType.getEventStatusChange()
Retrieves the event script for event "statusChange"
|
WGEventScript |
WGContentType.getEventWorkflowMail()
Retrieves the event script for event "workflowMail"
|
java.lang.Object |
WGDocument.getExtensionData(java.lang.String strName) |
java.lang.Object |
WGDatabaseCore.getExtensionData(java.lang.String name)
Retrieves the value of an extension data field stored in this database.
|
java.lang.Object |
WGDatabase.getExtensionData(java.lang.String name)
Retrieves the value of an extension data field stored in this database.
|
java.lang.Object |
WGExtensionDataContainer.getExtensionData(java.lang.String strName)
Returns the value of an extension data field.
|
java.lang.Object |
WGDocumentCoreWrapper.getExtensionData(java.lang.String strName) |
java.util.List<java.lang.String> |
WGDocument.getExtensionDataNames() |
java.util.List<java.lang.String> |
WGFileMetaData.getExtensionDataNames() |
java.util.List<java.lang.String> |
WGDatabaseCore.getExtensionDataNames()
Retrieves names of all extension data fields stored in this database.
|
java.util.List<java.lang.String> |
WGFileDerivateMetaData.getExtensionDataNames() |
java.util.List<java.lang.String> |
WGDatabase.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<java.lang.String> |
WGExtensionDataContainer.getExtensionDataNames()
Returns the names of all extension data fields on this entity
|
java.util.List |
WGDocumentCoreWrapper.getExtensionDataNames() |
WGFileContainer |
WGDatabase.getFileContainer(java.lang.String name)
Return the file container of the given name
|
java.util.List<WGFileContainer> |
WGDatabase.getFileContainers()
Returns the list of file containers in this database
|
java.io.InputStream |
WGDocument.getFileData(java.lang.String strFile)
Returns the data of a file attachment as input stream
Retrieving the data of a recently attached file while the document is not yet saved is not supported and may produce unknown results.
|
java.io.InputStream |
WGDocumentCore.getFileData(java.lang.String strFile)
Retrieves an input stream to the data of an embedded file.
|
java.io.InputStream |
WGDocumentCoreWrapper.getFileData(java.lang.String strFile) |
java.io.InputStream |
WGDocument.getFileDerivateData(java.lang.String id)
Returns the data of a file derivate
|
java.io.InputStream |
WGDocumentCore.getFileDerivateData(java.lang.String id)
Returns the data of a file derivate.
|
java.io.InputStream |
WGDocumentCoreWrapper.getFileDerivateData(java.lang.String id) |
WGFileDerivateMetaData |
WGDocument.getFileDerivateMetaData(java.lang.String id)
Returns the metadata of a file derivate
|
WGFileDerivateMetaData |
WGDocumentCore.getFileDerivateMetaData(java.lang.String id)
Returns the metadata of a file derivate.
|
WGFileDerivateMetaData |
WGDocumentCoreWrapper.getFileDerivateMetaData(java.lang.String id) |
java.util.List<WGFileDerivateMetaData> |
WGDocument.getFileDerivates(java.lang.String fileName)
Returns a list of all available derivates for the specified file
|
java.util.List<WGFileDerivateMetaData> |
WGDocumentCore.getFileDerivates(java.lang.String strFile)
Returns metadata about the created derivates for the given file.
|
java.util.List<WGFileDerivateMetaData> |
WGDocumentCoreWrapper.getFileDerivates(java.lang.String strFile) |
java.util.Date |
WGDocument.getFileLastModified(java.lang.String file)
Provides the best (most specific) information about the last modified date of an individual file attachment.
|
WGFileMetaData |
WGDocument.getFileMetaData(java.lang.String strFile)
Returns the meta data object for the given filename
|
WGFileMetaData |
WGDocumentCore.getFileMetaData(java.lang.String strFile)
retrieves meta informations for the given file
May throw an exception if method is used on a document that does not serve file metadata.
|
WGFileMetaData |
WGDocumentCoreWrapper.getFileMetaData(java.lang.String strFile) |
java.lang.String |
WGDocument.getFileMimeType(java.lang.String strFile)
Returns the (primary) mime-type for the file of the given name.
|
java.util.Collection<java.lang.String> |
WGDocument.getFileMimeTypes(java.lang.String strFile)
Returns all mime-types for the file of the given name.
|
java.util.List<java.lang.String> |
WGDocument.getFileNames()
Returns a list of file attachment names for this document
|
java.util.List<java.lang.String> |
WGDocumentCore.getFileNames()
Returns a list of the names of embedded files.
|
java.util.List |
WGDocumentCoreWrapper.getFileNames() |
int |
WGDocument.getFileSize(java.lang.String strFile)
Returns the size of an attachment in bytes.
|
int |
WGDocumentCore.getFileSize(java.lang.String strFile)
Returns the size of an embedded file in bytes.
|
int |
WGDocumentCoreWrapper.getFileSize(java.lang.String strFile) |
java.io.Reader |
WGDocument.getFileText(java.lang.String strFile)
Deprecated.
Use
WGDocument.getFileText(String) which allows specifying an encoding |
java.io.Reader |
WGDocument.getFileText(java.lang.String strFile,
java.lang.String encoding)
Returns the contents of a file attachment in text format.
|
WGContent |
WGDatabase.getFirstReleasedContent(java.lang.String language)
Returns the first released content of the given language to be found in
this database.
|
WGContent |
WGDatabase.getFirstReleasedContent(java.lang.String language,
boolean onlyRoots)
Returns the first released content document of this database in the
specified language.
|
WGContent |
WGDatabase.getFirstReleasedContent(WGLanguageChooser chooser,
boolean onlyRoots)
Returns the first released content document of this database.
|
int |
WGUserProfile.getHits()
Returns the registered "Hits" (i.e. page impressions) of the current user
|
java.util.List<WGRelationData> |
WGContent.getIncomingRelations()
Returns a list of relations that point the current document.
|
java.util.List<WGRelationData> |
WGContent.getIncomingRelations(boolean includeUnreleased)
Returns a list of relations that point the current document
|
java.util.List<WGRelationData> |
WGDatabaseCore.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.util.List<WGRelationData> |
WGContent.getIncomingRelations(java.lang.String contentClass,
java.lang.String relName)
Returns a list of relations that point the current document, having a given relation name and being owned by a released content of the given content class
|
java.util.List<WGRelationData> |
WGContent.getIncomingRelations(java.lang.String contentClass,
java.lang.String relName,
boolean includeUnreleased)
Returns a list of relations that point the current document, having a given relation name and being owned by a content of the given content class
|
java.util.List<WGRelationData> |
WGContent.getIncomingRelations(java.lang.String contentClass,
java.lang.String relName,
boolean includeUnreleased,
java.lang.String orderExpression)
Returns a list of relations that point the current document, having a given relation name and being owned by a content of the given content class
|
java.util.List<WGRelationData> |
WGContent.getIncomingRelationsOfGroup(java.lang.String contentClass,
java.lang.String relGroupName)
Returns a list of relations that point the current document, having a given relation group name and being owned by a released content of the given content class
|
java.util.List<WGRelationData> |
WGContent.getIncomingRelationsOfGroup(java.lang.String contentClass,
java.lang.String relGroupName,
boolean includeUnreleased)
Returns a list of relations that point the current document, having a given relation group name and being owned by a content of the given content class
|
java.util.List<WGRelationData> |
WGContent.getIncomingRelationsOfGroup(java.lang.String contentClass,
java.lang.String relGroupName,
boolean includeUnreleased,
java.lang.String orderExpression)
Returns a list of relations that point the current document, having a given relation group name and being owned by a content of the given content class
|
int |
WGStructEntryList.getIndexOfEntry(WGStructEntry testEntry)
Returns the siblings index of the given entry in the siblings list.
|
WGTMLModule |
WGStructEntry.getInnerLayout(java.lang.String mediaKey)
Returns the inner layout for this struct entry.
|
WGTMLModule |
WGContentType.getInnerLayout(java.lang.String mediaKey)
Returns the inner layout for this content type.
|
java.lang.String |
WGContentType.getInnerLayoutName()
Returns the name of WebTML modules used as inner layouts for this content type
|
static WGHierarchicalDatabase |
WGHierarchicalDatabase.getInstance(java.lang.String dbKey)
returns the requested hdb for the given dbKey, instance have to be create prior by using createInstance(...)
|
java.util.Date |
WGDocument.getItemDate(java.lang.String strName)
Retrieves the value of a date item.
|
java.util.List<java.lang.String> |
WGDocument.getItemNames()
Retrieves a list of the names of all content items on this document
|
java.util.List<java.lang.String> |
WGDocumentCore.getItemNames()
Returns the names of all items in this document
|
java.util.List<java.lang.String> |
WGContent.getItemNames() |
java.util.List |
WGDocumentCoreWrapper.getItemNames() |
abstract java.util.List<java.lang.String> |
WGPortletRegistry.getItemNames(WGPortlet portlet)
Returns the names of all portlet items for the given portlet
|
java.util.List<java.lang.String> |
WGTransientPortletRegistry.getItemNames(WGPortlet portlet) |
java.util.List<java.lang.String> |
WGPortletItemStorage.getItemNames(WGTransientPortlet portlet)
Returns all names of items stored for this portlet
|
java.lang.Number |
WGDocument.getItemNumber(java.lang.String strName)
Retrieves a number item.
|
java.lang.String |
WGDocument.getItemText(java.lang.String strName)
Returns a text item.
|
java.lang.Object |
WGDocument.getItemValue(java.lang.String strName)
Returns an item's value.
|
java.lang.Object |
WGDocumentCore.getItemValue(java.lang.String strName)
Returns the value of an content item.
|
java.lang.Object |
WGContent.getItemValue(java.lang.String strName) |
java.lang.Object |
WGDocumentCoreWrapper.getItemValue(java.lang.String strName) |
java.lang.Object |
PortletItemStorageData.getItemValue(java.lang.String itemName)
Returns the value of a stored item
|
abstract java.lang.Object |
WGPortletRegistry.getItemValue(WGPortlet portlet,
java.lang.String name)
Returns the value of a portlet item
|
java.lang.Object |
WGTransientPortletRegistry.getItemValue(WGPortlet portlet,
java.lang.String name) |
java.lang.Object |
WGPortletItemStorage.getItemValue(WGTransientPortlet portlet,
java.lang.String name)
Returns the value of a stored item for this portlet
|
java.util.List<?> |
WGDocument.getItemValueList(java.lang.String name)
Returns an items value(s) always as list.
|
java.lang.String |
WGHierarchicalDatabase.getKey(WGContent content)
returns a db wide unique key for the given content
|
java.util.List |
WGContent.getKeywords()
Returns a list of keywords for this content document to be used to identify this document in search machines.
|
WGLanguage |
WGContent.getLanguage()
Returns the language of this content document.
|
WGLanguage |
WGHierarchicalDatabase.getLanguage()
Returns the language that the HDB uses to create content
|
WGLanguage |
WGDatabase.getLanguage(java.lang.String name)
Returns the language of that name (code) if it exists.
|
WGLanguage |
WGDatabase.getLanguageForLocale(java.util.Locale locale)
Retrieves the best matching language definition for the given locale.
|
java.util.List |
WGUserProfile.getLanguages()
Returns the languages that the users browser is configured to accept
|
java.util.Map<java.lang.String,WGLanguage> |
WGDatabase.getLanguages()
Returns a map of WGLanguage objects, mapped by their language name (code)
|
WGContentList |
WGContentNavigator.getLanguagesContent(WGContent relContent,
boolean includeThisOne)
Returns all available languages for the the given content as content list.
|
java.util.Date |
WGUserProfile.getLastAccess()
Returns the last access date.
|
java.lang.String |
WGContent.getLastClient()
Returns the type of the last client that edited this content.
|
long |
WGSequence.getLastIncrementValue()
Returns the last value that was returned from this sequence on incrementation.
|
java.lang.String |
WGUserProfile.getLastIP()
Returns the IP address under which the last session was started
|
java.util.Date |
WGDocument.getLastModified()
Returns the last modification date of the document
|
java.util.Date |
WGDocumentCore.getLastModified()
Returns the date of the last modification of this document.
|
java.util.Date |
WGDocumentCoreWrapper.getLastModified() |
long |
WGDatabaseCoreFeatureSequenceProvider.getLastSequenceIncrementValue(java.lang.String name)
Returns the returned value of the sequence on the last
WGDatabaseCoreFeatureSequenceProvider.incrementSequence(String) call. 0 if it was not yet used. |
java.util.Date |
WGUserProfile.getLastSessionDate()
Returns the date when the last session was opened.
|
int |
WGUserProfile.getLastSessionHits()
Returns the hits in the last session.
|
java.lang.String |
WGUserProfile.getLastSessionID()
Returns the ID of the last session
|
de.innovationgate.utils.SkippingIterator<WGUpdateLog> |
WGDocument.getLastUpdates()
Returns update logs for the last updates done to this document, in descending chronological order
|
java.util.Iterator<WGUpdateLog> |
WGDocumentCore.getLastUpdates()
Returns update logs for the last updates done on this document, in descending chronological order
|
java.util.Iterator<WGUpdateLog> |
WGDocumentCoreWrapper.getLastUpdates() |
java.lang.Integer |
WGStructEntry.getLevel()
Returns the child level of this entry. 1 is root.
|
java.lang.String |
WGContent.getLinkTarget()
Returns the link target of this document, i.e. the name of the frame/browser window, in which this content is displayed
when it is clicked in a navigator.
|
java.util.Locale |
WGLanguage.getLocale()
Returns a java locale that matches the language code represented by this language definition
|
java.lang.String |
WGStructEntry.getLocalWorkflowName()
Returns the name of the workflow explicitly set for the current struct entry.
|
int |
WGDocument.getLockStatus()
returns the lock status for the current sessioncontext
|
int |
WGDatabase.getLockStatus()
gets the lockstatus for the current sessioncontext
|
int |
WGDocument.getLockStatus(LockOwner owner) |
int |
WGDatabase.getLockStatus(LockOwner owner) |
WGFileMetaData.ManualDerivate |
WGFileMetaData.getManualDerivate(java.lang.String name)
Retrieves a manual derivate defined for this file
|
java.util.List<java.lang.String> |
WGFileMetaData.getManualDerivateNames()
Returns the names of all manual derivates registered for this file
|
java.lang.String |
WGCSSJSModule.getMediaKey() |
java.lang.String |
WGTMLModule.getMediaKey()
Returns the media key of this module.
|
java.lang.String |
WGDesignDocument.getMediaKey()
The media key of this design document, if any.
|
java.lang.Object |
WGDocument.getMetaData(java.lang.String name)
Returns meta data about this document.
|
java.lang.Object |
WGDocumentCore.getMetaData(java.lang.String type)
Retrieves various meta data for the document core.
|
java.lang.Object |
WGDocumentCoreWrapper.getMetaData(java.lang.String type) |
java.util.List<?> |
WGDocument.getMetaDataList(java.lang.String name)
Returns meta data about this document.
|
WGScriptModule |
WGDatabase.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.String |
WGFileAnnotations.getMimeType()
Returns the mime type
|
java.lang.String |
WGUserProfile.getName()
Returns the profile name which also is used as web user name
|
java.lang.String |
WGCSSJSModule.getName()
Returns the name of this library
|
java.lang.String |
WGTMLModule.getName()
Returns the name of this TML module.
|
java.lang.String |
WGFileContainer.getName()
Retrieves the name of this file container
|
abstract java.lang.String |
WGDesignDocument.getName()
The name of the design document
|
java.lang.String |
WGLanguage.getName()
Returns the name of the language, i.e. the code
|
java.lang.String |
WGArea.getName()
Returns the name of this area.
|
java.lang.String |
WGContentType.getName()
Returns the name of this content type.
|
static java.lang.String |
WGDocument.getName(WGDocumentCore core)
Retrieves the name information for the given document core.
|
java.util.List |
WGContentType.getNameAliases()
Returns the name aliases for this content type in other languages.
|
java.lang.String |
WGContentType.getNameForLanguage(java.lang.String lang)
Returns a content type name for the specified language.
|
java.lang.Object |
WGDocument.getNativeObject()
Returns the native backend object of this document if there is one.
|
java.lang.Object |
WGDatabaseCore.getNativeObject()
Retrieves the native backend object for this database if there is any.
|
java.lang.Object |
WGDatabase.getNativeObject()
Returns the native backend object for this database if there is one.
|
java.lang.Object |
WGDocumentCore.getNativeObject()
Returns the native backend object of this doc core if there is any
|
java.lang.Object |
WGDocumentCoreWrapper.getNativeObject() |
WGContent |
WGContent.getNextContent()
Returns the next released content on the following struct entries in identical language
Starts with the immediately next struct entry and goes on with the one after that until
it finds a released content.
|
WGStructEntry |
WGStructEntry.getNextSibling()
Returns the next sibling by siblings index.
|
WGContent |
WGContentNavigator.getNextSibling(WGContent relContent)
Gets the next siblings content with the same language.
|
java.lang.String |
WGDatabase.DocumentCollectionHierarchy.getNodeKey() |
java.lang.String |
WGContent.getNodeKey() |
java.lang.String |
WGStructEntry.getNodeKey() |
java.lang.String |
WGCSSJSModule.getNodeKey() |
java.lang.String |
WGTMLModule.getNodeKey() |
java.lang.String |
PageHierarchyNode.getNodeKey()
Returns a string key for the node that is unique among all keys of PageHierarchyNodes in this database.
|
java.lang.String |
WGFileContainer.getNodeKey() |
java.lang.String |
WGLanguage.getNodeKey() |
java.lang.String |
WGArea.getNodeKey() |
java.lang.String |
WGContentType.getNodeKey() |
java.lang.String |
WGDatabase.getNodeTitle(java.lang.String language) |
java.lang.String |
WGDatabase.DocumentCollectionHierarchy.getNodeTitle(java.lang.String language) |
java.lang.String |
WGContent.getNodeTitle(java.lang.String language) |
java.lang.String |
WGStructEntry.getNodeTitle(java.lang.String language) |
java.lang.String |
WGCSSJSModule.getNodeTitle(java.lang.String language) |
java.lang.String |
WGTMLModule.getNodeTitle(java.lang.String language) |
java.lang.String |
PageHierarchyNode.getNodeTitle(java.lang.String language)
Returns the display title for the node.
|
java.lang.String |
WGFileContainer.getNodeTitle(java.lang.String language) |
java.lang.String |
WGLanguage.getNodeTitle(java.lang.String language) |
java.lang.String |
WGArea.getNodeTitle(java.lang.String language) |
java.lang.String |
WGContentType.getNodeTitle(java.lang.String language) |
static WGHierarchicalDatabase |
WGHierarchicalDatabase.getOrCreateInstance(WGDatabase db)
returns the requested hdb for the given db, instance is created if not existing using the default startup and listenerFactory implementations
|
abstract WGPortlet |
WGPortletRegistry.getOrCreateRootPortlet(java.lang.String appDb)
Returns the root portlet for the database of the given dbkey.
|
WGPortlet |
WGTransientPortletRegistry.getOrCreateRootPortlet(java.lang.String appDb) |
WGContent |
WGHierarchicalDatabase.getOrCreateStorage(java.lang.String id)
creates the storage with the given id if not exists
|
WGContent |
WGHierarchicalDatabase.getOrCreateStorage(java.lang.String id,
java.lang.Object parameter)
creates the storage with the given id if not exists
|
WGContent |
WGHierarchicalDatabase.getOrCreateStorage(WGContent parent,
java.lang.String id)
creates the storage with the given id as child of the given parent storage
|
WGContent |
WGHierarchicalDatabase.getOrCreateStorage(WGContent parent,
java.lang.String id,
java.lang.Object parameter)
creates the storage with the given id as child of the given parent storage
|
WGContent |
WGHierarchicalDatabase.getOrCreateUIDContent(WGContent parent,
java.lang.String id)
creates the content with the given uid as child of the given parent document, if not yet existent
|
WGContent |
WGHierarchicalDatabase.getOrCreateUIDContent(WGContent parent,
java.lang.String id,
java.lang.Object parameter)
creates the content with the given uid as child of the given parent document, if not yet existent
|
WGStructEntryList |
WGStructEntry.getOrderedChildEntries(int offset,
int size,
java.lang.String orderExpression)
Returns a partial list of the child entries of this struct entry, ordered by a special order expression
|
WGStructEntryList |
WGStructEntry.getOrderedChildEntries(java.lang.String orderExpression)
Returns a list of all child entries of this struct entry, ordered by a special order expression
|
WGStructEntryIterator |
WGStructEntry.getOrderedChildEntryIterator(int pageSize,
java.lang.String pageOrder)
Returns an iterator over the child entries of this struct entry, returned in a particular order
Internally the iterator fetches multiple entities at once from the backend for more performant backend retrieval processes.
|
WGStructEntryList |
WGArea.getOrderedRootEntries(int offset,
int size,
java.lang.String orderExpression)
Returns a partial list of the root entries of this area, ordered by a special order expression
|
WGStructEntryList |
WGArea.getOrderedRootEntries(java.lang.String orderExpression)
Returns a list of all root entries in this area, ordered by a special order expression
|
WGStructEntryIterator |
WGArea.getOrderedRootEntryIterator(int pageSize,
java.lang.String pageOrder)
Returns an iterator over the root entries of this area, returned in a particular order
Internally the iterator fetches multiple entities at once from the backend for more performant backend retrieval processes.
|
WGStructEntryIterator |
WGStructEntry.getOrderedSiblingEntryIterator(int pageSize,
java.lang.String orderExpression)
Gets an struct entry iterator for the sibling entries (including the current struct entry), ordered by a given order expression
|
WGTMLModule |
WGStructEntry.getOuterLayout(java.lang.String mediaKey)
Returns the outer layout for this struct entry.
|
WGTMLModule |
WGContentType.getOuterLayout(java.lang.String mediaKey)
Returns the outer layout for this content type.
|
java.lang.String |
WGContentType.getOuterLayoutName()
Returns the name of WebTML modules used as outer layouts for this content type
|
java.lang.String |
WGContent.getOwner()
Returns the name of the content owner.
|
java.util.List |
WGACL.getOwnersOfRole(WGACLEntry roleEntry)
Gets all the acl entries that are members of a specific role.
|
java.util.List<java.lang.String> |
WGStructEntry.getPageEditors()
Returns a list of names that are allowed to edit this struct document and
it's contents.
|
long |
WGStructEntry.getPageSequence() |
WGContent |
WGRelationData.getParentContent()
Returns the content which owns this relation
|
WGContent |
WGContent.getParentContent()
Returns the next released content of identical language up the struct hierarchy
This variant skips parents which have no released content in the right language and returns the first parent which has one.
|
WGContent |
WGContent.getParentContent(boolean skipUnreleasedParents)
Returns the next released content of identical language up the struct hierarchy
Depending on parameter skipUnreleasedParents it only tests the immediate parent or goes further up it that one has no released content in the right language.
|
WGContent |
WGContentNavigator.getParentContent(WGContent relContent)
Gets the parent content to the given content with the same language.
|
WGDocument |
WGFileMetaData.getParentDocument() |
WGDocument |
WGFileDerivateMetaData.getParentDocument() |
WGDocument |
WGFileAnnotations.getParentDocument()
Returns the parent document to which the file, described by these file annotations, belong
|
WGStructEntry |
WGStructEntry.getParentEntry()
Returns the parent entry, null if this is a root entry.
|
WGDocumentCore |
WGDatabaseCore.getParentEntry(WGStructEntry entry)
Retrieves the parent struct enty for the given entry.
|
WGStructEntry |
WGDatabase.getParentEntry(WGStructEntry entry)
Returns the parent entry to the given struct entry
|
abstract Lockable |
WGDocument.getParentLockable() |
Lockable |
WGContent.getParentLockable() |
Lockable |
WGStructEntry.getParentLockable() |
PageHierarchyNode |
WGDatabase.DocumentCollectionHierarchy.getParentNode() |
PageHierarchyNode |
WGContent.getParentNode() |
PageHierarchyNode |
WGStructEntry.getParentNode() |
PageHierarchyNode |
WGCSSJSModule.getParentNode() |
PageHierarchyNode |
WGTMLModule.getParentNode() |
PageHierarchyNode |
PageHierarchyNode.getParentNode()
Return the parent of this node in hierarchy.
|
PageHierarchyNode |
WGFileContainer.getParentNode() |
PageHierarchyNode |
WGLanguage.getParentNode() |
PageHierarchyNode |
WGArea.getParentNode() |
PageHierarchyNode |
WGContentType.getParentNode() |
java.lang.String |
WGUserProfile.getPassword()
If the personalisation mode is "custom", returns set password for this profile
|
java.util.List<java.lang.String> |
WGDocument.getPastAuthors()
Gets the names list for past authors of this document.
|
java.util.List<java.util.Date> |
WGDocument.getPastEditDates()
Gets the list of dates, when this document was edited in the past.
|
BinaryFieldData |
WGFileMetaData.getPlainText() |
BinaryFieldData |
WGFileDerivateMetaData.getPlainText() |
BinaryFieldData |
WGFileAnnotations.getPlainText()
returns a plain text representation of the file
|
abstract WGPortlet |
WGPortletRegistry.getPortlet(java.lang.String appDb,
java.lang.String key)
Returns the portlet for the given key.
|
WGPortlet |
WGTransientPortletRegistry.getPortlet(java.lang.String appDb,
java.lang.String key) |
abstract WGPortlet |
WGPortletRegistry.getPortletByName(java.lang.String appDb,
WGPortlet parentPortlet,
java.lang.String name)
Returns the portlet for the given name under the given parent portlet.
|
WGPortlet |
WGTransientPortletRegistry.getPortletByName(java.lang.String appDb,
WGPortlet parentPortlet,
java.lang.String name) |
WGPortletItemStorage |
WGUserProfile.getPortletItemStorage()
Returns the storage for persistent portlet items for transient portlets of this profile
|
WGPortletRegistry |
WGUserProfile.getPortletRegistry()
Returns the registry object for persistently stored portlets on this user profile
|
java.lang.Number |
WGStructEntry.getPosition()
Returns the position number.
|
java.lang.String |
WGContentType.getPositioning()
Returns in which positions content of this type is allowed.
|
java.util.List |
WGStructEntry.getPositionPath()
Returns a path of position numbers for all ancestors of the current struct entry
|
WGStructEntry |
WGContentType.getPreferredParent()
Returns the preferred parent for documents of this content type.
|
WGContent |
WGContent.getPreviousContent()
Returns the next released content on the previous struct entries of identical language
Starts with the immediately previous struct entry and goes on with the one before until
it finds a released content.
|
int |
WGUserProfile.getPreviousSessionHits()
Returns the hits in the last already closed session
|
java.lang.String |
WGUserProfile.getPreviousSessionID()
Returns the ID of the last already closed session
|
WGStructEntry |
WGStructEntry.getPreviousSibling()
Returns the previous sibling by siblings index
|
WGContent |
WGContentNavigator.getPreviousSibling(WGContent relContent)
Gets the previous siblings content with the same language.
|
java.lang.String |
WGDocument.getPrimaryFileName()
Returns the name of the primary attachment of this document
The primary attachment is a file attachment that is regarded the main attachment of this document (to be interpreted in a custom way).
|
int |
WGUserProfile.getProfileType()
Returns the profile type, which is the personalisation mode under which it was registered.
|
java.util.Date |
WGContent.getPublished()
Returns the time when this content version was published
|
java.util.Map<java.lang.String,java.util.Date> |
WGStructEntry.getPublished()
Returns the dates when this page was first published in its available languages
The returned map is keyed by language codes.
|
java.util.List<WGLanguage> |
WGLanguageChooser.getQueryLanguages(WGDatabase db)
Chooses languages to select in a query.
|
java.util.List |
WGContent.getReaders()
Returns the list of allowed readers of this content.
|
java.util.List<java.lang.String> |
WGStructEntry.getReaders()
Returns a list of allowed readers of contents on this struct entry.
|
java.util.List |
WGArea.getReaders()
Returns a list of allowed readers of contents in this area.
|
WGDocument |
WGStructEntry.getReadProtectionCause()
Tests if the current user may read contents on this page and below, and if so returns the document whose settings prohibit it.
|
WGDocumentCore |
WGDocumentCore.getRelation(java.lang.String name)
Retrieves the target content document of the given content relation
|
WGContent |
WGContent.getRelation(java.lang.String strName)
Retrieves the target content document of the given content relation
|
WGDocumentCore |
WGDocumentCoreWrapper.getRelation(java.lang.String name) |
WGRelationData |
WGDocumentCore.getRelationData(java.lang.String name)
Retrieves data for the given content relation.
|
WGRelationData |
WGContent.getRelationData(java.lang.String name)
Returns the data of a content relation
|
WGRelationData |
WGDocumentCoreWrapper.getRelationData(java.lang.String name) |
java.lang.String |
WGContent.getRelationGroupnameForTarget(java.lang.String group,
WGContent target)
Returns the target documents of all relations that belong to the given relation group
|
java.util.Set<java.lang.String> |
WGContent.getRelationGroups()
Returns the names of all existing relation groups on this content document
|
java.util.List<java.lang.String> |
WGDocumentCore.getRelationNames()
Returns the names of all relations that this content document holds
|
java.util.List<java.lang.String> |
WGContent.getRelationNames()
Returns the names of all relations that this content document holds
|
java.util.List<java.lang.String> |
WGDocumentCoreWrapper.getRelationNames() |
java.util.List<java.lang.String> |
WGContent.getRelationNamesOfGroup(java.lang.String group)
Returns the names of all relations that belong to the given relation group
|
java.util.List<java.lang.String> |
WGContent.getRelationNamesOfGroup(java.lang.String group,
java.lang.String orderExpression)
Returns the names of all relations that belong to the given relation group in a given order
|
java.util.List<java.lang.String> |
WGDocumentCore.getRelationNamesOfGroup(java.lang.String group,
WGColumnSet order)
Returns the names of all relations on this content document that
belong to the given relation group.
|
java.util.List<java.lang.String> |
WGDocumentCoreWrapper.getRelationNamesOfGroup(java.lang.String group,
WGColumnSet order) |
java.util.List<WGRelationData> |
WGContent.getRelationsDataOfGroup(java.lang.String group)
Returns the data of all relations that belong to the given relation group
|
java.util.List<WGRelationData> |
WGContent.getRelationsDataOfGroup(java.lang.String group,
java.lang.String order)
Returns the data of all relations that belong to the given relation group in a given order
|
java.util.List<WGContent> |
WGContent.getRelationsOfGroup(java.lang.String group)
Returns the target documents of all relations that belong to the given relation group
|
java.util.List<WGContent> |
WGContent.getRelationsOfGroup(java.lang.String group,
java.lang.String orderExpression)
Returns the target documents of all relations that belong to the given relation group in a given order
|
WGContent |
WGStructEntry.getReleasedContent(java.lang.String strLanguage)
Returns the released content of the given language
|
WGContent |
WGContentNavigator.getRelevantContent(WGStructEntry entry)
Returns the "relevant" content of a struct entry.
|
de.innovationgate.utils.SkippingIterator<WGContent> |
WGResultSet.getResultIterator()
Returns an iterator iterating over the results
|
de.innovationgate.utils.SkippingIterator<WGContent> |
WGStandardResultSet.getResultIterator() |
int |
WGContentNavigator.Iterator.getResults() |
int |
WGDocument.getRevision()
Returns the revision number of this document.
|
java.lang.Comparable |
WGDatabaseCore.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 |
WGDatabaseCore.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
WGDatabaseCore.getRevision() . |
java.util.Date |
WGDatabase.getRevisionDate(java.lang.Comparable lastModified)
Retrieve the datetime where a given database revision was done.
|
static WGDatabaseRevisionSerializer |
WGFactory.getRevisionSerializer(java.lang.Class<?> revClass)
Deprecated.
Since database revisions are always instances of
WGDatabaseRevision now having their own serialisation/deserialisation methods |
java.util.Map |
WGACL.getRoles()
Returns all roles in this ACL.
|
WGContent |
WGContent.getRootContent()
Retrieves the released content of identical language on the root entry of the current content's struct
|
WGContent |
WGContentNavigator.getRootContent(WGArea relArea)
Returns the first root content of an area in the given language.
|
WGContent |
WGContentNavigator.getRootContent(WGContent relContent)
Returns the root content for a given content in the same language
|
WGHierarchyContentIterator |
WGArea.getRootContentIterator(java.lang.String language,
int pageSize)
Returns an iterator over the root contents of area in a given language
Internally the iterator fetches multiple pages at once from the backend for more performant backend retrieval processes.
|
java.util.List |
WGHierarchicalDatabase.getRootDocuments()
Returns all root documents in this Database
|
WGStructEntryList |
WGArea.getRootEntries()
Returns a list of all root entries in this area.
|
WGStructEntryList |
WGArea.getRootEntries(int offset,
int size)
Returns a partial list of the root entries in this area.
|
java.util.Iterator<WGDocumentCore> |
WGDatabaseCore.getRootEntries(WGArea area,
WGPageOrderSet pageOrder)
Retrieves the root entries (i.e. entries without parents) of the given area.
|
WGStructEntry |
WGStructEntry.getRootEntry()
Returns the root entry of this entry
|
int |
WGArea.getRootEntryCount() |
int |
WGDatabaseCoreFeatureReturnHierarchyCount.getRootEntryCount(WGArea area)
Retrieves the root entries (i.e. entries without parents) of the given area.
|
WGStructEntryIterator |
WGArea.getRootEntryIterator(int pageSize)
Returns an iterator over the root entries of this area.
|
java.lang.String |
WGArea.getRootPageRestrictions()
Returns the restrictions regarding root pages on this area.
|
WGSchemaDocumentDefinition |
WGSchemaDocument.getSchemaDefinition()
Returns the schema definition for this document, if available.
|
WGCSSJSModule |
WGDatabase.getScriptModule(java.lang.String name)
Returns the script module of the given name and any codetype
|
WGScriptModule |
WGDatabase.getScriptModule(java.lang.String name,
java.lang.String codetype)
Returns the script module of the given name and codetype
|
java.util.List<WGScriptModule> |
WGDatabase.getScriptModules()
Returns the script modules in this database.
|
SearchDetails |
WGContent.getSearchDetails()
Returns detail information about the content depending on the last search
|
float |
WGContent.getSearchScore()
If the document was retrieved via query (and the db implementation supports this feature)
returns the search score of this document, i.e. a number representing how much this document matches
the search query.
|
WGSequence |
WGDatabase.getSequence(java.lang.String sequenceName)
Returns an WGAPI sequence object for the given sequence name.
|
java.lang.String |
WGDatabaseCore.getServerName()
Returns the name of the server for the backend database (if there is one)
|
java.lang.String |
WGDatabase.getServerName()
Returns the name of the database server (if there is one).
|
int |
WGUserProfile.getSessionCount()
Get the number of registered sessions for the current user.
|
WGContent |
WGContentNavigator.getSiblingContent(WGContent relContent,
int idx,
boolean relative)
Returns a sibling content of the given content that is at a certain index position in the siblings list and has the same language.
|
java.util.List<WGContent> |
WGContent.getSiblingContents()
Collects all released contents of identical language on sibling struct entries (including the current one)
|
WGStructEntryList |
WGStructEntry.getSiblingEntries()
Gets the sibling entries (including the current struct entry)
|
WGStructEntryIterator |
WGStructEntry.getSiblingEntryIterator(int pageSize)
Gets an struct entry iterator for the sibling entries (including the current struct entry)
|
int |
WGStructEntry.getSiblingIndex()
Returns the index of the current struct entry in the list of it's siblings
|
int |
WGContentNavigator.getSiblingsCount(WGContent relContent)
Returns the number of siblings (of the same language) of a content.
|
java.lang.Integer |
WGContentNavigator.getSiblingsIndex(WGContent relContent)
Returns the absolute index position of a given content among its siblings
|
long |
WGFileAnnotations.getSize()
Returns the size of the file in bytes
|
int |
WGContentNavigator.IteratorCreator.getSize() |
java.lang.String |
WGDesignResourceDocument.getSourceFileName()
Returns the exact-cased name of the file from which the source of this resource was read
|
java.lang.String |
WGContent.getStatus()
Returns the workflow status of this content document, which is one of the constants WGContent.STATUS_...
|
WGContent |
WGHierarchicalDatabase.getStorage(java.lang.String uid)
returns the storage with the given uid
|
java.util.List |
WGStructEntry.getStructEditors()
Deprecated.
|
WGStructEntry |
WGContent.getStructEntry()
Returns the struct entry, which this content document is attached to.
|
WGDocumentCore |
WGDatabaseCore.getStructEntryByKey(java.lang.Object key)
Retrieves a struct entry for the given struct key
|
WGStructEntry |
WGDatabase.getStructEntryByKey(java.lang.Object structKey)
Returns a struct entry by it's struct key
|
WGDocumentCore |
WGDatabaseCore.getStructEntryByName(java.lang.String strName)
Returns a struct entry by it's unique name
|
WGStructEntry |
WGDatabase.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 |
WGDatabase.getStructEntryBySequence(long seq)
Returns a struct entry by it's page sequence
|
WGDocumentCore |
WGDatabaseCoreFeaturePageSequences.getStructEntryBySequence(long seq) |
java.lang.Object |
WGContent.getStructKey()
Returns the struct key for this content document, which is the key of the struct entry this content document is attached to.
|
java.lang.String |
WGStructEntry.getStructKeyPath()
Returns a path consisting of the structkeys from root entry to this
entry, divided by slashes.
|
WGContent |
WGRelationData.getTargetContent()
Retrieves the current target content of this relation
|
java.lang.String |
WGContent.getTitle()
Returns the title of this content document.
|
java.lang.String |
WGStructEntry.getTitle()
Returns the title of the struct entry.
|
java.lang.String |
WGLanguage.getTitle()
Returns the title of the language, i.e. the human readable description
|
java.lang.String |
WGStructEntry.getTitlePath()
Returns a path consisting of the entry titles from root entry to this
entry, divided by slashes This information can be used as an easy
reference for the position of this entry in the area's hierarchy
|
WGTMLModule |
WGDatabase.getTMLModule(java.lang.String name,
java.lang.String mediaKey)
Returns the TML module for the given name and media key
|
java.util.List<WGTMLModule> |
WGDatabase.getTMLModules()
Returns the list of TML modules in this database.
|
java.lang.String |
WGContent.getUniqueName()
Returns the unique key of this document, which can be used instead of the content key in an URL.
|
java.lang.String |
WGStructEntry.getUniqueName()
Returns the unique name of this struct entry, null if there is none
|
java.util.List<WGUpdateLog> |
WGDatabase.getUpdatedDocumentsSince(java.lang.Comparable cutoff)
Retrieves logs of documents that were modified since a cutoff revision.
|
java.util.List<WGUpdateLog> |
WGDatabaseCore.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.
|
WGDatabaseRevision |
WGFileMetaData.getUpdateRevision()
Returns the revision when the contents of this file was updated the last time
|
java.lang.String |
WGFileMetaData.getUsage() |
java.lang.String |
WGFileDerivateMetaData.getUsage() |
java.lang.String |
WGFileAnnotations.getUsage()
Returns the usage of a file derivate, using constants #USAGE_...
|
java.util.List<java.lang.String> |
WGDatabase.getUsedSequenceNames()
Returns the names of sequences that are initialized and/or in use
|
java.util.List<java.lang.String> |
WGDatabaseCoreFeatureSequenceProvider.getUsedSequenceNames()
Returns names of sequences already initialized and/or in use
|
WGUserDetails |
WGSessionContext.getUserDetails()
Returns details about the current user if the DB implementation supports this, otherwise null.
|
WGDocumentCore |
WGPersonalisationDatabaseCore.getUserProfile(java.lang.String name)
Retrieves a user profile for the given name
|
WGUserProfile |
WGDatabase.getUserProfile(java.lang.String name)
Retrieves a user profile for the given profile name.
|
java.util.Map |
WGACL.getUsers()
Returns all user/group entries of this ACL.
|
java.util.Date |
WGContent.getValidFrom()
Returns the Date, since when this document is valid (i.e. is shown in the website) or null if no such Date is specified.
|
java.util.Date |
WGContent.getValidTo()
Returns the Date, until when this document is valid (i.e. is shown in the website) or null if no such Date is specified.
|
int |
WGContent.getVersion()
Returns the version number of this content document.
|
java.lang.String |
WGContent.getVirtualLink()
Returns a link url, that is called instead of an URL to this content, when it is clicked in a navigator.
|
java.lang.String |
WGContent.getVirtualLinkType()
Returns the type of this virtual link, which is one of the constants WGContent.VIRTUALLINKTYPE_...
|
WGWorkflow |
WGContent.getWorkflow()
Retrieves the workflow object for the current content document, if it is available
|
java.lang.String |
WGContentType.getWorkflow()
Retrieves the name of the workflow for this content type.
|
WGWorkflowEngine |
WGDatabase.getWorkflowEngine()
Gets the workflow engine object for this database.
|
java.util.List<java.lang.String> |
WGContent.getWorkflowHistory()
Returns a list of history entries, describing the events that occured to this document in authoring workflow
|
java.lang.String |
WGStructEntry.getWorkflowName()
Returns the name of the workflow that is effective on this struct entry.
|
int |
WGContent.getWorkflowRole()
Returns the role of the current user in the content's current workflow state.
|
boolean |
WGStructEntry.hasChildren()
Determines if this entry has child entries
|
boolean |
WGContent.hasCompleteRelationships()
Indicates if this content has "complete relationships", meaning it is no dummy, it has an associated language definition, a struct entry, and via this entry a content type
|
boolean |
WGStructEntry.hasContent(java.lang.String strLanguage,
java.lang.String strStatus)
Tests if struct entry has content in given language code / status, even if the user doesn't have the authorisation to read it.
|
boolean |
WGContentNavigator.hasContentChildren(WGContent relContent)
Returns, if the given context has released child contexts in the same language.
|
boolean |
WGDatabase.hasContents(WGStructEntry entry)
Returns if the given struct entry contains a content document.
|
boolean |
WGDocument.hasFile(java.lang.String name)
Tests if a file of this name is attached to the document.
|
boolean |
WGDocumentCore.hasFile(java.lang.String file)
Tests if a file of the given name is attached to the document
|
boolean |
WGDocumentCoreWrapper.hasFile(java.lang.String file) |
boolean |
WGDocument.hasFileMetadata()
Determines if this document serves metadata for file attachments
|
boolean |
WGDocumentCore.hasFileMetadata()
Determines if this document serves metadata for file attachments
|
boolean |
WGDocumentCoreWrapper.hasFileMetadata() |
boolean |
WGDocument.hasItem(java.lang.String itemName)
Tests if the document has an item of this name
|
boolean |
WGDocumentCore.hasItem(java.lang.String strName)
Tests, if the content contains an item of the given name.
|
boolean |
WGContent.hasItem(java.lang.String itemName) |
boolean |
WGDocumentCoreWrapper.hasItem(java.lang.String strName) |
abstract boolean |
WGPortletRegistry.hasItem(WGPortlet portlet,
java.lang.String name)
Tests if the given portlet has a portlet item of the given name
|
boolean |
WGTransientPortletRegistry.hasItem(WGPortlet portlet,
java.lang.String name) |
boolean |
WGPortletItemStorage.hasItem(WGTransientPortlet portlet,
java.lang.String name)
Returns if an item of the given name is stored for this portlet
|
boolean |
WGStructEntry.hasReleasedContent(java.lang.String strLanguage)
Tests if this entry has an released content for the given language.
|
long |
WGSequence.increment()
Increments the sequence and returns a new unique number
|
long |
WGDatabaseCoreFeatureSequenceProvider.incrementSequence(java.lang.String name)
Increments the sequence and returns a new unique value.
|
boolean |
WGSequence.initialize(long startValue)
Initialize a sequence with the given start value if it is not already initialized.
|
boolean |
WGSequence.initialize(long startValue,
boolean forceInit)
Initialize a sequence with the given start value if it is not already initialized or argument forceInit is true.
|
void |
WGStructEntry.initializePagePublished(WGStructEntry source)
Initializes empty published fields on page level by the first released content versions' creation date
This is a tool method that can be used to init given published field from non CS5 sources, on migration for example.
|
boolean |
WGDatabaseCoreFeatureSequenceProvider.initSequence(java.lang.String name,
long startValue,
boolean forceInit)
Initializes a sequence, if it either is not yet initialized or argument forceInit is true.
|
boolean |
WGDocument.innerAttachFile(java.io.File file) |
abstract void |
WGPortletRegistry.insertPortlet(WGPortlet portlet)
Inserts a new portlet to the registry
|
void |
WGTransientPortletRegistry.insertPortlet(WGPortlet portlet) |
boolean |
WGStructEntry.isActive()
Determines if this page is already "active", i.e. it contains contents that are no more in draft state or child pages
|
boolean |
WGSessionContext.isActiveCore(WGDocumentCore core)
Checks ift the given document core is attached to the current session
|
boolean |
WGDatabase.isAnonymousAccessible()
Returns if the database can be accessed by anonymous users
|
boolean |
WGContentType.isAuthoring()
Returns if this content type is available for authoring purposes
|
boolean |
WGContent.isAuthorOrOwner()
Determines if the current user is an author of this document
|
boolean |
WGContent.isAutoApprovable(WGWorkflow workflow)
Determine if the current user will auto-approve the content in the current state with the given workflow
Auto-approve should only happen when enabled, the user is a regular approver of the current workflow level (NOT just admin approver!)
|
boolean |
WGDatabase.isBackendServiceSupported(java.lang.String serviceName)
Returns if a backend service is supported
|
boolean |
WGTMLModule.isCacheable()
Returns if this TML modules results should be browser-cacheable
|
boolean |
WGDatabase.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 |
WGDatabaseCore.isContentTypeUsed(WGContentType ct)
Tests if the given content type is still in usage, i.e. if there are struct entries referencing it
|
boolean |
WGDatabase.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 |
WGDocument.isDeleted()
Returns if this document has been deleted
This method may choose to only check cached deletion flags for performance reasons.
|
boolean |
WGDocumentCore.isDeleted()
Tests, if this document is marked as deleted.
|
boolean |
WGDocumentCoreWrapper.isDeleted() |
boolean |
WGDocument.isDeleted(boolean forceBackendCheck)
Returns if this document has been deleted
|
boolean |
WGStructEntry.isDescendantOf(WGDocument doc)
Determines if this struct entry is a descendant of the given document, i.e.
|
boolean |
WGDatabase.isDesignEmpty()
Returns if this database has no design documents (file containers, script
modules, WebTML modules) and can be regarded "design-empty".
|
boolean |
WGStructEntry.isDifferentParent(WGStructEntry clone)
Tests if this struct entry has a different parent than the given clone.
|
boolean |
WGTMLModule.isDirectAccessAllowed()
Returns if this module should be directly accessible via URL
|
boolean |
WGDatabase.isEmpty()
Determines if this database is completely empty of (content store)
documents.
|
java.util.List |
WGContent.isHiddenFrom()
Returns a list of the navigation elements, where this content document should not be shown.
|
boolean |
WGSequence.isInitialized()
Returns if the sequence is already initialized, either by calling
WGSequence.initialize(long) and/or by calling WGSequence.increment() . |
boolean |
WGDatabaseCore.isLanguageUsed(WGLanguage lang)
Tests if the given language is still in usage, i.e. if there are contents referencing it
|
boolean |
WGDatabaseCore.isMemberOfUserList(java.util.List userList)
Determines if the currently logged in user is a member of the given user/group/role list.
|
boolean |
WGDatabase.isMemberOfUserList(java.util.List list)
Tests, if the current user can be associated with any entry in the list.
|
boolean |
WGCSSJSModule.isMetadataModule()
Determines if the module is a metadata module
|
boolean |
WGSchemaDocument.isMetaDeterminedInSchema(java.lang.String name)
Returns if the data of the given metadata field is served from schema definition rather than from the database document
|
boolean |
WGContent.isPendingRelease()
Returns if this document is pending for release, meaning it has passed the workflow and is waiting for an external process to publish it
|
boolean |
WGTMLModule.isPreprocess() |
boolean |
WGContent.isPublic()
Tests if this content is publicly accessible, i.e. anyone can read its data
|
boolean |
WGStructEntry.isPublic()
Tests if this page branch is publicly accessible, i.e. anyone can generally read its content
|
boolean |
WGArea.isPublic()
Tests if this area is publicly accessible, i.e. anyone can generally read its content
|
boolean |
WGStructEntry.isRoot()
Determines if this entry is a root entry
|
boolean |
WGDocument.isSaved()
Returns if the document has been saved to the database.
|
boolean |
WGDocumentCore.isSaved()
Should return if the document has been saved.
|
boolean |
WGDocumentCoreWrapper.isSaved() |
boolean |
WGDatabaseCoreFeatureSequenceProvider.isSequenceInitialized(java.lang.String name)
Returns if a sequence of that name is already initialized.
|
boolean |
WGHierarchicalDatabase.isStorage(WGContent content)
Determines if the given content document is a HDB storage
|
boolean |
WGArea.isSystemArea()
Returns if this area is marked as being a system area, which contains no publishable content
|
boolean |
WGDocumentCore.isTemporary()
Should return true, if this document core cannot be re-retrieved by it's individual key.
|
boolean |
WGDocumentCoreWrapper.isTemporary() |
abstract boolean |
WGPortletRegistry.isTransient()
Returns if the registry is transient, and it is not to expect that a new request will reproduce once registered portlets
|
boolean |
WGTransientPortletRegistry.isTransient() |
boolean |
WGDesignDocument.isVariant()
Identifies this design document as a variant, i.e. a design from a design provider that may return different data for different databases.
|
boolean |
WGContent.isVirtual()
Determines, if this document is a "virtual document", i.e. if another link is shown instead of a link to this content in navigators.
|
boolean |
WGContent.isVisible()
Returns the general visibility setting of this document.
|
boolean |
WGContent.isVisibleFor(java.lang.String displayType)
Makes a complete test about the visibility of the content in publishing:
- Is the general visibility flag set?
|
boolean |
WGContent.isVisibleNow()
Tests the general visibility of this content (see WGContent.isVisible()), and if the current settings for the "Valid from" and "Valid to" date
allow it to the visible right now.
|
void |
WGDocument.lock()
locks the document for the current sessionContext
|
void |
WGDatabase.lock()
locks the database for the current sessioncontext
|
void |
WGDocument.lock(LockOwner owner) |
void |
WGDatabase.lock(LockOwner owner) |
void |
WGDocumentCore.markFileMetaDataModified(WGFileMetaData md)
Marks a file metadata object as being modified, so the core knows that it must be saved
|
void |
WGDocumentCoreWrapper.markFileMetaDataModified(WGFileMetaData md) |
void |
WGDocument.markMetaDataModified(WGFileMetaData md) |
void |
WGDocument.FakeMetaDataContext.markMetaDataModified(WGFileMetaData md) |
void |
WGFileMetaDataContext.markMetaDataModified(WGFileMetaData md)
Informs the parent resource that the file metadata object is modified, so it is saveable
|
boolean |
WGContent.mayBePublished(boolean isAuthoringMode,
java.lang.String displayType)
A executed the static method "mayBePublished" on this content.
|
static boolean |
WGContent.mayBePublished(WGContent content,
boolean isAuthoringMode,
java.lang.String displayType)
Determines, if a content may be published (visible to a user) right now, testing all necessary conditions.
|
boolean |
WGContentType.mayCreateChildEntry(WGDocument parent)
Tests, if the user is allowed to create struct entries in this content
type for the given parent, according to this content type.
|
boolean |
WGLanguage.mayCreateContent()
Tests if the current user is allowed to create content in this language
- asks pageRightsFilter
- checks struct edit rights (hierarchicaly)
|
boolean |
WGContentType.mayCreateContent()
Tests if the current user may create contents for this content type.
|
boolean |
WGStructEntry.mayCreateContent(WGLanguage lang)
Test if user may create content in a given language
|
boolean |
WGLanguage.mayCreateContent(WGStructEntry page) |
boolean |
WGArea.mayEditAreaChildren()
Deprecated.
|
boolean |
WGStructEntry.mayEditChildPages()
Tests if the current user generally may edit child pages of this page, according to the hierarchical access rights.
|
WGDocument |
WGStructEntry.mayEditChildren()
Deprecated.
Because of counter-intuitive return values. Use
WGStructEntry.mayEditChildPages() |
boolean |
WGContent.mayEditContent()
Tests if the current user is allowed to edit (i.e. create or save DRAFT) the current document
|
WGDocument |
WGStructEntry.mayEditEntryAndContent()
Deprecated.
Because of counter-intuitive return values. Use
WGStructEntry.performChildCreationCheck() or WGStructEntry.mayEditChildPages() |
boolean |
WGArea.mayEditPages()
Tests if the current user is generally allowed to edit documents in this area, according to area access rights
|
boolean |
WGStructEntry.mayReadContent()
Tests if the current user may read contents on this page and below
|
boolean |
WGArea.mayReadContent()
Tests if the current user may read contents in this area
|
boolean |
WGDocument.mayRemove()
Tests if the current user is allowed to remove the current document
For getting more details about failure reasons for remove checks see
WGDocument.performRemoveCheck(boolean) |
boolean |
WGDocument.mayRemove(boolean deepCheck)
Tests if the current user is allowed to remove the current document
For getting more details about failure reasons for remove checks see
WGDocument.performRemoveCheck(boolean) |
boolean |
WGDocument.maySave()
Tests if the current user is allowed to save the current document
For getting more details about failure reasons for save checks see
WGDocument.performSaveCheck() |
boolean |
WGStructEntry.maySave() |
void |
WGHierarchicalDatabase.moveContent(WGContent content,
WGContent newParent)
moves the given content under the given parent content
pre- and post-move events are first fired on the old hierarchy and then on the new hierarchy
if target parent is null the content will be moved to the db root
|
void |
WGHierarchicalDatabase.moveContent(WGContent content,
WGContent newParent,
java.lang.Object parameter)
moves the given content under the given parent content
pre- and post-move events are first fired on the old hierarchy and then on the new hierarchy
if target parent is null the content will be moved to the db root
|
boolean |
WGDatabaseCore.moveStructEntry(WGStructEntry entry,
WGDocument newParent)
Moves a struct entry to a new parent document, either another struct entry of an area.
|
boolean |
WGDatabase.moveStructEntry(WGStructEntry entry,
WGDocument newParent)
Moves a struct entry to a new position.
|
WGUserAccess |
WGDatabaseCore.open(WGDatabase db,
java.lang.String path,
java.lang.String user,
java.lang.String pwd,
boolean prepareOnly)
Opens a database initially.
|
int |
WGDatabase.openAnonymousSession()
Opens a session as anonymous user
|
int |
WGDatabase.openAnonymousSession(java.lang.String accessFilter)
Opens a session as anonymous user, including an access filter
|
WGDatabase |
WGFactory.openDatabase(WGDatabaseServer server,
java.lang.String strType,
java.lang.String strPath,
java.lang.String strUserName,
java.lang.String strUserPwd,
java.util.Map<java.lang.String,java.lang.String> options)
Opens a WGA database initially, ready for work.
|
WGDatabase |
WGFactory.openDatabase(WGDatabaseServer server,
java.lang.String strType,
java.lang.String strPath,
java.lang.String strUserName,
java.lang.String strUserPwd,
java.util.Map<java.lang.String,java.lang.String> options,
boolean prepareOnly)
Opens a WGA database initially.
|
int |
WGDatabase.openSession()
Opens a new session with master login.
|
WGUserAccess |
WGDatabaseCore.openSession(AuthenticationSession authSession,
java.lang.Object credentials,
boolean master)
Opens a session for the given user/thread.
|
int |
WGDatabase.openSession(java.lang.String user,
java.lang.Object credentials)
Opens a new session.
|
int |
WGDatabase.openSession(java.lang.String user,
java.lang.Object credentials,
java.lang.String filter) |
int |
WGDatabase.openSession(java.lang.String user,
java.lang.Object credentials,
java.lang.String filter,
javax.servlet.http.HttpServletRequest request)
Opens a new session.
|
int |
WGDatabase.openSession(java.security.cert.X509Certificate cert,
java.lang.String filter)
Opens a new session using a certificate for login.
|
void |
WGFactory.openSessions()
Opens sessions on all not yet opened databases with master session information.
|
void |
WGFactory.openSessions(java.lang.String user,
java.lang.String password)
Opens sessions on all not yet opened databases with a given login.
|
static WGPageOrderSet |
WGPageOrderSet.parse(java.lang.String pageOrderExpression)
Parse an order expression into a set
|
static WGContentKey |
WGContentKey.parse(java.lang.String key,
WGDatabase db)
Parses a content key string and returns the according unique content key object.
|
static WGContentKey |
WGContentKey.parse(java.lang.String key,
WGDatabase db,
boolean unique)
Parses a content key string and returns the according content key object.
|
java.lang.Object |
WGDatabaseCore.parseStructKey(java.lang.String key)
Parses the string representation of a struct key (as used in URLs) to the implementation specific format.
|
java.lang.Object |
WGDatabase.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 |
WGStructEntry.performChildCreationCheck()
Performs a check if the current user generally create child pages of this page, according to the hierarchical access rights.
|
void |
WGStructEntry.performChildCreationCheck(WGContentType ct)
Checks if the current user may create a new child struct entry of the given content type.
|
void |
WGStructEntry.performChildPageCreationCheck(WGContentType ct,
WGLanguage lang)
Checks if the current user may create a new child page with the given data.
|
void |
WGDatabase.performContentCreationCheck(WGStructEntry entry,
WGLanguage language)
Controls if the current user may create a content document with the given data.
|
void |
WGDatabase.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 |
WGContent.performEditCheck()
Tests if the current user is allowed to edit (i.e. create or save DRAFT) the current document
|
void |
WGStructEntry.performEditPageCheck()
Tests if the current user generally may edit this struct entry and it's contents, according to the hierarchical access rights.
|
void |
WGStructEntry.performReadProtectionCheck() |
void |
WGDocument.performRemoveCheck()
Performs a validation for removing the document at the current state, just like it actually was removed.
|
void |
WGDocument.performRemoveCheck(boolean deepCheck)
Performs a validation for removing the document at the current state, just like it actually was removed.
|
void |
WGArea.performRemoveCheck(boolean deepCheck,
WGDocument deletionRoot) |
void |
WGArea.performRootCreationCheck(WGContentType ct)
Checks if the current user may create a new root struct entry of the given content type.
|
void |
WGArea.performRootPageCreationCheck(WGContentType ct,
WGLanguage lang)
Checks if the current user may create a new root page with the given data.
|
void |
WGDocument.performSaveCheck()
Performs a validation for saving the document at the current state, just like it actually was saved.
|
void |
WGSchemaDocument.performSaveCheck() |
void |
WGContent.performSaveCheck() |
void |
WGStructEntry.performSaveCheck() |
void |
WGCSSJSModule.performSaveCheck() |
void |
WGTMLModule.performSaveCheck() |
void |
WGDesignResourceDocument.performSaveCheck() |
void |
WGFileContainer.performSaveCheck() |
void |
WGLanguage.performSaveCheck() |
void |
WGArea.performSaveCheck() |
void |
WGContentType.performSaveCheck() |
void |
WGDatabase.performStructCreationCheck(java.lang.Object key,
WGDocument parent,
WGContentType contentType)
Controls if the current user may create a struct entry with the given data.
|
void |
WGDatabase.performStructMoveCheck(WGStructEntry entry,
WGDocument newParent)
Controls if the current user may move a struct entry to the given new parent.
|
void |
WGStructEntry.performSubtreeModificationCheck()
Tests if the current user may modify each document of the current pages subtree.
|
WGDatabase |
WGFactory.prepareDatabase(WGDatabaseServer server,
java.lang.String strType,
java.lang.String strPath,
java.lang.String strUserName,
java.lang.String strUserPwd,
java.util.Map<java.lang.String,java.lang.String> options)
Opens a WGA database initially, but only prepares it for work.
|
void |
WGPortletItemStorage.prepareNewProfile(WGUserProfile profile)
Callback after a new user profile is created
|
abstract void |
WGPortletRegistry.prepareNewProfile(WGUserProfile profile)
Takes a newly created user profile to do some eventually neccessary initialisations on it
This is called on each new user profile so the registry has a chance to initialise it if neccessary.
|
void |
WGTransientPortletRegistry.prepareNewProfile(WGUserProfile profile) |
void |
WGPortletItemStorage.preSaveProfile(WGUserProfile profile)
Callback before the user profile is saved
|
abstract void |
WGPortletRegistry.preSaveProfile(WGUserProfile profile)
Called immediately before a user profile is saved, so that the portlet registry may do some work necessary before saving
|
void |
WGTransientPortletRegistry.preSaveProfile(WGUserProfile profile) |
void |
WGContent.publish()
For a content document in status DRAFT, set it to status REVIEW and let it enter publishing workflow.
|
void |
WGContent.publish(java.lang.String comment)
For a content document in status DRAFT, set it to status REVIEW and let it enter publishing workflow.
|
void |
WGContent.publish(java.lang.String comment,
java.lang.String reasonForReplacement)
For a content document in status DRAFT, set it to status REVIEW and let it enter publishing workflow.
|
void |
WGDocument.pushData(WGDocument doc)
Pushed the data of this document to another document of the same type.
|
void |
WGUserProfile.pushData(WGDocument doc) |
void |
WGContent.pushData(WGDocument newDoc) |
void |
WGStructEntry.pushData(WGDocument doc) |
void |
WGCSSJSModule.pushData(WGDocument doc) |
void |
WGTMLModule.pushData(WGDocument doc) |
void |
WGFileContainer.pushData(WGDocument doc) |
void |
WGLanguage.pushData(WGDocument doc) |
void |
WGArea.pushData(WGDocument doc) |
void |
WGContentType.pushData(WGDocument doc) |
void |
WGFileMetaData.pushData(WGFileMetaData clone)
Pushes all data from this file metadata object to the parameter object
|
void |
WGPortletItemStorage.pushData(WGPortletItemStorage targetStorage)
Pushes all persistent item storage data from all portlets to the given target storage
|
WGResultSetCore |
WGDatabaseCore.query(java.lang.String type,
java.lang.String query,
java.util.Map parameters)
Queries the database for content.
|
WGAbstractResultSet |
WGDatabase.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 |
WGDatabase.queryUserProfileNames(java.lang.String query)
Queries a user profile database for stored profiles, based on their data.
|
java.util.List<java.lang.String> |
WGPersonalisationDatabaseCore.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.
|
java.util.List |
WGDatabase.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 |
WGContent.reassignVersionNumber()
Assigns a new version number to this content
Used to resolve key conflicts with contents.
|
void |
WGPortletItemStorage.receiveData(PortletItemStorageData p)
Receives the item storage data for a single portlet and stores it to its own storage
|
void |
WGDatabase.ReconfigurationAccessor.reconfigureCore(boolean prepareOnly,
WGUserAccess userAccess) |
void |
WGDatabaseCore.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 |
WGDatabase.refresh()
Refreshes the data in database, testing for changes in the backend and
clearing all caches.
|
void |
WGContent.reject(java.lang.String comment)
Method reject.
|
void |
WGContent.releaseImmediately(java.lang.String comment)
Releases this document immediately while exiting workflow.
|
void |
WGDatabase.releasePendingContents()
Fetches all content documents pending release and releases those that are ready to be released
|
boolean |
WGDocument.remove()
Remove the current document permanently from the database.
|
WGDatabaseRevision |
WGDocumentCore.remove()
Removes this document from the database
|
void |
WGSequence.remove()
Removes the sequence, deleting all initialisation and incrementation status
|
WGDatabaseRevision |
WGDocumentCoreWrapper.remove() |
void |
WGACL.remove(WGACLEntry entry)
Removes the given ACL entry from the ACL.
|
void |
WGACLCore.remove(WGACLEntry entry)
Removes an ACL entry
|
void |
WGDocument.removeAllExtensionData()
Convenience method to remove all extension data fields from the document at once
|
void |
WGDocument.removeAllFiles()
Convenience method to remove all file attachments from the document at once
|
void |
WGContent.removeAllIncomingRelations()
Removes all incoming relations to this content from parents/sources
|
void |
WGDocument.removeAllItems()
Convenience method to remove all items from the document at once
|
void |
WGContent.removeAllRelations()
Removes all relations from this content
|
void |
WGFileMetaData.removeCustomField(java.lang.String fieldName) |
void |
WGFileDerivateMetaData.removeCustomField(java.lang.String fieldName) |
void |
WGFileAnnotations.removeCustomField(java.lang.String fieldName)
Removes a custom field annotated for this file
|
void |
WGDocument.removeExtensionData(java.lang.String strName) |
void |
WGFileMetaData.removeExtensionData(java.lang.String strName) |
void |
WGDatabaseCore.removeExtensionData(java.lang.String name)
Removes an extension data field from this database
|
void |
WGDatabase.removeExtensionData(java.lang.String name)
Removes a extension data field from the database.
|
void |
WGExtensionDataContainer.removeExtensionData(java.lang.String strName)
Removes an extension data field from this entity
|
void |
WGDocumentCoreWrapper.removeExtensionData(java.lang.String strName) |
boolean |
WGDocument.removeFile(java.lang.String name)
Removes a file attachment from the document
Note: When this method is called you should save the document before attempting to attach a
new file of the same name.
|
boolean |
WGDocumentCore.removeFile(java.lang.String name)
Removes a file attachment from this document
|
boolean |
WGFileContainer.removeFile(java.lang.String name) |
boolean |
WGDocumentCoreWrapper.removeFile(java.lang.String name) |
void |
WGDocument.removeFileDerivate(java.lang.String id)
Deletes an existing file derivate
|
void |
WGDocumentCore.removeFileDerivate(java.lang.String id)
Deletes an existing file derivate
|
void |
WGDocumentCoreWrapper.removeFileDerivate(java.lang.String id) |
void |
WGDocument.removeItem(java.lang.String name)
Removes an item from the document
|
boolean |
WGDocumentCore.removeItem(java.lang.String Name)
Removes an item from the document
|
boolean |
WGDocumentCoreWrapper.removeItem(java.lang.String Name) |
abstract void |
WGPortletRegistry.removeItem(WGPortlet portlet,
java.lang.String name)
Removes a portlet item
|
void |
WGTransientPortletRegistry.removeItem(WGPortlet portlet,
java.lang.String name) |
void |
WGPortletItemStorage.removeItem(WGTransientPortlet portlet,
java.lang.String name)
Removes a stored item from this portlet
|
void |
WGHierarchicalDatabase.removeListener(WGContent content)
removes the stored listener reference from the given storage or content
|
void |
WGFileMetaData.removeManualDerivate(java.lang.String name)
Removes a manual derivate
|
abstract void |
WGPortletRegistry.removePortlet(WGPortlet portlet)
Removes the portlet of the given key from registry
This method should:
Remove all items registered for this portlet
Remove the registration of the portlet from portlet registry
Remove all child portlets the same way that this portlet was removed (including items and their child portlets)
|
void |
WGTransientPortletRegistry.removePortlet(WGPortlet portlet) |
WGDocumentCore |
WGDocumentCore.removeRelation(java.lang.String name)
Removes a content relation
|
WGContent |
WGContent.removeRelation(java.lang.String name)
Removes a content relation
|
WGDocumentCore |
WGDocumentCoreWrapper.removeRelation(java.lang.String name) |
boolean |
WGContent.removeRelationFromGroup(java.lang.String group,
WGContent target)
Removes the relation to a given target document from a relation group, if it contains such a relation.
|
void |
WGDesignDocument.rename(java.lang.String name)
Tries to rename the design document.
|
void |
WGDesignDocument.rename(java.lang.String name,
java.lang.String mediaKey)
Tries to rename the design document.
|
void |
WGDocument.renameFile(java.lang.String oldFileName,
java.lang.String newFileName)
Renames a file exception on this document
|
void |
WGDocumentCore.renameFile(java.lang.String oldFileName,
java.lang.String newFileName)
Renames an attached file
|
void |
WGDocumentCoreWrapper.renameFile(java.lang.String oldFileName,
java.lang.String newFileName) |
int |
WGDatabase.reopenSession()
Closes and reopens the session with the current logged in user.
|
int |
WGDatabase.reopenSession(java.lang.String username,
java.lang.Object credentials)
Closes and reopens the session with the given user information
|
int |
WGDatabase.reopenSession(java.lang.String username,
java.lang.Object credentials,
java.lang.String filter)
Closes and reopens the session with the given user information
|
WGDocumentCore |
WGContent.retrieveCore() |
WGDocumentCore |
WGDesignDocument.retrieveCore() |
WGExtensionDataContainer |
WGDocumentCore.retrieveFileExtensionDataHandler(java.lang.String strFile)
retrieves the extension data handler for the given file or null if extension data is not supported
|
WGExtensionDataContainer |
WGDocumentCoreWrapper.retrieveFileExtensionDataHandler(java.lang.String strFile) |
java.io.InputStream |
BinaryFieldData.Retriever.retrieveInputStream() |
boolean |
WGDatabaseCore.rollbackTransaction()
Called when a started transaction should be rolled back.
|
boolean |
WGDatabase.rollbackTransaction()
Deprecated.
|
boolean |
WGDocument.save()
Saved the current state of the document.
|
boolean |
WGDocument.save(java.util.Date lastModified)
Saves the current document with it's modifications.
|
WGDatabaseRevision |
WGDocumentCore.save(java.util.Date lastModified)
Called to save modifications to this document core.
|
boolean |
WGContent.save(java.util.Date lastModified)
Saves changes made to this document.
|
boolean |
WGStructEntry.save(java.util.Date lastModified) |
WGDatabaseRevision |
WGDocumentCoreWrapper.save(java.util.Date lastModified) |
void |
WGACL.save(WGACLEntry entry)
Saves the given ACL entry.
|
void |
WGACLCore.save(WGACLEntry entry)
Saves/updates an ACL entry
|
void |
WGDocument.saveQuiet()
Saves the document without updating the last modified timestamp
|
void |
WGDocument.saveWithGivenTimestamps(java.util.Date created,
java.util.Date modified)
Sets the given dates as created and modified dates of the document and saved it with them
|
WGContent |
WGLanguageChooser.selectContentForName(WGDatabase db,
java.lang.String name,
boolean authoring)
Chooses the language version of a content document for a given unique name
|
WGContent |
WGLanguageChooser.selectContentForPage(WGStructEntry page,
boolean authoring)
Chooses the language version of a content document for a given pagee
|
java.util.List<WGContent> |
WGLanguageChooser.selectContentPriorityOrder(WGStructEntry entry,
boolean authoring)
Orders the content of a struct entry in the order they should be priorized language-wise.
|
WGLanguage |
WGLanguageChooser.selectDatabaseLanguage(WGDatabase db)
Chooses a language to use for the given database in some contextless functionality
|
void |
WGStructEntry.setAllowedChildTypes(java.util.List<java.lang.String> types)
Sets the allowed content types for child pages of this struct.
|
void |
WGContentType.setAllowedChildTypes(java.util.List<java.lang.String> types)
Sets the allowed content types for child pages on pages of this type.
|
boolean |
WGContentType.setAllowedPositions(java.util.List pos)
Sets the allowed positions for this content type.
|
void |
WGArea.setAllowedRootTypes(java.util.List<java.lang.String> types)
Sets the allowed content types for root pages on this area.
|
void |
WGContentType.setAuthoring(boolean authoring)
Sets if this content type should be available for authoring purposes.
|
void |
WGStructEntry.setBranchWorkflow(java.lang.String wfName)
Sets a workflow to use on this page and all subpages that themselves do not redefine the workflow.
|
void |
WGContent.setBrowserTitle(java.lang.String title)
Sets the browser title of this document, the title to be shown as for the browser window when this document is loaded
|
boolean |
WGTMLModule.setCacheable(boolean cacheable)
Sets if the result of this modules code should be browser-cacheable
|
boolean |
WGStructEntry.setChildEditors(java.util.List editors)
Sets allowed editors for child entries and their content (if they inherit
their editing rights)
|
void |
WGStructEntry.setChildPageRestrictions(java.lang.String childPages)
Sets the restrictions regarding childpages of this struct.
|
void |
WGContentType.setChildPageRestrictions(java.lang.String childPages)
Sets the restrictions regarding childpages on pages of this content type.
|
boolean |
WGUserProfile.setClient(java.lang.String client)
Sets the browser client name for the current user
|
boolean |
WGContent.setCoauthors(java.util.List coauthors)
Sets a list of co-authors allowed to edit this content
|
boolean |
WGCSSJSModule.setCode(java.lang.String code)
Sets the program code of this library.
|
boolean |
WGTMLModule.setCode(java.lang.String code)
Sets the WebTML-Code for this module
|
boolean |
WGCSSJSModule.setCodeType(java.lang.String type)
Sets the code type of this library.
|
void |
WGContent.setContentClass(java.lang.String clazz)
Sets the content class for this content.
|
boolean |
WGLanguage.setContentCreators(java.util.List cc)
Deprecated.
|
boolean |
WGContentType.setContentCreators(java.util.List cc)
Deprecated.
|
void |
WGFileMetaData.setCopyright(java.lang.String copyright)
Sets the copyright for this image
|
void |
WGFileMetaData.setCustomFieldValue(java.lang.String fieldName,
java.lang.Object value) |
void |
WGFileDerivateMetaData.setCustomFieldValue(java.lang.String fieldName,
java.lang.Object value) |
void |
WGFileAnnotations.setCustomFieldValue(java.lang.String fieldName,
java.lang.Object value)
Sets the value of a custom field annotated for this file
|
boolean |
WGUserProfile.setDBLogin(java.lang.String login)
Sets the content db login for the current user
|
void |
WGFileMetaData.setDescription(java.lang.String desc)
Sets the description of this image
|
void |
WGContent.setDescription(java.lang.String desc)
Set a description for this content document.
|
boolean |
WGDesignDocument.setDescription(java.lang.String desc)
Sets a description
|
boolean |
WGContentType.setDescriptionAliases(java.util.List aliases)
Sets the description aliases in different languages.
|
void |
WGDatabase.setDesignProvider(WGDesignProvider designProvider)
Sets an external design provider from which this database should retrieve
design documents.
|
boolean |
WGTMLModule.setDirectAccessAllowed(boolean value)
Sets if this module should be directly accessible via URL
|
void |
WGFileMetaData.setDisplayHeight(int displayHeight) |
void |
WGFileDerivateMetaData.setDisplayHeight(int displayHeight) |
void |
WGFileAnnotations.setDisplayHeight(int displayHeight)
Sets the display height in pixels for images or videos
|
void |
WGFileMetaData.setDisplayWidth(int displayWidth) |
void |
WGFileDerivateMetaData.setDisplayWidth(int displayWidth) |
void |
WGFileAnnotations.setDisplayWidth(int displayWidth)
Sets the display width in pixels for images or videos
|
void |
WGCSSJSModule.setDOMDocument(org.dom4j.Document doc)
Converts the given DOM-Document to XML sets it as code for this module.
|
void |
WGLanguage.setEditors(java.util.List cc)
Set the people allowed to edit content of this language
|
boolean |
WGArea.setEditors(java.util.List list)
Sets the allowed editors for this area.
|
void |
WGContentType.setEditors(java.util.List cc)
Sets the list of allowed content creators for this content type.
|
boolean |
WGContentType.setEventContentCreated(WGEventScript script)
Sets the event script for event "contentCreated"
|
boolean |
WGContentType.setEventContentSaved(WGEventScript script)
Sets the event script for event "contentSaved"
|
boolean |
WGContentType.setEventStatusChange(WGEventScript script)
Sets the event script for event "statusChange"
|
boolean |
WGContentType.setEventWorkflowMail(WGEventScript script)
Sets the event script for event "workflowMail"
|
void |
WGContent.setHiddenFrom(java.util.List hiddenFrom)
Sets the navigation elements, in that this content should not be shown.
|
boolean |
WGContentType.setInnerLayout(WGTMLModule mod)
Sets the inner layout for this content type.
|
boolean |
WGContentType.setInnerLayoutName(java.lang.String modName)
Sets the inner layout for this content type by specifying the name without reference to the document
|
WGDocument |
WGDocument.setItem(java.lang.String name,
java.lang.Object value) |
WGDocument |
WGDocument.setItems(java.util.Map<java.lang.String,java.lang.Object> values) |
boolean |
WGDocument.setItemValue(java.lang.String strName,
java.lang.Object value)
Sets an item to the given value.
|
boolean |
WGDocumentCore.setItemValue(java.lang.String strName,
java.lang.Object value)
Sets a new value for a content item.
|
boolean |
WGDocumentCoreWrapper.setItemValue(java.lang.String strName,
java.lang.Object value) |
abstract void |
WGPortletRegistry.setItemValue(WGPortlet portlet,
java.lang.String name,
java.lang.Object value)
Sets the value of a portlet item, eventually creating it
|
void |
WGTransientPortletRegistry.setItemValue(WGPortlet portlet,
java.lang.String name,
java.lang.Object value) |
void |
WGPortletItemStorage.setItemValue(WGTransientPortlet portlet,
java.lang.String name,
java.lang.Object value)
Sets stored item for this portlet
|
void |
WGContent.setKeywords(java.util.List keywords)
Sets keywords for this content to provide for internet search services.
|
boolean |
WGUserProfile.setLanguages(java.util.List langs)
Sets the accepted languages for the current user
|
boolean |
WGUserProfile.setLastAccess(java.util.Date lastAccess)
Sets the last accessed date.
|
boolean |
WGContent.setLastClient(java.lang.String client)
Sets the last client that edited this content
|
void |
WGContent.setLinkTarget(java.lang.String target)
Sets the link target of this content, i.e. the frame or browser window name, in which this content should be displayed
when clicked in a navigator.
|
void |
WGHierarchicalDatabase.setListener(WGContent content,
java.lang.String moduleOrClassname)
sets the given module (tmlscriptmodule) or classname (implementation of WGHierarchicalContentListener)
on the given storage or content
|
void |
WGFileMetaData.setManualDerivate(java.lang.String name,
java.lang.String usage,
java.io.InputStream data)
Defines a manual derivate for this file
|
void |
WGSessionContext.setMasterTenantUser(java.lang.String masterTenantUser)
On master sessions can be used to set the name of the user that triggered the master session.
|
WGDocument |
WGDocument.setMeta(java.lang.String name,
java.lang.Object value) |
boolean |
WGDocument.setMetaData(java.lang.String strName,
java.lang.Object value)
Sets a meta data of this document.
|
boolean |
WGSchemaDocument.setMetaData(java.lang.String strName,
java.lang.Object value) |
boolean |
WGDocumentCore.setMetaData(java.lang.String name,
java.lang.Object value)
Modifies various meta data for the document core.
|
boolean |
WGDocumentCoreWrapper.setMetaData(java.lang.String name,
java.lang.Object value) |
WGDocument |
WGDocument.setMetas(java.util.Map<java.lang.String,java.lang.Object> values) |
void |
WGDocument.setMetaToDefault(java.lang.String metaName)
sets the given meta to the default value
|
void |
WGFileMetaData.setMimeType(java.lang.String mimeType) |
void |
WGFileDerivateMetaData.setMimeType(java.lang.String mimeType) |
void |
WGFileAnnotations.setMimeType(java.lang.String mimeType)
Sets the mime type
|
boolean |
WGContentType.setNameAliases(java.util.List aliases)
Sets the name aliases in different languages.
|
boolean |
WGContentType.setOuterLayout(WGTMLModule mod)
Sets the outer layout for this content type.
|
boolean |
WGContentType.setOuterLayoutName(java.lang.String modName)
Sets the outer layout for this content type by specifying the name without reference to the document
|
void |
WGContent.setOwner(java.lang.String owner)
Sets the owner of the content document
|
void |
WGStructEntry.setPageEditors(java.util.List editors)
Sets names that are allowed to edit this struct and it's contents.
|
void |
WGDatabase.setPageRightsFilter(PageRightsFilter pageRightsFilter) |
boolean |
WGUserProfile.setPassword(java.lang.String value)
Sets the custom password for this profile, used in personalisation mode "custom" to open this profile.
|
void |
WGFileMetaData.setPlainText(BinaryFieldData plaintext) |
void |
WGFileDerivateMetaData.setPlainText(BinaryFieldData data) |
void |
WGFileAnnotations.setPlainText(BinaryFieldData data)
sets the plain text representation of this file
|
boolean |
WGStructEntry.setPosition(int pos)
Sets the position number.
|
boolean |
WGContentType.setPositioning(java.lang.String pos)
Sets the allowed positioning of content of this content type.
|
boolean |
WGContentType.setPreferredParent(WGStructEntry parent)
Sets the preferred parent for documents of this content type.
|
boolean |
WGTMLModule.setPreprocess(boolean value) |
void |
WGDocument.setPrimaryFileName(java.lang.String name)
Manually sets the primary attachment of this document
|
boolean |
WGContent.setReaders(java.util.List readers)
Sets a list of readers allowed to see this content
|
boolean |
WGStructEntry.setReaders(java.util.List list)
Sets the allowed readers for this struct entry.
|
boolean |
WGArea.setReaders(java.util.List list)
Sets the allowed readers for this area.
|
WGContent |
WGContent.setRelation(java.lang.String name,
WGContent target)
Sets a normal content relation to the designated target content.
|
WGContent |
WGContent.setRelation(java.lang.String name,
WGContent target,
int type)
Sets a content relation to the designated target content.
|
WGDocumentCore |
WGDocumentCore.setRelation(WGRelationData data)
Sets a content relation to the designated target
|
WGContent |
WGContent.setRelation(WGRelationData address)
Sets a content relation with the given data
|
WGDocumentCore |
WGDocumentCoreWrapper.setRelation(WGRelationData data) |
void |
WGArea.setRootPageRestrictions(java.lang.String rootPages)
Sets the restrictions regarding root pages on this area
|
boolean |
WGStructEntry.setStructEditors(java.util.List editors)
Deprecated.
|
void |
WGArea.setSystemArea(boolean system)
Sets if this area should be marked a system area.
|
void |
WGFileMetaData.setTitle(java.lang.String title)
Sets the title of this file
|
WGContent |
WGContent.setTitle(java.lang.String title)
Sets the title of this content document.
|
boolean |
WGStructEntry.setTitle(java.lang.String title)
Sets the struct title.
|
boolean |
WGLanguage.setTitle(java.lang.String value)
Set the title of this language.
|
void |
WGContent.setUniqueName(java.lang.String name)
Sets the unique name of this content document, which can be used in URLs instead of the content key.
|
void |
WGStructEntry.setUniqueName(java.lang.String name)
Sets the unique name of this struct entry
|
void |
WGFileDerivateMetaData.setUsage(java.lang.String usage)
Sets the usage of this derivate as constant WGFileAnnotations.USAGE_...
|
void |
WGContent.setValidity(java.util.Date from,
java.util.Date to)
Sets validity dates, narrowing the period of time, in which a document will be visible.
|
WGDocument |
WGDocument.setValues(java.util.Map<java.lang.String,java.lang.Object> values) |
void |
WGContent.setVirtualLink(java.lang.String type,
java.lang.String url)
Sets a virtual link for this document, making the content document a "virtual document".
|
void |
WGContent.setVisible(boolean visible)
Sets the general visibility flag, choosing if this document is visible.
|
boolean |
WGContentType.setWorkflow(java.lang.String name)
Sets the workflow name of this content type.
|
boolean |
WGStructEntry.setWorkflowName(java.lang.String wfname)
Deprecated.
Assymetric to
WGStructEntry.getWorkflowName() and thus irritating. Use WGStructEntry.setBranchWorkflow(String) instead. |
WGTransaction |
WGDatabase.startTransaction()
Starts a transaction and returns a transaction object.
|
void |
WGHierarchicalDatabase.updateContent(WGContent content)
updates the given content within the listener, parameter will be null, leaves the title unchanged
|
void |
WGHierarchicalDatabase.updateContent(WGContent content,
java.lang.Object parameter)
updates the given content within the listener using parameter, leaves the title unchanged
|
WGContent |
WGHierarchicalDatabase.updateContent(WGContent content,
java.lang.String title,
java.lang.Object parameter)
updates the title on the given content and optional further fields within the listener using parameter
if versioning is enabled the post_update_event is executed on a draft copy
|
abstract void |
WGPortletRegistry.updatePortlet(WGPortlet portlet)
Updates an already registered portlet with the information given in the parameter portlet object
|
void |
WGTransientPortletRegistry.updatePortlet(WGPortlet portlet) |
boolean |
WGDocument.validateMetas()
Variant of
WGDocument.validateMetas(boolean) that performs no auto correction. |
boolean |
WGDocument.validateMetas(boolean autoCorrection)
checks all metas of this document to ensure value and datatype correspond to the current
api implementation.
|
void |
WGDatabase.visit(WGPageVisitor visitor)
Implements the visitor pattern on the page hierarchy.
|
void |
WGStructEntry.visit(WGPageVisitor visitor)
Implements the visitor pattern on the page hierarchy branch of this struct entry.
|
void |
WGArea.visit(WGPageVisitor visitor)
Implements the visitor pattern on the page hierarchy of this area.
|
void |
WGDocument.writeExtensionData(java.lang.String strName,
java.lang.Object value) |
void |
WGFileMetaData.writeExtensionData(java.lang.String strName,
java.lang.Object value) |
void |
WGDatabaseCore.writeExtensionData(java.lang.String name,
java.lang.Object value)
Writes an extension data field to in this database.
|
void |
WGDatabase.writeExtensionData(java.lang.String name,
java.lang.Object value)
Writes a extension data field.
|
void |
WGExtensionDataContainer.writeExtensionData(java.lang.String strName,
java.lang.Object value)
Sets the value of an extension data field.
|
void |
WGDocumentCoreWrapper.writeExtensionData(java.lang.String strName,
java.lang.Object value) |
void |
WGDocument.writeFileDerivateMetaData(WGFileDerivateMetaData md)
Write modifications to derivate metadata to the derivate
|
void |
WGDocumentCore.writeFileDerivateMetaData(WGFileDerivateMetaData md)
Writes the modified metadata of a file derivate to the database.
|
void |
WGDocumentCoreWrapper.writeFileDerivateMetaData(WGFileDerivateMetaData md) |
Constructor and Description |
---|
WGArea(WGDatabase db,
WGDocumentCore doc) |
WGArea(WGDatabase wgDatabase,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags) |
WGCachedResultSet(WGResultSetCore resultSetCore)
Creates a cached result set that will cache the contents that is given as result set core
|
WGColumnSet.Term(java.lang.String term)
Constructor
|
WGColumnSet(java.lang.String columnExpression)
Constructor
|
WGContent(WGDatabase db,
WGDocumentCore doc)
Constructor.
|
WGContent(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
Constructor.
|
WGContentIterator(WGDatabase db,
boolean includeArchived)
Constructs an iterator for the given database
|
WGContentNavigator(java.lang.String displayType,
WGLanguageChooser chooser)
Public constructor for WGContentNavigator.
|
WGContentType(WGDatabase db,
WGDocumentCore doc)
Constructor.
|
WGContentType(WGDatabase wgDatabase,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags) |
WGCSSJSModule(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
Constructor.
|
WGDesignDocument(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
Constructor.
|
WGDesignResourceDocument(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags) |
WGDocument(WGDatabase db,
WGDocumentCore core) |
WGDocument(WGDatabase db,
WGDocumentCore core,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
Constructor.
|
WGFileContainer(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
Constructor.
|
WGLanguage(WGDatabase db,
WGDocumentCore doc)
Constructor.
|
WGLanguage(WGDatabase wgDatabase,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags) |
WGSchemaDocument(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags) |
WGScriptModule(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
Constructor.
|
WGStructEntry.ContentSet(java.util.List<WGContent> contents) |
WGStructEntry(WGDatabase db,
WGDocumentCore doc)
Constructor.
|
WGStructEntry(WGDatabase wgDatabase,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags) |
WGTMLModule(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
Constructor.
|
WGUserProfile(WGDatabase db,
WGDocumentCore doc,
de.innovationgate.webgate.api.WGDocumentObjectFlags flags)
Constructor.
|
Modifier and Type | Class and Description |
---|---|
class |
AuthenticationException
Thrown when an authentication attempt fails because of an error in the process.
|
class |
ConfigurationException
An exception thrown on a misconfigured authentication module
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
WGFakeContentStore.callBackendService(java.lang.String serviceName,
java.lang.Object[] params) |
void |
WGFakeDatabase.clearSessionCache() |
void |
WGFakeDatabase.closeSession() |
WGFileDerivateMetaData |
WGFakeDocument.createFileDerivate(java.lang.String originalFileName,
java.lang.String creator,
java.lang.String derivateName,
java.io.InputStream in,
java.util.Map<java.lang.String,java.lang.Object> customMdFields) |
WGDocumentCore |
WGFakeContentStore.createUserProfile(java.lang.String name,
int type) |
WGDocumentCore |
WGFakeDatabase.createUserProfile(java.lang.String name,
int type) |
void |
WGFakeContentStore.deleteSequence(java.lang.String name) |
java.util.List |
WGFakeDatabase.getAllContentKeys(boolean includeArchived) |
java.util.Iterator<java.lang.String> |
WGFakeDatabase.getAllUserProfileNames() |
int |
WGFakeContentStore.getChildEntryCount(WGStructEntry structEntry) |
int |
WGFakeContentStore.getContentStorePatchLevel() |
int |
WGFakeDatabase.getContentStorePatchLevel() |
double |
WGFakeContentStore.getContentStoreVersion() |
double |
WGFakeDatabase.getContentStoreVersion() |
java.util.Set |
WGFakeDatabase.getDeletions(java.util.Set documentKeys) |
WGDocumentCore |
WGFakeDatabase.getDesignObject(int type,
java.lang.String name,
java.lang.String strMediaKey) |
java.lang.Object |
WGFakeDocument.getExtensionData(java.lang.String strName) |
java.util.List |
WGFakeDocument.getExtensionDataNames() |
java.util.List<java.lang.String> |
WGFakeDatabase.getExtensionDataNames() |
java.io.InputStream |
WGFakeDocument.getFileDerivateData(java.lang.String id) |
WGFileDerivateMetaData |
WGFakeDocument.getFileDerivateMetaData(java.lang.String id) |
java.util.List<WGFileDerivateMetaData> |
WGFakeDocument.getFileDerivates(java.lang.String strFile) |
WGFileMetaData |
WGFakeDocument.getFileMetaData(java.lang.String strFile) |
java.util.List<WGRelationData> |
WGFakeDatabase.getIncomingRelations(java.lang.Object structKey,
java.lang.String language,
java.lang.String contentClass,
java.lang.String relName,
java.lang.String relGroupName,
java.lang.Boolean includeUnreleased,
WGColumnSet order) |
long |
WGFakeContentStore.getLastSequenceIncrementValue(java.lang.String name) |
java.util.Iterator<WGUpdateLog> |
WGFakeDocument.getLastUpdates() |
WGDocumentCore |
WGFakeDocument.getRelation(java.lang.String name) |
WGRelationData |
WGFakeDocument.getRelationData(java.lang.String name) |
java.util.List<java.lang.String> |
WGFakeDocument.getRelationNames() |
java.util.Date |
WGFakeDatabase.getRevisionDate(java.lang.Comparable lastChanged) |
int |
WGFakeContentStore.getRootEntryCount(WGArea area) |
java.lang.String |
WGFakeDatabase.getServerName() |
WGDocumentCore |
WGFakeDatabase.getStructEntryByName(java.lang.String strName) |
java.util.List<java.lang.String> |
WGFakeContentStore.getUsedSequenceNames() |
boolean |
WGFakeDocument.hasFileMetadata() |
long |
WGFakeContentStore.incrementSequence(java.lang.String name) |
boolean |
WGFakeContentStore.initSequence(java.lang.String name,
long startValue,
boolean forceInit) |
boolean |
WGFakeContentStore.isContentTypeUsed(WGContentType ct) |
boolean |
WGFakeContentStore.isLanguageUsed(WGLanguage lang) |
boolean |
WGFakeContentStore.isSequenceInitialized(java.lang.String name) |
void |
WGFakeDocument.markFileMetaDataModified(WGFileMetaData md) |
WGUserAccess |
WGFakeContentStore.openSession(AuthenticationSession authSession,
java.lang.Object credentials,
boolean master) |
void |
WGFakeDocument.removeExtensionData(java.lang.String strName) |
void |
WGFakeDatabase.removeExtensionData(java.lang.String name) |
void |
WGFakeDocument.removeFileDerivate(java.lang.String id) |
WGDocumentCore |
WGFakeDocument.removeRelation(java.lang.String name) |
void |
WGFakeDocument.renameFile(java.lang.String oldFileName,
java.lang.String newFileName) |
WGExtensionDataContainer |
WGFakeDocument.retrieveFileExtensionDataHandler(java.lang.String strFile) |
WGDocumentCore |
WGFakeDocument.setRelation(java.lang.String name,
WGDocumentCore target) |
WGDocumentCore |
WGFakeDocument.setRelation(WGRelationData data) |
void |
WGFakeDocument.writeExtensionData(java.lang.String strName,
java.lang.Object value) |
void |
WGFakeDatabase.writeExtensionData(java.lang.String name,
java.lang.Object value) |
void |
WGFakeDocument.writeFileDerivateMetaData(WGFileDerivateMetaData md) |
Modifier and Type | Class and Description |
---|---|
class |
LockException
superclass for all exceptions thrown by
locking-functionalities and modify methods of locked objects
|
class |
LockWaitTimeoutException
thrown when a lockrequest timed out
|
class |
ResourceIsLockedException
thrown when a locked resource is modified without obtaining a lock
|
Modifier and Type | Method and Description |
---|---|
boolean |
LockManager.foreignChildLocksExists(Lockable lockable,
LockOwner owner)
checks if foreign locks exists on decendant objects of the given lockable
|
int |
LockManager.getLockStatus(Lockable lockable,
LockOwner owner)
returns the lockstatus of the given lockable for the given owner
if the given lockable is not locked, the lockstatus is retrieved
hierarchically by the parent-lockable
|
int |
Lockable.getLockStatus(LockOwner caller)
returns the current lockstatus of the lockable - if parent is set and locked the lockstatus is inherited
|
Lockable |
Lockable.getParentLockable()
returns the parent lockable of this lockable for e.g.
|
void |
Lockable.lock(LockOwner owner)
locks the object for the given owner
|
void |
LockManager.obtainLock(Lockable lockable,
LockOwner owner)
obtains a lock on the given lockable for the given owner
|
Modifier and Type | Class and Description |
---|---|
class |
WGMailException
Thrown if something goes wrong in WGAPI mail handling
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
WGDatabaseImpl.callBackendService(java.lang.String serviceName,
java.lang.Object[] params) |
void |
WGDatabaseImpl.clearSessionCache() |
WGFileDerivateMetaData |
WGDatabaseImpl.createFileDerivate(WGDocumentCore doc,
java.lang.String originalFileName,
java.lang.String creator,
java.lang.String derivateName,
java.io.InputStream in,
java.util.Map<java.lang.String,java.lang.Object> customMdFields) |
java.util.List |
WGDatabaseImpl.getAllContentKeys(boolean includeArchived) |
int |
WGDatabaseImpl.getContentStorePatchLevel() |
double |
WGDatabaseImpl.getContentStoreVersion() |
java.util.Set |
WGDatabaseImpl.getDeletions(java.util.Set contentKeys) |
java.util.List<java.lang.String> |
WGDatabaseImpl.getExtensionDataNames() |
java.util.List<WGRelationData> |
WGDatabaseImpl.getIncomingRelations(java.lang.Object structKey,
java.lang.String language,
java.lang.String contentClass,
java.lang.String relName,
java.lang.String relGroupName,
java.lang.Boolean includeUnreleased,
WGColumnSet order) |
java.util.Date |
WGDatabaseImpl.getRevisionDate(java.lang.Comparable lastChanged) |
WGDocumentCore |
WGDatabaseImpl.getStructEntryByName(java.lang.String strName) |
java.util.List |
WGDatabaseImpl.getUpdateLogs(java.lang.Comparable cutoff) |
boolean |
WGDatabaseImpl.isContentTypeUsed(WGContentType ct) |
boolean |
WGDatabaseImpl.isLanguageUsed(WGLanguage lang) |
void |
WGDatabaseImpl.removeExtensionData(java.lang.String name) |
void |
WGDatabaseImpl.writeExtensionData(java.lang.String name,
java.lang.Object value) |
Modifier and Type | Class and Description |
---|---|
class |
WGSchemaValidationException
An exception thrown when the validation of a schema definition fails
|
Modifier and Type | Method and Description |
---|---|
void |
WGSchemaDefinition.validate()
Validates the schema for logical errors
|
Modifier and Type | Class and Description |
---|---|
class |
ServerConnectionException
Thrown when connection to a server fails
|
Modifier and Type | Method and Description |
---|---|
boolean |
DatabaseFilter.accept(java.lang.Object filterContext) |
DatabaseInformation |
WGDatabaseServer.createDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
java.util.Map<java.lang.String,java.lang.String> options) |
DatabaseInformation |
RSSDatabaseRetriever.createDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
WGDatabaseServer dbServer,
java.util.Map<java.lang.String,java.lang.String> options) |
DatabaseInformation |
GenericServerDatabaseRetriever.createDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
WGDatabaseServer dbServer,
java.util.Map<java.lang.String,java.lang.String> options) |
DatabaseInformation |
ServerDatabaseRetriever.createDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
WGDatabaseServer dbServer,
java.util.Map<java.lang.String,java.lang.String> options) |
java.util.List<DatabaseInformation> |
WGDatabaseServer.getAvailableDatabases(java.lang.Class<? extends WGDatabaseCore> implClass) |
java.util.List<DatabaseInformation> |
ServerDatabaseRetriever.getAvailableDatabases(WGDatabaseServer dbServer) |
java.util.List<java.lang.String> |
WGDatabaseServer.getDatabasePathOptions(java.lang.Class<? extends WGDatabaseCore> implClass) |
void |
WGDatabaseServer.init(java.lang.String uid,
java.lang.String title,
java.util.Map<java.lang.String,java.lang.String> options) |
boolean |
WGDatabaseServer.isAvailableDatabasesRetrievable(java.lang.Class<? extends WGDatabaseCore> implClass) |
boolean |
WGDatabaseServer.isDatabaseTypeCreatable(java.lang.Class<? extends WGDatabaseCore> implClass) |
WGDatabase |
WGDatabaseServer.openDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
java.util.Map<java.lang.String,java.lang.String> options) |
WGDatabase |
RSSDatabaseRetriever.openDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
WGDatabaseServer dbServer,
java.util.Map<java.lang.String,java.lang.String> options,
boolean prepareOnly) |
WGDatabase |
GenericServerDatabaseRetriever.openDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
WGDatabaseServer dbServer,
java.util.Map<java.lang.String,java.lang.String> options,
boolean prepareOnly) |
WGDatabase |
ServerDatabaseRetriever.openDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
WGDatabaseServer dbServer,
java.util.Map<java.lang.String,java.lang.String> options,
boolean prepareOnly) |
WGDatabase |
WGDatabaseServer.prepareDatabase(java.lang.Class<? extends WGDatabaseCore> implClass,
java.util.Map<java.lang.String,java.lang.String> options) |
Modifier and Type | Method and Description |
---|---|
int |
BeanAdapter.login(java.lang.String user,
java.lang.String pwd) |
Modifier and Type | Method and Description |
---|---|
void |
SimpleFileContainer.attachFile(java.io.File file)
Called to attach a file to the container
|
abstract java.util.Map |
SimpleContentSource.browse(java.lang.String folder)
Browses the given folder for contents.
|
java.util.Map |
QueryableSource.browse(java.lang.String folder) |
java.lang.Object |
SimpleContentSource.calculateKey(java.lang.String folder,
java.lang.Object _bean)
Method to calculate the key to a newly created data object.
|
java.lang.Object |
SimpleContentSource.callBackendService(java.lang.String serviceName,
java.lang.Object[] params) |
void |
SimpleContentSource.clearSessionCache() |
void |
SimpleContentSource.close() |
void |
SimpleContentSource.closeSession() |
abstract java.lang.Object |
SimpleContentSource.convertToKey(java.lang.String key,
java.lang.String folder)
Converts the string representation of a data key to it's real data type.
|
java.lang.Object |
QueryableSource.convertToKey(java.lang.String key,
java.lang.String folder) |
abstract java.lang.Object |
SimpleContentSource.createContent(java.lang.String folder)
Creates a new content object in the given folder
|
java.lang.Object |
QueryableSource.createContent(java.lang.String folder) |
WGDocumentCore |
SimpleContentSource.createContent(WGStructEntry structEntry,
WGLanguage language,
java.lang.String title,
int version) |
WGDocumentCore |
SimpleContentSource.createCopy(WGDocumentCore original) |
WGDocumentCore |
SimpleContentSource.createDesignDocument(int type,
java.lang.String name,
java.lang.String mediaKey) |
WGFileDerivateMetaData |
BeanFolder.createFileDerivate(java.lang.String originalFileName,
java.lang.String creator,
java.lang.String derivateName,
java.io.InputStream in,
java.util.Map<java.lang.String,java.lang.Object> customMdFields) |
WGFileDerivateMetaData |
BeanWrapper.createFileDerivate(java.lang.String originalFileName,
java.lang.String creator,
java.lang.String derivateName,
java.io.InputStream in,
java.util.Map<java.lang.String,java.lang.Object> customMdFields) |
WGFileDerivateMetaData |
WrappedKey.createFileDerivate(java.lang.String originalFileName,
java.lang.String creator,
java.lang.String derivateName,
java.io.InputStream in,
java.util.Map<java.lang.String,java.lang.Object> customMdFields) |
WGDocumentCore |
SimpleContentSource.createStructEntry(java.lang.Object key,
WGDocument reference,
WGContentType contentType) |
WGDocumentCore |
SimpleContentSource.createUserProfile(java.lang.String name,
int type) |
BeanWrapper |
SimpleContentSource.createWrapper(BeanKey key,
java.lang.Object bean,
boolean saved)
Creates a wrapper for the given content object that implements WGDocumentCore for it
|
java.lang.String |
SimpleContentSource.extractFolder(java.lang.String type,
java.lang.String query,
java.util.Map parameters)
Helps to retrieve the folder for query results based on the given query parameters.
|
WGDocumentCore |
SimpleContentSource.fastAccess(int type,
java.lang.Object key) |
abstract java.util.List |
QueryableSource.find(java.lang.String query)
Abstract method to implement query behaviour.
|
abstract java.util.Map |
SimpleContentSource.find(java.lang.String type,
java.lang.String query,
java.util.Map parameters)
Used to implement querying behaviour to the SCS implementation.
|
java.util.Map |
QueryableSource.find(java.lang.String type,
java.lang.String query,
java.util.Map parameters) |
java.util.List |
SimpleContentSource.getAllContent(WGStructEntry structEntry,
boolean includeArchived) |
java.util.List |
SimpleContentSource.getAllContentKeys(boolean includeArchived) |
java.lang.Object |
WrappedKey.getBean()
Returns the bean that is stored under this key.
|
java.util.Iterator<WGDocumentCore> |
SimpleContentSource.getChildEntries(WGStructEntry structEntry,
WGPageOrderSet order) |
abstract java.lang.Object |
SimpleContentSource.getContent(java.lang.String folder,
java.lang.Object key)
Implement to retrieve a single data object by key information.
|
java.lang.Object |
QueryableSource.getContent(java.lang.String folder,
java.lang.Object key) |
WGDocumentCore |
SimpleContentSource.getContentByKey(WGContentKey key) |
WGDocumentCore |
SimpleContentSource.getContentByName(java.lang.String strName,
java.lang.String strLanguage) |
int |
SimpleContentSource.getContentStorePatchLevel() |
double |
SimpleContentSource.getContentStoreVersion() |
java.util.Set |
SimpleContentSource.getDeletions(java.util.Set contentKeys) |
WGDocumentCore |
SimpleContentSource.getDesignObject(int type,
java.lang.String name,
java.lang.String strMediaKey) |
java.util.List |
SimpleContentSource.getDesignObjects(int type) |
WGDocumentCore |
SimpleContentSource.getDummyContent(java.lang.String language) |
java.lang.Object |
BeanFolder.getExtensionData(java.lang.String strName) |
java.lang.Object |
BeanWrapper.getExtensionData(java.lang.String strName) |
java.lang.Object |
SimpleContentSource.getExtensionData(java.lang.String name) |
java.lang.Object |
WrappedKey.getExtensionData(java.lang.String strName) |
java.util.List |
BeanFolder.getExtensionDataNames() |
java.util.List |
BeanWrapper.getExtensionDataNames() |
java.util.List<java.lang.String> |
SimpleContentSource.getExtensionDataNames() |
java.util.List |
WrappedKey.getExtensionDataNames() |
java.io.InputStream |
SimpleFileContainer.getFileData(java.lang.String fileName)
Returns the data of a file in this container as stream
|
java.util.List<WGFileDerivateMetaData> |
BeanFolder.getFileDerivates(java.lang.String strFile) |
java.util.List<WGFileDerivateMetaData> |
BeanWrapper.getFileDerivates(java.lang.String strFile) |
java.util.List<WGFileDerivateMetaData> |
WrappedKey.getFileDerivates(java.lang.String strFile) |
WGFileMetaData |
BeanFolder.getFileMetaData(java.lang.String strFile) |
WGFileMetaData |
BeanWrapper.getFileMetaData(java.lang.String strFile) |
WGFileMetaData |
WrappedKey.getFileMetaData(java.lang.String strFile) |
long |
SimpleFileContainer.getFileSize(java.lang.String fileName)
Returns the size of a file in bytes
|
abstract java.lang.String[] |
SimpleContentSource.getFolders()
Implement to return the available folders
|
java.lang.String[] |
QueryableSource.getFolders() |
java.util.List<WGRelationData> |
SimpleContentSource.getIncomingRelations(java.lang.Object structKey,
java.lang.String language,
java.lang.String contentClass,
java.lang.String relName,
java.lang.String relGroupName,
java.lang.Boolean includeUnreleased,
WGColumnSet order) |
abstract java.util.Date |
SimpleContentSource.getLastModified()
Implement to return a last modified date.
|
java.util.Date |
QueryableSource.getLastModified() |
java.util.Iterator<WGUpdateLog> |
BeanFolder.getLastUpdates() |
java.util.Iterator<WGUpdateLog> |
BeanWrapper.getLastUpdates() |
java.util.Iterator<WGUpdateLog> |
WrappedKey.getLastUpdates() |
WGDocumentCore |
SimpleContentSource.getParentEntry(WGStructEntry entry) |
WGDocumentCore |
BeanFolder.getRelation(java.lang.String name) |
WGDocumentCore |
BeanWrapper.getRelation(java.lang.String name) |
WGDocumentCore |
WrappedKey.getRelation(java.lang.String name) |
WGRelationData |
BeanFolder.getRelationData(java.lang.String name) |
WGRelationData |
BeanWrapper.getRelationData(java.lang.String name) |
WGRelationData |
WrappedKey.getRelationData(java.lang.String name) |
java.util.List<java.lang.String> |
BeanFolder.getRelationNames() |
java.util.List<java.lang.String> |
BeanWrapper.getRelationNames() |
java.util.List<java.lang.String> |
WrappedKey.getRelationNames() |
java.util.Date |
SimpleContentSource.getRevision() |
java.util.Date |
SimpleContentSource.getRevisionDate(java.lang.Comparable lastChanged) |
java.util.Iterator<WGDocumentCore> |
SimpleContentSource.getRootEntries(WGArea area,
WGPageOrderSet pageOrder) |
java.lang.String |
QueryableSource.getServerName() |
WGDocumentCore |
SimpleContentSource.getStructEntryByKey(java.lang.Object key) |
WGDocumentCore |
SimpleContentSource.getStructEntryByName(java.lang.String strName) |
java.util.List |
SimpleContentSource.getUpdatedDocumentsSince(java.util.Date cutoff) |
java.util.List |
SimpleContentSource.getUpdateLogs(java.lang.Comparable cutoff) |
WGDocumentCore |
SimpleContentSource.getUserProfile(java.lang.String name) |
boolean |
BeanFolder.hasFileMetadata() |
boolean |
BeanWrapper.hasFileMetadata() |
boolean |
WrappedKey.hasFileMetadata() |
abstract ContentSourceSpecs |
SimpleContentSource.init(WGDatabase db,
java.lang.String path)
Implement to initialize the SCS implementation when the database gets opened.
|
ContentSourceSpecs |
QueryableSource.init(WGDatabase db,
java.lang.String path) |
abstract boolean |
SimpleContentSource.insertContent(java.lang.String folder,
java.lang.Object key,
java.lang.Object bean)
Implement functionality to insert a new data object to a folder
|
boolean |
QueryableSource.insertContent(java.lang.String folder,
java.lang.Object key,
java.lang.Object bean) |
boolean |
SimpleContentSource.isContentTypeUsed(WGContentType ct) |
boolean |
SimpleContentSource.isLanguageUsed(WGLanguage lang) |
boolean |
SimpleContentSource.isMemberOfUserList(java.util.List userList) |
abstract int |
SimpleContentSource.login(java.lang.String user,
java.lang.String pwd)
Implement to specify login behaviour for users opening single sessions.
|
int |
QueryableSource.login(java.lang.String user,
java.lang.String pwd) |
abstract void |
SimpleContentSource.logout()
Called when a user session is closed to cleanup resources of it
|
void |
QueryableSource.logout() |
void |
BeanFolder.markFileMetaDataModified(WGFileMetaData md) |
void |
BeanWrapper.markFileMetaDataModified(WGFileMetaData md) |
void |
WrappedKey.markFileMetaDataModified(WGFileMetaData md) |
boolean |
SimpleContentSource.moveStructEntry(WGStructEntry entry,
WGDocument newParent) |
WGUserAccess |
SimpleContentSource.open(WGDatabase db,
java.lang.String path,
java.lang.String user,
java.lang.String pwd,
boolean prepareOnly) |
WGUserAccess |
SimpleContentSource.openSession(AuthenticationSession authSession,
java.lang.Object pwd,
boolean master) |
java.lang.Object |
SimpleContentSource.parseStructKey(java.lang.String key) |
WGResultSetCore |
SimpleContentSource.query(java.lang.String type,
java.lang.String query,
java.util.Map parameters) |
java.util.List |
SimpleContentSource.queryUserProfileNames(java.lang.String type,
java.lang.String query,
java.util.Map params) |
WGDatabaseRevision |
BeanWrapper.remove() |
abstract void |
SimpleContentSource.removeContent(java.lang.String folder,
java.lang.Object key)
Implement behaviour to remove a data object from a folder
|
void |
QueryableSource.removeContent(java.lang.String folder,
java.lang.Object key) |
void |
BeanFolder.removeExtensionData(java.lang.String strName) |
void |
BeanWrapper.removeExtensionData(java.lang.String strName) |
void |
SimpleContentSource.removeExtensionData(java.lang.String name) |
void |
WrappedKey.removeExtensionData(java.lang.String strName) |
void |
SimpleFileContainer.removeFile(java.lang.String fileName)
Tells the container to remove a file
|
void |
BeanFolder.removeFileDerivate(java.lang.String id) |
void |
BeanWrapper.removeFileDerivate(java.lang.String id) |
void |
WrappedKey.removeFileDerivate(java.lang.String id) |
WGDocumentCore |
BeanFolder.removeRelation(java.lang.String name) |
WGDocumentCore |
BeanWrapper.removeRelation(java.lang.String name) |
WGDocumentCore |
WrappedKey.removeRelation(java.lang.String name) |
void |
BeanFolder.renameFile(java.lang.String oldFileName,
java.lang.String newFileName) |
void |
BeanWrapper.renameFile(java.lang.String oldFileName,
java.lang.String newFileName) |
void |
WrappedKey.renameFile(java.lang.String oldFileName,
java.lang.String newFileName) |
WGExtensionDataContainer |
BeanFolder.retrieveFileExtensionDataHandler(java.lang.String strFile) |
WGExtensionDataContainer |
BeanWrapper.retrieveFileExtensionDataHandler(java.lang.String strFile) |
WGExtensionDataContainer |
WrappedKey.retrieveFileExtensionDataHandler(java.lang.String strFile) |
WGDatabaseRevision |
BeanWrapper.save(java.util.Date lastModified) |
WGDocumentCore |
BeanFolder.setRelation(java.lang.String name,
WGDocumentCore target) |
WGDocumentCore |
BeanWrapper.setRelation(java.lang.String name,
WGDocumentCore target) |
WGDocumentCore |
WrappedKey.setRelation(java.lang.String name,
WGDocumentCore target) |
WGDocumentCore |
BeanFolder.setRelation(WGRelationData data) |
WGDocumentCore |
BeanWrapper.setRelation(WGRelationData data) |
WGDocumentCore |
WrappedKey.setRelation(WGRelationData data) |
abstract boolean |
SimpleContentSource.updateContent(java.lang.String folder,
java.lang.Object key,
java.lang.Object bean)
Implement behaviour to update the database backend with new data for a data object
|
boolean |
QueryableSource.updateContent(java.lang.String folder,
java.lang.Object key,
java.lang.Object bean) |
void |
BeanFolder.writeExtensionData(java.lang.String strName,
java.lang.Object value) |
void |
BeanWrapper.writeExtensionData(java.lang.String strName,
java.lang.Object value) |
void |
SimpleContentSource.writeExtensionData(java.lang.String name,
java.lang.Object value) |
void |
WrappedKey.writeExtensionData(java.lang.String strName,
java.lang.Object value) |
void |
BeanFolder.writeFileDerivateMetaData(WGFileDerivateMetaData md) |
void |
BeanWrapper.writeFileDerivateMetaData(WGFileDerivateMetaData md) |
void |
WrappedKey.writeFileDerivateMetaData(WGFileDerivateMetaData md) |
Modifier and Type | Method and Description |
---|---|
boolean |
ContentStoreDumpManager.exportDump()
Exports an OpenWGA content store dump from a content store.
|
boolean |
ContentStoreDumpManager.exportDump(boolean includeACL)
Exports an OpenWGA content store dump from a content store.
|
boolean |
ContentStoreDumpManager.exportDump(boolean includeACL,
boolean includeSystemAreas,
boolean includeArchived)
Exports an OpenWGA content store dump from a content store.
|
boolean |
ContentStoreDumpManager.importDump()
Imports an OpenWGA content store dump into a content store.
|
boolean |
ContentStoreDumpManager.importDump(boolean includeACL)
Imports an OpenWGA content store dump into a content store.
|
boolean |
ContentStoreDumpManager.importDump(boolean includeACL,
boolean includeSystemAreas)
Imports an OpenWGA content store dump into a content store.
|
Modifier and Type | Method and Description |
---|---|
boolean |
WGWorkflow.approve(java.lang.String comment)
Approves the content
|
void |
WGWorkflow.archive(java.lang.String comment)
Archives the content.
|
java.lang.Object |
WGWorkflowEngine.createWorkflowDefinition(java.lang.String name)
Create a workflow definition.
|
WGWorkflow |
WGWorkflowEngine.getWorkflow(WGContent content)
Creates a workflow object for the given content
|
int |
WGAutoApprovalCapableWorkflow.getWorkflowLevelRole()
Returns the role of the current user on the current workflow level only.
|
int |
WGWorkflow.getWorkflowRole()
Returns the workflow role of the currently logged in user for the current workflow level of the content.
|
void |
WGWorkflowEngine.init(WGDatabase db)
Called when the engine object is created to do initial operations.
|
void |
WGWorkflow.initialize()
Called when a content enters workflow and should be initialized for it.
|
boolean |
WGAutoApprovalCapableWorkflow.isAlreadyApprovedByUser()
Returns if the current user has already approved the current workflow
|
boolean |
WGWorkflow.isApprovableByUser()
Checks all conditions that are necessary for the current user to approve this document.
|
boolean |
WGWorkflow.publish(java.lang.String comment)
Publishes a draft content so it can enter authorization workflow.
|
void |
WGWorkflow.reject(java.lang.String comment)
Rejects a content back to draft status.
|
void |
WGWorkflow.release(java.lang.String comment)
Called when a content is released (i.e. has completely passed the workflow)
|
boolean |
WGWorkflowEngine.removeWorkflowDefinition(java.lang.Object wfDef)
Deletes a workflow definition.
|
boolean |
WGWorkflowEngine.saveWorkflowDefinition(java.lang.Object wfDef)
Saves the state of a workflow definition object
|
void |
WGWorkflowEventListener.workflowMail(WGWorkflowEvent workflowEvent)
Triggered when a workflow mail will be sent.
|