de.innovationgate.wgpublisher.hdb

Class HDBModel

java.lang.Object

de.innovationgate.wgpublisher.hdb.HDBModel

All Implemented Interfaces:

de.innovationgate.webgate.api.WGDesignChangeListener

public class HDBModel
extends Object
implements de.innovationgate.webgate.api.WGDesignChangeListener

The HDBModel API

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_ON_CREATE
static String	EVENT_ON_SAVE
static String	EVENT_POST_CREATE
static String	EVENT_POST_DELETE
static String	EVENT_POST_MOVE_FROM
static String	EVENT_POST_MOVE_TO
static String	EVENT_POST_UPDATE
static String	EVENT_PRE_CREATE
static String	EVENT_PRE_DELETE
static String	EVENT_PRE_MOVE_FROM
static String	EVENT_PRE_MOVE_TO
static String	EVENT_PRE_UPDATE
static String	ITEM_CONTENT_ID
static String	ITEM_STORAGE_ID
static String	ITEM_TYPE
static String	MODEL_FILE
static String	OPTION_EXTRACLAUSE Option containing an extra HQL clause to inject to the retrieval of relation targets or sources
static String	OPTION_EXTRAPARAMS Option containing a Map of extra query parameters to give to the retrieval of relation targets or sources, parameter names as map keys, parameter values as map values
static String	OPTION_INCLUDECURRENT Determines if the currently stored target of the relation should also be included in the retrieval of valid relation targets, even if it is no longer valid
static String	PARENT_RELATION_PREFIX
static String	STORAGE_CONTENTCLASS
static String	TYPE_CONTENT
static String	TYPE_STORAGE
static Object	VERSIONING_FULL
static Object	VERSIONING_NONE

Method Summary

