Package | Description |
---|---|
de.innovationgate.webgate.api |
Basic functionality of the WGAPI including most of the database-independent functionality.
|
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.query.rss | |
de.innovationgate.webgate.api.templates |
Templates to create your own simple content/design/repository sources.
|
Modifier and Type | Class and Description |
---|---|
class |
WGArea
Represents an area of the content database, containing content documents.
|
class |
WGContent
Represents a content document of this content database.
|
class |
WGContentType
Formerly referred to as "Doctype", this is a document describing a type of
content document.
|
class |
WGCSSJSModule
Represents a Module containing various Non-WebTML-Code, e.g. for Web-Scripting- or Formatting-Languages
|
class |
WGDesignDocument
Superclass for WGAPI "design documents", i.e. documents that are not directly related to authoring and therefor not editable by pure authors/editors.
|
class |
WGDesignResourceDocument
Documents representing real design resources
|
class |
WGFileContainer
A file container, whose main duty is to carry file attachments.
|
class |
WGLanguage
A language definion.
|
class |
WGSchemaDocument
Denotes documents defining the content schema of the content store and their shared functionality, explicitly their data redirection to schema definitions
|
class |
WGScriptModule
Represents a Module containing various Non-WebTML-Code, e.g. for Web-Scripting- or Formatting-Languages
This is a behaviourless subclass of WGCSSJSModule that should hide this - now misleading - class name.
|
class |
WGStructEntry
A struct entry that is used to build the site hierarchy, determine the
content types at the hierarchy nodes and the editing rights in the hierarchy.
|
class |
WGTMLModule
A TML module containing WebTML Source code.
|
class |
WGUserProfile
A user profile, used to store information about and from a web user.
|
Modifier and Type | Method and Description |
---|---|
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) |
WGDocument |
WGAuthorisationException.getCauseDocument()
Deprecated.
Better use
WGAPIException.getCauseDocumentKey() , because the cause document may not be visible for the current user |
WGDocument |
WGSessionContext.DocumentContext.getDocument() |
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.
|
WGDocument |
WGDatabaseEvent.getEditedDocument()
The document of the database that was edited and triggered the event.
|
WGDocument |
WGDocument.getFileParent() |
WGDocument |
WGDocument.FakeMetaDataContext.getFileParent() |
WGDocument |
WGFileMetaDataContext.getFileParent()
Returns the parent document holding the file attachment, if possible
|
WGDocument |
WGStructEntryIterator.getParent()
Returns the parent document of the iterated struct entries, either a
WGArea or a WGStructEntry |
WGDocument |
WGFileMetaData.getParentDocument() |
WGDocument |
WGFileDerivateMetaData.getParentDocument() |
WGDocument |
WGFileAnnotations.getParentDocument()
Returns the parent document to which the file, described by these file annotations, belong
|
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.
|
WGDocument |
WGStructEntry.mayEditChildren()
Deprecated.
Because of counter-intuitive return values. Use
WGStructEntry.mayEditChildPages() |
WGDocument |
WGStructEntry.mayEditEntryAndContent()
Deprecated.
Because of counter-intuitive return values. Use
WGStructEntry.performChildCreationCheck() or WGStructEntry.mayEditChildPages() |
WGDocument |
WGDocument.setItem(java.lang.String name,
java.lang.Object value) |
WGDocument |
WGDocument.setItems(java.util.Map<java.lang.String,java.lang.Object> values) |
WGDocument |
WGDocument.setMeta(java.lang.String name,
java.lang.Object value) |
WGDocument |
WGDocument.setMetas(java.util.Map<java.lang.String,java.lang.Object> values) |
WGDocument |
WGDocument.setValues(java.util.Map<java.lang.String,java.lang.Object> values) |
Modifier and Type | Method and Description |
---|---|
java.util.List<WGDocument> |
WGDocumentListCache.buildDocumentList(WGDatabase db)
Rebuilds the document list from cache
The method will return null if the number of documents in the list that must be gathered
from backend exceeds the database configuration on
WGDatabase.getListCacheRebuildThreshold() |
java.lang.Class<? extends WGDocument> |
WGDatabase.DocumentCollectionHierarchy.getChildNodeType() |
java.util.List<WGDocument> |
WGSessionContext.getEditedDocuments()
Returns a list of documents that were edited in the current session and have not yet been saved
|
java.util.List<java.lang.Class<? extends WGDocument>> |
WGColumnSet.ColumnMeta.getLocations()
Returns the WGAPI documents that actually feature this metadata field
|
Modifier and Type | Method and Description |
---|---|
void |
WGSessionContext.addFetchedCore(WGDocument doc,
WGDocumentCore core)
Adds a fetched document core to the document cores list.
|
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
|
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) |
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).
|
boolean |
WGStructEntry.isDescendantOf(WGDocument doc)
Determines if this struct entry is a descendant of the given document, i.e.
|
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 |
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.
|
void |
WGArea.performRemoveCheck(boolean deepCheck,
WGDocument deletionRoot) |
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 |
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 |
WGDocumentListCache.remove(WGDocument doc) |
boolean |
WGDatabaseCore.resultIsFalse(java.lang.Object result,
WGDocument doc)
Tests, if an native expression result equals false in the native expression language.
|
boolean |
WGDatabaseCore.resultIsTrue(java.lang.Object result,
WGDocument doc)
Tests, if an native expression result equals true in the native expression language.
|
void |
WGDocument.SaveAction.run(WGDocument doc)
The action to be ran
|
void |
WGSessionContext.DocumentContext.setDocument(WGDocument document) |
void |
WGDocumentCore.setWGDocument(WGDocument doc)
Called by the WGAPI after instantiation of this document core to provide a reference to the wrapping WGDocument object.
|
void |
WGDocumentCoreWrapper.setWGDocument(WGDocument doc) |
Modifier and Type | Method and Description |
---|---|
static WGDocumentListCache |
WGDocumentListCache.buildFromDocuments(java.util.Collection<? extends WGDocument> col) |
static WGDocumentListCache |
WGDocumentListCache.buildFromDocuments(java.util.List<? extends WGDocument> col,
int offset,
int size)
Builds a document list cache from a collection containing
WGDocument objects |
WGDocumentListCache |
WGDocumentListCache.mergeWithDocuments(java.util.List<? extends WGDocument> docs,
int offset,
int size)
Creates a new cache with the entries of this collection and the entries of the given list merged
|
Constructor and Description |
---|
WGAuthorisationException(java.lang.String msg,
java.lang.String code,
WGDocument cause) |
WGAuthorisationException(java.lang.String msg,
WGDocument cause) |
WGDatabaseEvent(WGDatabase source,
int iType,
WGDocument editedDocument)
Constructor.
|
WGSessionContext.DocumentContext(WGDocument doc) |
WGStructEntryRetrievalIterator(WGDatabase db,
WGDocument parent,
java.util.Iterator<WGDocumentCore> structCores) |
Modifier and Type | Method and Description |
---|---|
WGDocumentCore |
WGFakeDatabase.createStructEntry(java.lang.Object key,
WGDocument reference,
WGContentType contentType) |
boolean |
WGFakeDatabase.moveStructEntry(WGStructEntry entry,
WGDocument newParent) |
boolean |
WGFakeDatabase.resultIsFalse(java.lang.Object result,
WGDocument doc) |
boolean |
WGFakeDatabase.resultIsTrue(java.lang.Object result,
WGDocument doc) |
void |
WGFakeDocument.setWGDocument(WGDocument doc) |
Modifier and Type | Method and Description |
---|---|
WGDocumentCore |
WGDatabaseImpl.createStructEntry(java.lang.Object key,
WGDocument reference,
WGContentType contentType) |
boolean |
WGDatabaseImpl.moveStructEntry(WGStructEntry entry,
WGDocument newParent) |
boolean |
WGDatabaseImpl.resultIsFalse(java.lang.Object result,
WGDocument doc) |
boolean |
WGDatabaseImpl.resultIsTrue(java.lang.Object result,
WGDocument doc) |
void |
WGDocumentImpl.setWGDocument(WGDocument doc) |
void |
WGDocumentImplRSS1.setWGDocument(WGDocument doc) |
Modifier and Type | Method and Description |
---|---|
WGDocumentCore |
SimpleContentSource.createStructEntry(java.lang.Object key,
WGDocument reference,
WGContentType contentType) |
boolean |
SimpleContentSource.moveStructEntry(WGStructEntry entry,
WGDocument newParent) |
boolean |
SimpleContentSource.resultIsFalse(java.lang.Object result,
WGDocument doc) |
boolean |
SimpleContentSource.resultIsTrue(java.lang.Object result,
WGDocument doc) |
void |
BeanFolder.setWGDocument(WGDocument doc) |
void |
BeanWrapper.setWGDocument(WGDocument doc) |
void |
WrappedKey.setWGDocument(WGDocument doc) |