Package com.groiss.dms

Interface DMSForm

All Superinterfaces:

DMSObject, HasLog, HasOwner, HasPermissionList, HasVersionId, KeyValuePair<String,String>, OptimisticLocking, Persistent, Serializable

All Known Subinterfaces:

DMSDocForm, DMSFolderForm, DMSNote, DMSWebLink

public interface DMSForm
extends DMSObject, HasVersionId

The base interface for all forms in @enterprise DMS

Field Summary

Fields inherited from interface com.groiss.store.Persistent

emptyKeys

Method Summary

Modifier and Type	Method	Description
<T> T	getField(String fieldName)	Returns the value of the specified field
Class<?>	getFieldType(String fieldName)	Returns the class of the specified field
FormType	getFormType()	Returns the form type of this form
MultiMap<String,Long>	getSubforms()	Returns a multi-map mapping subform-ids to oids of subforms.
boolean	hasField(String fieldName)	Returns if the form has a field with the specified name
void	setActivityContext()	Set the context for versioning to the current context of the wf-engine.
void	setActivityContext(ActivityInstance ai)	Set the context for versioning to the given activity instance.
void	setField(String fieldName, Object value)	Sets the value of the specified field

Methods inherited from interface com.groiss.dms.DMSObject

attachNote, getChangedAt, getChangedBy, getCreatedAt, getCreatedBy, getName, getTypeName, hasAttachedNotes, hasVersions, listAttachedNotes, listVersions, makeCopy, makeVersion, removeNote, setName

Methods inherited from interface com.groiss.org.HasOwner

getOwner

Methods inherited from interface com.groiss.org.HasPermissionList

getDefaultOrgUnit, getPermissionList, setPermissionList

Methods inherited from interface com.groiss.org.HasVersionId

getVersionId, setVersionId

Methods inherited from interface com.groiss.store.OptimisticLocking

getTransactionId, increaseTransactionId, setTransactionId

Methods inherited from interface com.groiss.store.Persistent

afterDelete, afterInsert, afterRead, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, dbFields, getKey, getKeys, getLocalClassName, getLocalObjectName, getOid, getStore, getTableName, getValue, isFilled, isValid, setFilled, setOid, setOid, toListString

Method Details

hasField

boolean hasField(String fieldName)

Returns if the form has a field with the specified name

Parameters:

fieldName - the name of the field to investigate

Returns:

true if such a field exists, false otherwise

getField

<T> T getField(String fieldName)

Returns the value of the specified field

Parameters:

fieldName - the name of the field which value is wanted

getFieldType

Class<?> getFieldType(String fieldName)

Returns the class of the specified field

Parameters:

fieldName - the name of the field which value is wanted

Returns:

the class of the specified field

setField

void setField(String fieldName,
 Object value)

Sets the value of the specified field

Parameters:

fieldName - the name of the field

value - the value for the field

getFormType

FormType getFormType()

Returns the form type of this form

setActivityContext

void setActivityContext(ActivityInstance ai)

Set the context for versioning to the given activity instance.

setActivityContext

void setActivityContext()

Set the context for versioning to the current context of the wf-engine. The call is equivalent to setActivityContext(WfEngine.getInstance().getContext()).

getSubforms

MultiMap<String,Long> getSubforms()

Returns a multi-map mapping subform-ids to oids of subforms. This map is only filled, if the form is a version read from a log entry.

Returns:

a multi map