Modifier and Type	Method and Description
void	assignContentID(de.innovationgate.webgate.api.WGContent content, String contentId) Assings a content id to the given content.
void	close()
de.innovationgate.webgate.api.WGContent	createContent(Form form) Create a HDBModel content based on the information from a WebTML form.
de.innovationgate.webgate.api.WGContent	createContent(HDBModelParams params) Create a HDBModel content
de.innovationgate.webgate.api.WGContent	createContent(String contentClass, de.innovationgate.webgate.api.WGContent ref) Create a HDBModel content
de.innovationgate.webgate.api.WGContent	createContent(String contentClass, de.innovationgate.webgate.api.WGContent ref, Object param) Create a HDBModel content
static void	createModelObject(WGACore core, de.innovationgate.webgate.api.WGDatabase db) Creates the HDBModel object.
void	deleteContent(HDBModelParams params) Delete a HDBModel content
void	deleteContent(de.innovationgate.webgate.api.WGContent content) Delete a HDBModel content
void	designChanged(de.innovationgate.webgate.api.WGDesignChangeEvent event)
de.innovationgate.wga.common.beans.hdbmodel.ModelDefinition	getDefinition() Returns the HDBModel definition
de.innovationgate.webgate.api.WGContent	getDocument(String id) Retrieves a root storage by its storage id
de.innovationgate.webgate.api.WGContent	getDocument(String id, de.innovationgate.webgate.api.WGContent relContent) Returns a document, either a storage or content, relative to the given content or absolute if omitted.
de.innovationgate.webgate.api.WGContent	getDocumentByStructKey(Object structKey) Retrieves a document by its struct key.
static String	getID(de.innovationgate.webgate.api.WGContent content) Returns the HDB ID of the given document, the content id for contents, the storage id for storages
static HDBModel	getModel(de.innovationgate.webgate.api.WGDatabase db)
de.innovationgate.wga.common.beans.hdbmodel.Document	getModelForContent(de.innovationgate.webgate.api.WGContent content) Returns the model definition for the given document
List<de.innovationgate.wga.common.beans.hdbmodel.Document>	getModelPathForContent(de.innovationgate.webgate.api.WGContent content) Returns a complete path of model definitions for the given document, holding all definitions from root to this document top-down
List<de.innovationgate.wga.common.beans.hdbmodel.Content>	getModelsForContentClass(String contentClass) Returns all model definitions for the given content class
List<de.innovationgate.wga.common.beans.hdbmodel.Content>	getModelsForContentClass(String contentClass, de.innovationgate.webgate.api.WGContent ref, boolean forceRelative) Returns all models for the given content class whose positions are determinable from the given reference document.
de.innovationgate.webgate.api.WGAbstractResultSet	getRelationSources(de.innovationgate.webgate.api.WGContent target, String contentClass, String relation) Retrieves the source contents for a HDBModel relation that point to a given content
de.innovationgate.webgate.api.WGAbstractResultSet	getRelationSources(de.innovationgate.webgate.api.WGContent target, String contentClass, String relation, Map options) Retrieves the source contents for a HDBModel relation that point to a given content
de.innovationgate.webgate.api.WGAbstractResultSet	getRelationTargets(de.innovationgate.webgate.api.WGContent content, String contentClass, String relation) Retrieve the valid relation targets for a HDBModel relation
de.innovationgate.webgate.api.WGAbstractResultSet	getRelationTargets(de.innovationgate.webgate.api.WGContent content, String contentClass, String relation, Map options) Retrieve the valid relation targets for a HDBModel relation
static boolean	isContent(de.innovationgate.webgate.api.WGContent content) Returns if the given document is a HDBModel content
static boolean	isDocument(de.innovationgate.webgate.api.WGContent content) Returns if the given content is a HDBModel document
boolean	isModelReinitRunning() Returns if a reinit of the HDBModel in the database is currently taking place
boolean	isModelVersionChanged() Indicates if the HDBModel definition has changed since the last HDBModel reinit, so the model definition may not match the stored content in the database
static boolean	isStorage(de.innovationgate.webgate.api.WGContent content) Returns if the given document is a HDBModel storage
void	moveContent(de.innovationgate.webgate.api.WGContent content, de.innovationgate.webgate.api.WGContent ref) Move a HDBModel content
HDBModelParams	newCreateContentParams(String contentClass, de.innovationgate.webgate.api.WGContent parent) Creates a parameter object for creating a HDBModel content
HDBModelParams	newDeleteContentParams(de.innovationgate.webgate.api.WGContent content) Create parameters for deleting a HDBModel content
HDBModelParams	newUpdateContentParams(de.innovationgate.webgate.api.WGContent content) Create parameters for updating a HDBModel content
boolean	onCreate(Event event) Event method for executing necessary operations when a HDBModel content is created.
boolean	onSave(Event event) Event method for executing necessary operations when a HDBModel content is saved.
void	reduceContentEditors(de.innovationgate.webgate.api.WGContent con, List editors) Sets valid editors on a content, keeping inherited rights effective and reduce the rights additionally.
void	reinitModel() Do a complete reinitialisation of the database according to the model
void	reloadDefinition() Reload the HDBModel definition
void	setContentEditors(de.innovationgate.webgate.api.WGContent con, List contentEditors, List childEditors) Sets valid editors on a content
void	setContentReaders(de.innovationgate.webgate.api.WGContent con, List readers) Sets readers for a content document
boolean	storeForm(Form form, de.innovationgate.webgate.api.WGContent content) Stores the data of a WebTML form in into the database.
void	updateContent(Form form) Update a HDBModel content based on the information from a WebTML form.
void	updateContent(HDBModelParams params) Update a HDBModel content
void	updateContent(de.innovationgate.webgate.api.WGContent content) Update a HDBModel content
void	updateContent(de.innovationgate.webgate.api.WGContent content, HDBModelProcess process) Update a HDBModel content
void	updateContent(de.innovationgate.webgate.api.WGContent content, String tmlscriptModule) Update a HDBModel content
void	updateContent(de.innovationgate.webgate.api.WGContent content, String tmlscriptModule, Object param) Update a HDBModel content

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PARENT_RELATION_PREFIX

