de.innovationgate.wgpublisher.hdb

Class HDBModelParams

java.lang.Object

de.innovationgate.wgpublisher.hdb.HDBModelParams

public class HDBModelParams
extends java.lang.Object

Parameter class for HDBModel operations, collecting all possible parameters

Constructor Summary

Constructors

Constructor and Description
HDBModelParams(java.lang.String type) Deprecated. Use methods HDBModel#newCreateContentParams(String, WGContent), HDBModel.newUpdateContentParams(WGContent) or HDBModel.newDeleteContentParams(WGContent)
HDBModelParams(de.innovationgate.webgate.api.WGContent content) Deprecated. Use methods HDBModel#newCreateContentParams(String, WGContent), HDBModel.newUpdateContentParams(WGContent) or HDBModel.newDeleteContentParams(WGContent)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentClass() Returns the content class of the document on which the operation will be done
java.lang.String	getCreateContentID() Returns a content ID that should be assigned to a created content of the operation
java.lang.Object	getCustomParam() Returns a custom parameter passed to the operation
Form	getForm() Returns the WebTML form to be injected to the operation
HDBModelProcess	getProcess() Return a process to be executed on the operation
de.innovationgate.webgate.api.WGContent	getRefDocument() Returns the reference document for the operation
de.innovationgate.webgate.api.WGContentKey	getRefDocumentKey() Returns the key of the reference document for the operation
java.lang.String	getType() Returns the type of document on which the operation is performed (Values of constants TYPE_... on HDBModel)
void	setContentClass(java.lang.String contentClass) Sets the content class of the document on which the operation will be done
void	setCreateContentID(java.lang.String createContentID) Sets a content ID that should be assigned to a created content of the operation
void	setCustomParam(java.lang.Object customParam) Sets a custom parameter that is passed to the operation
void	setForm(Form form) Sets a WebTML form to be injected to the operation
void	setProcess(HDBModelProcess process) Sets a process to be executed on the operation
void	setRefDocument(de.innovationgate.webgate.api.WGContent refDocument) Sets the reference document for the operation
void	setRefDocumentKey(de.innovationgate.webgate.api.WGContentKey refDocumentKey) Sets the key of the reference document for the operation
void	setUpdateModuleProcess(de.innovationgate.webgate.api.WGDatabase db, java.lang.String moduleName) Sets a TMLScript module of the given database to be executed as process on this operation

Methods inherited from class java.lang.Object

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

Constructor Detail

HDBModelParams

public HDBModelParams(java.lang.String type)

Deprecated. Use methods HDBModel#newCreateContentParams(String, WGContent), HDBModel.newUpdateContentParams(WGContent) or HDBModel.newDeleteContentParams(WGContent)

Constructor.

Parameters:

type - Type of document to update. Use constants TYPE_... on HDBModel

HDBModelParams

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

Deprecated. Use methods HDBModel#newCreateContentParams(String, WGContent), HDBModel.newUpdateContentParams(WGContent) or HDBModel.newDeleteContentParams(WGContent)

Constructor.

Parameters:

content - Document on which the operation will be performed

Throws:

de.innovationgate.webgate.api.WGAPIException

Method Detail

getProcess

public HDBModelProcess getProcess()

Return a process to be executed on the operation

setProcess

public void setProcess(HDBModelProcess process)

Sets a process to be executed on the operation

getContentClass

public java.lang.String getContentClass()

Returns the content class of the document on which the operation will be done

setContentClass

public void setContentClass(java.lang.String contentClass)

Sets the content class of the document on which the operation will be done

getCustomParam

public java.lang.Object getCustomParam()

Returns a custom parameter passed to the operation

setCustomParam

public void setCustomParam(java.lang.Object customParam)

Sets a custom parameter that is passed to the operation

getType

public java.lang.String getType()

Returns the type of document on which the operation is performed (Values of constants TYPE_... on HDBModel)

setForm

public void setForm(Form form)

Sets a WebTML form to be injected to the operation

getForm

public Form getForm()

Returns the WebTML form to be injected to the operation

getCreateContentID

public java.lang.String getCreateContentID()

Returns a content ID that should be assigned to a created content of the operation

setCreateContentID

public void setCreateContentID(java.lang.String createContentID)

Sets a content ID that should be assigned to a created content of the operation

getRefDocument

public de.innovationgate.webgate.api.WGContent getRefDocument()

Returns the reference document for the operation

setRefDocument

public void setRefDocument(de.innovationgate.webgate.api.WGContent refDocument)
                    throws de.innovationgate.webgate.api.WGAPIException

Sets the reference document for the operation

Throws:

de.innovationgate.webgate.api.WGAPIException

getRefDocumentKey

public de.innovationgate.webgate.api.WGContentKey getRefDocumentKey()

Returns the key of the reference document for the operation

setRefDocumentKey

public void setRefDocumentKey(de.innovationgate.webgate.api.WGContentKey refDocumentKey)

Sets the key of the reference document for the operation

setUpdateModuleProcess

public void setUpdateModuleProcess(de.innovationgate.webgate.api.WGDatabase db,
                          java.lang.String moduleName)

Sets a TMLScript module of the given database to be executed as process on this operation

Parameters:

db - App containing the module

moduleName - Name of a TMLScript module to execute