Package | Description |
---|---|
de.innovationgate.webgate.api |
Basic functionality of the WGAPI including most of the database-independent functionality.
|
de.innovationgate.webgate.api.workflow |
Workflow interfaces of the WGAPI including a database-independent workflow implementation, the "Straight Workflow".
|
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
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.
|
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.
|
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.
|
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
|
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
|
WGContent |
WGDatabase.getAnyContentByName(java.lang.String name)
Returns a content with the given name in any language.
|
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. |
WGContent |
WGContentEvent.getContent()
Retrieves and returns the content document that has changed.
|
WGContent |
WGHierarchicalDatabaseEvent.getContent()
returns the created, updated or deleted content
will be 'null' on the following events
- preCreateContent
- postDeleteContent
|
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.
|
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.
|
WGContent |
WGDatabase.getContentByName(java.lang.String strName,
java.lang.String strLanguage)
Retrieves a content by it's unique name.
|
WGContent |
WGHierarchicalDatabase.getDummyContent()
Returns a dummy content object for the current database in the language that the HDB uses
|
WGContent |
WGDatabase.getDummyContent(java.lang.String language)
Retrieves a dummy content object.
|
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.
|
WGContent |
WGHierarchicalDatabaseEvent.getListenerContent()
returns the storage or content the listener was registered on
|
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.
|
WGContent |
WGContentNavigator.getNextSibling(WGContent relContent)
Gets the next siblings content with the same language.
|
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
|
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 |
WGHierarchicalDatabaseEvent.getParentContent()
returns the parent content or storage of the created, updated or deleted content
|
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.
|
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.
|
WGContent |
WGContentNavigator.getPreviousSibling(WGContent relContent)
Gets the previous siblings content with the same language.
|
WGContent |
WGContent.getRelation(java.lang.String strName)
Retrieves the target content document of the given content relation
|
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.
|
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
|
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.
|
WGContent |
WGHierarchicalDatabase.getStorage(java.lang.String uid)
returns the storage with the given uid
|
WGContent |
WGRelationData.getTargetContent()
Retrieves the current target content of this relation
|
WGContent |
WGHierarchicalDatabaseEvent.getTargetParentContent()
Returns the target content in move operations
|
WGContent |
WGContentIterator.next() |
WGContent |
WGContentNavigator.Iterator.next() |
WGContent |
WGContent.removeRelation(java.lang.String name)
Removes a content relation
|
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
|
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.
|
WGContent |
WGContent.setRelation(WGRelationData address)
Sets a content relation with the given data
|
WGContent |
WGContent.setTitle(java.lang.String title)
Sets the title of this content document.
|
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
|
Modifier and Type | Method and Description |
---|---|
java.util.List<WGContent> |
WGContentNavigator.collectRelevantContents(WGStructEntryList siblings)
Given a list of struct entry siblings this method retrieves the relevant contents for all siblings.
|
java.util.Iterator<WGContent> |
WGDatabase.getAllContent()
Returns an Iterator iterating over all content documents in this database
does not include archived documents
|
java.util.Map<java.lang.String,WGContent> |
WGStructEntry.ContentSet.getAllContent()
Returns all ACTIVE content for the struct entry (excluding archived ones), mapped by a string "language.version"
|
java.util.Iterator<WGContent> |
WGDatabase.getAllContent(boolean includeArchived)
Returns an Iterator iterating over all content documents in this database
|
java.util.Map<java.lang.String,WGContent> |
WGStructEntry.ContentSet.getArchivedContent()
Returns the archived content for the struct entry, mapped by a string "language.version"
|
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.
|
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<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
|
java.util.Map<java.lang.String,WGContent> |
WGStructEntry.ContentSet.getReleasedContent()
Returns the released content for the struct entry, mapped by the language code
|
de.innovationgate.utils.SkippingIterator<WGContent> |
WGResultSet.getResultIterator()
Returns an iterator iterating over the results
|
de.innovationgate.utils.SkippingIterator<WGContent> |
WGStandardResultSet.getResultIterator() |
java.util.List<WGContent> |
WGContent.getSiblingContents()
Collects all released contents of identical language on sibling struct entries (including the current one)
|
java.util.Iterator<WGContent> |
WGAbstractResultSet.iterator() |
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
java.lang.String |
WGHierarchicalDatabase.assignContentUID(WGContent con,
java.lang.String id)
Issues an UID to a content document.
|
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.
|
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.
|
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 |
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 |
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.
|
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 |
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(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) |
void |
WGHierarchicalDatabase.deleteContent(WGContent content)
deletes the given content
|
void |
WGHierarchicalDatabase.deleteContent(WGContent content,
java.lang.Object parameter)
deletes the given content
|
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. |
java.lang.Integer |
WGContentNavigator.getContentLevel(WGContent relContent)
Retrieves the hierarchical level of a content document.
|
java.lang.String |
WGHierarchicalDatabase.getKey(WGContent content)
returns a db wide unique key for the given content
|
WGContentList |
WGContentNavigator.getLanguagesContent(WGContent relContent,
boolean includeThisOne)
Returns all available languages for the the given content as content list.
|
WGContent |
WGContentNavigator.getNextSibling(WGContent relContent)
Gets the next siblings content with the same language.
|
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
|
WGContent |
WGContentNavigator.getParentContent(WGContent relContent)
Gets the parent content to the given content with the same language.
|
WGContent |
WGContentNavigator.getPreviousSibling(WGContent relContent)
Gets the previous siblings content with the same language.
|
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
|
WGContent |
WGContentNavigator.getRootContent(WGContent relContent)
Returns the root content for a given content in the same language
|
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.
|
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
|
boolean |
WGContentNavigator.hasContentChildren(WGContent relContent)
Returns, if the given context has released child contexts in the same language.
|
boolean |
WGHierarchicalDatabase.isStorage(WGContent content)
Determines if the given content document is a HDB storage
|
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.
|
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
|
void |
WGHierarchicalDatabase.removeListener(WGContent content)
removes the stored listener reference from the given storage or content
|
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 |
WGHierarchicalDatabase.setListener(WGContent content,
java.lang.String moduleOrClassname)
sets the given module (tmlscriptmodule) or classname (implementation of WGHierarchicalContentListener)
on the given storage or content
|
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.
|
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
|
void |
WGPageVisitor.visit(WGContent content)
Visitor on content documents
|
Modifier and Type | Method and Description |
---|---|
static WGContentList |
WGContentList.create(java.util.Collection<WGContent> col)
Creates a content list object based on a given collection of content objects.
|
Constructor and Description |
---|
WGStructEntry.ContentSet(java.util.List<WGContent> contents) |
Modifier and Type | Method and Description |
---|---|
WGContent |
WGWorkflowEvent.getContent()
The content, for which the event was triggered
|
Modifier and Type | Method and Description |
---|---|
WGWorkflow |
WGWorkflowEngine.getWorkflow(WGContent content)
Creates a workflow object for the given content
|
WGWorkflow |
WGDefaultWorkflowEngine.getWorkflow(WGContent content) |
Constructor and Description |
---|
WGWorkflowEvent(int type,
WGContent content,
java.lang.Object mailBody)
Constructor.
|