public static final String PARENT_RELATION_PREFIX

See Also:

Constant Field Values

STORAGE_CONTENTCLASS

public static final String STORAGE_CONTENTCLASS

See Also:

Constant Field Values

OPTION_EXTRACLAUSE

public static final String OPTION_EXTRACLAUSE

Option containing an extra HQL clause to inject to the retrieval of relation targets or sources

See Also:

Constant Field Values

OPTION_EXTRAPARAMS

public static final String OPTION_EXTRAPARAMS

Option containing a Map of extra query parameters to give to the retrieval of relation targets or sources, parameter names as map keys, parameter values as map values

See Also:

Constant Field Values

OPTION_INCLUDECURRENT

public static final String OPTION_INCLUDECURRENT

Determines if the currently stored target of the relation should also be included in the retrieval of valid relation targets, even if it is no longer valid

See Also:

Constant Field Values

EVENT_PRE_CREATE

public static final String EVENT_PRE_CREATE

See Also:

Constant Field Values

EVENT_POST_CREATE

public static final String EVENT_POST_CREATE

See Also:

Constant Field Values

EVENT_PRE_UPDATE

public static final String EVENT_PRE_UPDATE

See Also:

Constant Field Values

EVENT_POST_UPDATE

public static final String EVENT_POST_UPDATE

See Also:

Constant Field Values

EVENT_ON_CREATE

public static final String EVENT_ON_CREATE

See Also:

Constant Field Values

EVENT_ON_SAVE

public static final String EVENT_ON_SAVE

See Also:

Constant Field Values

EVENT_PRE_MOVE_FROM

public static final String EVENT_PRE_MOVE_FROM

See Also:

Constant Field Values

EVENT_PRE_MOVE_TO

public static final String EVENT_PRE_MOVE_TO

See Also:

Constant Field Values

EVENT_POST_MOVE_FROM

public static final String EVENT_POST_MOVE_FROM

See Also:

Constant Field Values

EVENT_POST_MOVE_TO

public static final String EVENT_POST_MOVE_TO

See Also:

Constant Field Values

EVENT_PRE_DELETE

public static final String EVENT_PRE_DELETE

See Also:

Constant Field Values

EVENT_POST_DELETE

public static final String EVENT_POST_DELETE

See Also:

Constant Field Values

ITEM_TYPE

public static final String ITEM_TYPE

See Also:

Constant Field Values

TYPE_STORAGE

public static final String TYPE_STORAGE

See Also:

Constant Field Values

TYPE_CONTENT

public static final String TYPE_CONTENT

See Also:

Constant Field Values

MODEL_FILE

public static final String MODEL_FILE

See Also:

Constant Field Values

ITEM_CONTENT_ID

public static final String ITEM_CONTENT_ID

See Also:

Constant Field Values

ITEM_STORAGE_ID

public static final String ITEM_STORAGE_ID

See Also:

Constant Field Values

VERSIONING_FULL

public static final Object VERSIONING_FULL

VERSIONING_NONE

public static final Object VERSIONING_NONE

Method Detail

isModelReinitRunning

public boolean isModelReinitRunning()

Returns if a reinit of the HDBModel in the database is currently taking place

getModel

public static HDBModel getModel(de.innovationgate.webgate.api.WGDatabase db)

isStorage

public static boolean isStorage(de.innovationgate.webgate.api.WGContent content)
                         throws de.innovationgate.webgate.api.WGAPIException

Returns if the given document is a HDBModel storage

Parameters:

content - The document

Throws:

de.innovationgate.webgate.api.WGAPIException

isContent

public static boolean isContent(de.innovationgate.webgate.api.WGContent content)
                         throws de.innovationgate.webgate.api.WGAPIException

Returns if the given document is a HDBModel content

Parameters:

content - The document

Throws:

de.innovationgate.webgate.api.WGAPIException

isDocument

public static boolean isDocument(de.innovationgate.webgate.api.WGContent content)
                          throws de.innovationgate.webgate.api.WGAPIException

Returns if the given content is a HDBModel document

Parameters:

content -

Throws:

de.innovationgate.webgate.api.WGAPIException

getID

public static String getID(de.innovationgate.webgate.api.WGContent content)
                    throws de.innovationgate.webgate.api.WGAPIException

Returns the HDB ID of the given document, the content id for contents, the storage id for storages

Parameters:

content - Document

Throws:

de.innovationgate.webgate.api.WGAPIException

reloadDefinition

public void reloadDefinition()

Reload the HDBModel definition

reinitModel

public void reinitModel()

Do a complete reinitialisation of the database according to the model

getModelForContent

public de.innovationgate.wga.common.beans.hdbmodel.Document getModelForContent(de.innovationgate.webgate.api.WGContent content)
                                                                        throws de.innovationgate.webgate.api.WGAPIException

Returns the model definition for the given document

Parameters:

content - The document

Throws:

de.innovationgate.webgate.api.WGAPIException

getModelPathForContent

public List<de.innovationgate.wga.common.beans.hdbmodel.Document> getModelPathForContent(de.innovationgate.webgate.api.WGContent content)
                                                                                  throws de.innovationgate.webgate.api.WGAPIException

Returns a complete path of model definitions for the given document, holding all definitions from root to this document top-down

Parameters:

content - The document

Throws:

de.innovationgate.webgate.api.WGAPIException

getModelsForContentClass

public List<de.innovationgate.wga.common.beans.hdbmodel.Content> getModelsForContentClass(String contentClass)

Returns all model definitions for the given content class

Parameters:

contentClass - The content class

getModelsForContentClass

public List<de.innovationgate.wga.common.beans.hdbmodel.Content> getModelsForContentClass(String contentClass,
                                                                                          de.innovationgate.webgate.api.WGContent ref,
                                                                                          boolean forceRelative)
                                                                                   throws de.innovationgate.webgate.api.WGAPIException

Returns all models for the given content class whose positions are determinable from the given reference document.

Parameters:

contentClass - The content class to search

ref - The reference document. Use null if you do not want any.

forceRelative - Setting to true will exclude "root models"

Returns:

A list of models matching the given description. Models with direct relationship to the reference doc come before "root models" which have no relationship to it.

Throws:

de.innovationgate.webgate.api.WGAPIException

close

public void close()

designChanged

public void designChanged(de.innovationgate.webgate.api.WGDesignChangeEvent event)

Specified by:

designChanged in interface de.innovationgate.webgate.api.WGDesignChangeListener

createModelObject

public static void createModelObject(WGACore core,
                                     de.innovationgate.webgate.api.WGDatabase db)
                              throws de.innovationgate.webgate.api.WGAPIException,
                                     NoSuchAlgorithmException,
                                     IOException

Creates the HDBModel object. Only for internal WGA use.

Parameters:

core - WGA Core

db - The HDBModel database

Throws:

de.innovationgate.webgate.api.WGAPIException

NoSuchAlgorithmException

IOException

createContent

public de.innovationgate.webgate.api.WGContent createContent(HDBModelParams params)
                                                      throws HDBModelException,
                                                             de.innovationgate.webgate.api.WGAPIException

Create a HDBModel content

Parameters:

params - Parameters for the operation

Returns:

The created content

Throws:

HDBModelException

de.innovationgate.webgate.api.WGAPIException

createContent

public de.innovationgate.webgate.api.WGContent createContent(String contentClass,
                                                             de.innovationgate.webgate.api.WGContent ref)
                                                      throws de.innovationgate.webgate.api.WGAPIException,
                                                             HDBModelException

Create a HDBModel content

Parameters:

contentClass - Content class of the content to create

ref - Reference document for the creation below which the content is to be created

Returns:

The created content

Throws:

HDBModelException

de.innovationgate.webgate.api.WGAPIException

newCreateContentParams

public HDBModelParams newCreateContentParams(String contentClass,
                                             de.innovationgate.webgate.api.WGContent parent)
                                      throws de.innovationgate.webgate.api.WGAPIException

Creates a parameter object for creating a HDBModel content

Parameters:

contentClass - The content class of the content to create

parent - Reference document for the creation below which the content is to be created

Throws:

de.innovationgate.webgate.api.WGAPIException

createContent

public de.innovationgate.webgate.api.WGContent createContent(String contentClass,
                                                             de.innovationgate.webgate.api.WGContent ref,
                                                             Object param)
                                                      throws de.innovationgate.webgate.api.WGAPIException,
                                                             HDBModelException

Create a HDBModel content

Parameters:

contentClass - Content class of the content to create

ref - Reference document for the creation below which the content is to be created

param - Custom parameter to inject to the operation

Returns:

The created content

Throws:

HDBModelException

de.innovationgate.webgate.api.WGAPIException

createContent

public de.innovationgate.webgate.api.WGContent createContent(Form form)
                                                      throws de.innovationgate.webgate.api.WGAPIException,
                                                             HDBModelException

Create a HDBModel content based on the information from a WebTML form. The form must be of form source appropriate for creating HDBModel contents and have a contentclass specified.

Parameters:

form - The form

Returns:

The created content

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

updateContent

public void updateContent(de.innovationgate.webgate.api.WGContent content)
                   throws de.innovationgate.webgate.api.WGAPIException,
                          HDBModelException

Update a HDBModel content

Parameters:

content - The content

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

newUpdateContentParams

public HDBModelParams newUpdateContentParams(de.innovationgate.webgate.api.WGContent content)
                                      throws de.innovationgate.webgate.api.WGAPIException

Create parameters for updating a HDBModel content

Parameters:

content - The content to update

Throws:

de.innovationgate.webgate.api.WGAPIException

newDeleteContentParams

public HDBModelParams newDeleteContentParams(de.innovationgate.webgate.api.WGContent content)
                                      throws de.innovationgate.webgate.api.WGAPIException

Create parameters for deleting a HDBModel content

Parameters:

content - The content to delete

Throws:

de.innovationgate.webgate.api.WGAPIException

updateContent

public void updateContent(HDBModelParams params)
                   throws de.innovationgate.webgate.api.WGAPIException,
                          HDBModelException

Update a HDBModel content

Parameters:

params - Parameters for the operation

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

updateContent

public void updateContent(de.innovationgate.webgate.api.WGContent content,
                          HDBModelProcess process)
                   throws de.innovationgate.webgate.api.WGAPIException,
                          HDBModelException

Update a HDBModel content

Parameters:

content - The content to update

process - A process to be executed on the update

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

updateContent

public void updateContent(de.innovationgate.webgate.api.WGContent content,
                          String tmlscriptModule)
                   throws de.innovationgate.webgate.api.WGAPIException,
                          HDBModelException

Update a HDBModel content

Parameters:

content - The content to update

tmlscriptModule - Name of a TMLScript module from the design of the HDBModel database to execute as process on the update

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

updateContent

public void updateContent(de.innovationgate.webgate.api.WGContent content,
                          String tmlscriptModule,
                          Object param)
                   throws de.innovationgate.webgate.api.WGAPIException,
                          HDBModelException

Update a HDBModel content

Parameters:

content - The content to update

tmlscriptModule - Name of a TMLScript module from the design of the HDBModel database to execute as process on the update

param - A custom parameter to inject to the operation

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

updateContent

public void updateContent(Form form)
                   throws de.innovationgate.webgate.api.WGAPIException,
                          HDBModelException

Update a HDBModel content based on the information from a WebTML form. The form must be of form source appropriate for updating HDBModel contents and have this content as target context.

Parameters:

form - The form

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

deleteContent

public void deleteContent(de.innovationgate.webgate.api.WGContent content)
                   throws de.innovationgate.webgate.api.WGAPIException

Delete a HDBModel content

Parameters:

content - The content to delete

Throws:

de.innovationgate.webgate.api.WGAPIException

deleteContent

public void deleteContent(HDBModelParams params)
                   throws de.innovationgate.webgate.api.WGAPIException

Delete a HDBModel content

Parameters:

params - Parameters for the operation

Throws:

de.innovationgate.webgate.api.WGAPIException

moveContent

public void moveContent(de.innovationgate.webgate.api.WGContent content,
                        de.innovationgate.webgate.api.WGContent ref)
                 throws de.innovationgate.webgate.api.WGAPIException,
                        HDBModelException

Move a HDBModel content

Parameters:

content - The content to move

ref - The new parent of the content

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

getRelationTargets

public de.innovationgate.webgate.api.WGAbstractResultSet getRelationTargets(de.innovationgate.webgate.api.WGContent content,
                                                                            String contentClass,
                                                                            String relation)
                                                                     throws de.innovationgate.webgate.api.WGException,
                                                                            HDBModelException

Retrieve the valid relation targets for a HDBModel relation

Parameters:

content - The content having the relation or a parent content below which the model of this content is defined (in case the content does not yet exist)

contentClass - The content class of the content for which the relation is defined

relation - Name of the relation

Returns:

Result set of all valid relation targets

Throws:

de.innovationgate.webgate.api.WGException

HDBModelException

getRelationTargets

public de.innovationgate.webgate.api.WGAbstractResultSet getRelationTargets(de.innovationgate.webgate.api.WGContent content,
                                                                            String contentClass,
                                                                            String relation,
                                                                            Map options)
                                                                     throws de.innovationgate.webgate.api.WGException,
                                                                            HDBModelException

Retrieve the valid relation targets for a HDBModel relation

Parameters:

content - The content having the relation or a parent content below which the model of this content is defined (in case the content does not yet exist)

contentClass - The content class of the content for which the relation is defined

relation - Name of the relation

options - Custom options for the retrieval. Use constants OPTION_... from this class or QUERYOPTION_... from WGDatabase

Returns:

Result set of all valid relation targets

Throws:

de.innovationgate.webgate.api.WGException

HDBModelException

getRelationSources

public de.innovationgate.webgate.api.WGAbstractResultSet getRelationSources(de.innovationgate.webgate.api.WGContent target,
                                                                            String contentClass,
                                                                            String relation,
                                                                            Map options)
                                                                     throws de.innovationgate.webgate.api.WGAPIException,
                                                                            HDBModelException

Retrieves the source contents for a HDBModel relation that point to a given content

Parameters:

target - The content to which the relations point

contentClass - The content class of the source contents to return. Specify null to return contents of all content classes.

relation - The name of the relation that should point to the target content

options - Custom options for the retrieval. Use constants OPTION_... from this class or QUERYOPTION_... from WGDatabase

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

getRelationSources

public de.innovationgate.webgate.api.WGAbstractResultSet getRelationSources(de.innovationgate.webgate.api.WGContent target,
                                                                            String contentClass,
                                                                            String relation)
                                                                     throws de.innovationgate.webgate.api.WGAPIException,
                                                                            HDBModelException

Retrieves the source contents for a HDBModel relation that point to a given content

Parameters:

target - The content to which the relations point

contentClass - The content class of the source contents to return. Specify null to return contents of all content classes.

relation - The name of the relation that should point to the target content

Throws:

de.innovationgate.webgate.api.WGAPIException

HDBModelException

assignContentID

public void assignContentID(de.innovationgate.webgate.api.WGContent content,
                            String contentId)
                     throws de.innovationgate.webgate.api.WGAPIException

Assings a content id to the given content.

Parameters:

content - The content

contentId - The content ID

Throws:

de.innovationgate.webgate.api.WGAPIException

onCreate

public boolean onCreate(Event event)
                 throws Throwable

Event method for executing necessary operations when a HDBModel content is created. Only for internal WGA use.

Parameters:

event - The HDBModel operation event

Returns:

False if the event was cancelled

Throws:

Throwable

onSave

public boolean onSave(Event event)
               throws Throwable

Event method for executing necessary operations when a HDBModel content is saved. Only for internal WGA use.

Parameters:

event - The HDBModel operation event

Returns:

False if the event was cancelled

Throws:

Throwable

getDefinition

public de.innovationgate.wga.common.beans.hdbmodel.ModelDefinition getDefinition()

Returns the HDBModel definition

reduceContentEditors

public void reduceContentEditors(de.innovationgate.webgate.api.WGContent con,
                                 List editors)
                          throws de.innovationgate.webgate.api.WGAPIException

Sets valid editors on a content, keeping inherited rights effective and reduce the rights additionally. A content with whose valid editors are set with this methods can only be edited by users that are contained in the editors list on this document AND the editors list of the parent document.

Parameters:

con - The content

editors - The valid editors (user names, groups or roles) of this content and its subcontents

Throws:

de.innovationgate.webgate.api.WGAPIException

setContentEditors

public void setContentEditors(de.innovationgate.webgate.api.WGContent con,
                              List contentEditors,
                              List childEditors)
                       throws de.innovationgate.webgate.api.WGAPIException

Sets valid editors on a content

Parameters:

con - The content

contentEditors - The valid editors (user names, groups or roles) of this content

childEditors - The valid editors (user names, groups or roles) for child contents of this content

Throws:

de.innovationgate.webgate.api.WGAPIException

setContentReaders

public void setContentReaders(de.innovationgate.webgate.api.WGContent con,
                              List readers)
                       throws de.innovationgate.webgate.api.WGAPIException

Sets readers for a content document

Parameters:

con - The content document

readers - The readers (user names, groups or roles) of this content

Throws:

de.innovationgate.webgate.api.WGAPIException

storeForm

public boolean storeForm(Form form,
                         de.innovationgate.webgate.api.WGContent content)
                  throws WGAServerException,
                         de.innovationgate.webgate.api.WGAPIException

Stores the data of a WebTML form in into the database. The form source decides if a new HDBModel content is created or an existing is updated.

Parameters:

form - The form

content - Either the content to update or the reference content below which a new content is to be created.

Returns:

False if the saving was cancelled

Throws:

WGAServerException

de.innovationgate.webgate.api.WGAPIException

getDocument

public de.innovationgate.webgate.api.WGContent getDocument(String id)
                                                    throws de.innovationgate.webgate.api.WGAPIException

Retrieves a root storage by its storage id

Parameters:

id - The storage id

Throws:

de.innovationgate.webgate.api.WGAPIException

getDocument

public de.innovationgate.webgate.api.WGContent getDocument(String id,
                                                           de.innovationgate.webgate.api.WGContent relContent)
                                                    throws de.innovationgate.webgate.api.WGAPIException

Returns a document, either a storage or content, relative to the given content or absolute if omitted. This will only fetch released contents.

Parameters:

id - The document id, either storage or content id

relContent - The parent storage/content of the document to fetch. Specify null to retrieve root storages.

Returns:

The storage of the given Id

Throws:

de.innovationgate.webgate.api.WGAPIException

getDocumentByStructKey

public de.innovationgate.webgate.api.WGContent getDocumentByStructKey(Object structKey)
                                                               throws de.innovationgate.webgate.api.WGAPIException

Retrieves a document by its struct key. This will fetch the struct entry and automatically choose the most relevant content. This will also respect contents in draft or workflow state.

Parameters:

structKey - The struct key

Returns:

The document, either content or storage, or null if not found.

Throws:

de.innovationgate.webgate.api.WGAPIException

isModelVersionChanged

public boolean isModelVersionChanged()

Indicates if the HDBModel definition has changed since the last HDBModel reinit, so the model definition may not match the stored content in the database