Class VorgangAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<Vorgang>

de.xima.fc.api.entity.VorgangAPI

public class VorgangAPI
extends AEntityAPI<Vorgang>

API class for manipulation of Vorgang entities.

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from class AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
VorgangAPI()

Method Summary

Modifier and Type	Method	Description
IExclusiveFormRecordLockResult	acquireExclusiveFormRecordLock(UserContext uc, IBasicFormRecordRequestData req)	Acquires an exclusive lock on the form record.
Vorgang	addAttachment(UserContext uc, Vorgang vorgang, Attachment attachment)	Method for adding a attachment to a Vorgang.
Vorgang	addSubmission(UserContext uc, Vorgang formRecord, IUser user, EFormRecordSubmitContext submitContext, FrontendServer submitFrontendServer, String submitServerBaseUrl, String formData, boolean newDataEntry)	Deprecated. use addSubmission(UserContext, Vorgang, IUser, EFormRecordSubmitContext, FrontendServer, String, Locale, String, boolean) instead.
Vorgang	addSubmission(UserContext uc, Vorgang formRecord, IUser user, EFormRecordSubmitContext submitContext, FrontendServer submitFrontendServer, String submitServerBaseUrl, Locale submitLocale, String formData, boolean newDataEntry)	Adds a new submission to the form record.
int	bulkDelete(UserContext uc, List<Long> formRecordIds)	Bulk deletes all form records with the given IDs iff the authenticated user given by the user context has permission to access the form records and the form records can be deleted (the state allows deletion).
int	bulkMarkRead(UserContext uc, List<Long> formRecordIds, boolean read)	Bulk updates the 'read' value of all form records with the given IDs to the given 'read' value iff the authenticated user given by the user context has permission to access the form records.
int	bulkMove(UserContext uc, Set<Long> formRecordIds, Postfach inbox)	Bulk moves all form records with the given IDs to the given inbox iff the authenticated user given by the user context has permission to access the form records.
Vorgang	changeStatusChangedReadFlag(UserContext uc, Vorgang process, boolean read)
Vorgang	correctStatus(UserContext uc, Vorgang formRecord, Status targetState, Benutzer user)	Deprecated. The old workflow is deprecated, use method for the new workflow.
Vorgang	correctStatus(UserContext uc, Vorgang formRecord, Status targetState, IUser user)	Deprecated. The old workflow is deprecated, use method for the new workflow.
List<Vorgang>	getAllByBenutzer(UserContext uc, Benutzer benutzer)	Deprecated.
List<Vorgang>	getAllByPostfach(UserContext uc, Postfach postfach)	Method for determining all Vorgang of a Postfach.
List<Vorgang>	getByUser(UserContext uc, IUser user)
PagedResult<Vorgang>	getByUser(UserContext uc, IUser user, int page, int pageSize, int offset)
Vorgang	getByUuidAndUser(UserContext uc, UUID uuid, IUser user)
List<Vorgang>	getChildren(UserContext uc, Vorgang formRecord)
Map<String,String>	getCustomAttributes(UserContext uc, Vorgang formRecord)	Returns the custom attributes of a form record.
Map<String,String>	getCustomData(UserContext uc, Vorgang formRecord)	Returns the Vorgang.getCustomData() () custom data} of a form record.
DetailedFormRecordDTO	getDetailsByUuidAndUser(UserContext uc, UUID uuid, IUser user, Locale locale)
List<IFormRecordBaseData>	getExtendedFormRecordBaseData(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType, Projekt project, Postfach... inboxes)
IFormRecordBaseData	getExtendedFormRecordBaseData(UserContext uc, Long processId, EProjectSpecificDBTable tableType, Projekt project, Postfach... inboxes)
List<IFormRecordBaseData>	getFormRecordBaseData(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm)	Gets the form record base data for the given query
IFormRecordBaseData	getFormRecordBaseData(UserContext uc, Long processId)
IFormRecordDoiInitData	getFormRecordDoiInitData(UserContext uc, Vorgang formRecord)	Gets the data that was used to initialize the Double opt-in of the given form record
IFormRecordReviewData	getFormRecordReviewData(UserContext uc, IInboxFormRecordRequest inboxRequest)	Gets the form record review data for a given process id
PagedResult<BaseFormRecordDTO>	getFormRecordsPage(UserContext uc, PageQuery page, FormRecordsQuery query, boolean skipCount)
List<IFormRecordUploadElementData>	getFormRecordUploadElementData(UserContext uc, IInboxFormRecordUploadElementDataRequest request)	Gets the upload element data for a given form record.
Vorgang	getParent(UserContext uc, Vorgang formRecord)
PagedResult<EndUserStateHistoryEntryDTO>	getStateHistoryEntries(UserContext uc, PageQuery page, FormRecordHistoryEntriesPageQuery filter)
Map<Long,Integer>	getUnreadChatCounts(UserContext uc, IUser user, Set<Long> formRecordIds)
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt project, de.xima.cmn.criteria.QueryCriteriaManager qcm)	Deprecated. use getVorgaengeData(UserContext, Projekt, QueryCriteriaManager, EProjectSpecificDBTable)
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt project, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)	Method for determining of process data by a Projekt.
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt project, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType, Postfach... inboxes)	Method for determining of process data by a project and inboxes.
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt project, Postfach inbox, de.xima.cmn.criteria.QueryCriteriaManager qcm)	Deprecated. use getVorgaengeData(UserContext, Projekt, Postfach, QueryCriteriaManager, EProjectSpecificDBTable)
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt project, Postfach inbox, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)	Method for determining of process data by a project and a inbox.
long	getVorgaengeDataTotalCount(UserContext uc, Projekt project, de.xima.cmn.criteria.QueryCriteriaManager qcm)	Deprecated. use getVorgaengeDataTotalCount(UserContext, Projekt, QueryCriteriaManager, EProjectSpecificDBTable)
long	getVorgaengeDataTotalCount(UserContext uc, Projekt project, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)	Method for determining the total number of process data of the processes of a Projekt.
long	getVorgaengeDataTotalCount(UserContext uc, Projekt project, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType, Postfach... inboxes)	Method for determining the total number of process data of the processes of a Projekt and a Postfach.
long	getVorgaengeDataTotalCount(UserContext uc, Projekt project, Postfach inbox, de.xima.cmn.criteria.QueryCriteriaManager qcm)	Deprecated. use getVorgaengeDataTotalCount(UserContext, Projekt, Postfach, QueryCriteriaManager, EProjectSpecificDBTable)
long	getVorgaengeDataTotalCount(UserContext uc, Projekt project, Postfach inbox, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)	Method for determining the total number of process data of the processes of a Projekt and a Postfach.
Vorgang	getVorgangBy(UserContext uc, Projekt projekt, String vorgangProzessID)	Method for determining a Vorgang by the process ID and the Projekt.
Vorgang	getVorgangBy(UserContext uc, String vorgangProzessID)	Method for determining a Vorgang by the process ID.
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, Projekt project, Vorgang v, de.xima.cmn.criteria.QueryCriteriaManager qcm)	Deprecated. use getVorgangsData(UserContext, Projekt, Vorgang, QueryCriteriaManager, EProjectSpecificDBTable)
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, Projekt project, Vorgang v, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)	Method for determining of process data of a concrete Vorgang of a Projekt.
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, String prozessId, de.xima.cmn.criteria.QueryCriteriaManager qcm)	Deprecated. use getVorgangsData(UserContext, String, QueryCriteriaManager, EProjectSpecificDBTable)
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, String prozessId, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)	Method for determining of process data of a concrete Vorgang by a process ID.
IExclusiveFormRecordLockResult	releaseExclusiveFormRecordLock(UserContext uc, IBasicFormRecordRequestData req)	Releases an exclusive lock on the form record.
ISendMessageResponse	sendMessage(UserContext uc, ISendMessageRequest messageRequest)

Methods inherited from class AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update

Methods inherited from class ASubAPI

getHandlerProvider

Methods inherited from class Object

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

Constructor Details

VorgangAPI

public VorgangAPI()

Method Details

getByUuidAndUser

public Vorgang getByUuidAndUser(UserContext uc,
 UUID uuid,
 IUser user)

Since:

8.2.0

See Also:

• IVorgangHandler.getByUuidAndUser(UserContext, UUID, IUser)

getDetailsByUuidAndUser

public DetailedFormRecordDTO getDetailsByUuidAndUser(UserContext uc,
 UUID uuid,
 IUser user,
 Locale locale)

Since:

8.2.0

See Also:

• IVorgangHandler.getDetailsByUuidAndUser(UserContext, UUID, IUser, Locale)

getByUser

public List<Vorgang> getByUser(UserContext uc,
 IUser user)

Since:

8.2.0

See Also:

• IVorgangHandler.getByUser(UserContext, IUser)

getByUser

public PagedResult<Vorgang> getByUser(UserContext uc,
 IUser user,
 int page,
 int pageSize,
 int offset)

Since:

8.2.0

See Also:

• IVorgangHandler.getByUser(UserContext, IUser, int, int, int)

getFormRecordsPage

public PagedResult<BaseFormRecordDTO> getFormRecordsPage(UserContext uc,
 PageQuery page,
 FormRecordsQuery query,
 boolean skipCount)

Since:

8.4.0

See Also:

• IVorgangHandler.getFormRecordsPage(UserContext, PageQuery, FormRecordsQuery, boolean)

getStateHistoryEntries

public PagedResult<EndUserStateHistoryEntryDTO> getStateHistoryEntries(UserContext uc,
 PageQuery page,
 FormRecordHistoryEntriesPageQuery filter)

Since:

8.4.0

See Also:

• IVorgangHandler.getStateHistoryEntries(UserContext, PageQuery, FormRecordHistoryEntriesPageQuery)

getUnreadChatCounts

public Map<Long,Integer> getUnreadChatCounts(UserContext uc,
 IUser user,
 Set<Long> formRecordIds)

Since:

8.4.0

See Also:

• IVorgangHandler.getUnreadChatCounts(UserContext, IUser, Set)

getVorgangBy

public Vorgang getVorgangBy(UserContext uc,
 String vorgangProzessID)

Method for determining a Vorgang by the process ID.

Parameters:

uc - UserContext the user context in which the action is to be performed.

vorgangProzessID - String the process ID of the Vorgang.

Returns:

Vorgang the searched process.

Since:

2.4.3

getVorgangBy

public Vorgang getVorgangBy(UserContext uc,
 Projekt projekt,
 String vorgangProzessID)

Method for determining a Vorgang by the process ID and the Projekt.

Parameters:

uc - UserContext the user context in which the action is to be performed.

projekt - Projekt of the searched Vorgang.

vorgangProzessID - String the process ID of the Vorgang.

Returns:

Vorgang the searched process.

Since:

2.4.3

addAttachment

public Vorgang addAttachment(UserContext uc,
 Vorgang vorgang,
 Attachment attachment)

Method for adding a attachment to a Vorgang.

Parameters:

uc - UserContext the user context in which the action is to be performed.

vorgang - the Vorgang, to which the attachment should be added.

attachment - Attachment the one to add.

Returns:

Vorgang, to which the attachment was added.

addSubmission

@Deprecated
public Vorgang addSubmission(UserContext uc,
 Vorgang formRecord,
 IUser user,
 EFormRecordSubmitContext submitContext,
 @Nullable
 FrontendServer submitFrontendServer,
 String submitServerBaseUrl,
 String formData,
 boolean newDataEntry)

Deprecated.

use addSubmission(UserContext, Vorgang, IUser, EFormRecordSubmitContext, FrontendServer, String, Locale, String, boolean) instead.

Adds a new submission to the form record.

Parameters:

uc - The user context with the user who initiated this action.

formRecord - The form record to which the submission should be added.

user - The user who submitted the form record.

submitContext - The context in which the form record was submitted.

submitFrontendServer - The frontend server that received the submission.

submitServerBaseUrl - The base URL of the server that received the submission.

formData - The data of the submission.

newDataEntry - Whether this submission should be stored as a new data entry.

Returns:

The updated form record with the added submission.

Since:

8.2.0

addSubmission

public Vorgang addSubmission(UserContext uc,
 Vorgang formRecord,
 IUser user,
 EFormRecordSubmitContext submitContext,
 @Nullable
 FrontendServer submitFrontendServer,
 String submitServerBaseUrl,
 Locale submitLocale,
 String formData,
 boolean newDataEntry)

Adds a new submission to the form record.

Parameters:

uc - The user context with the user who initiated this action.

formRecord - The form record to which the submission should be added.

user - The user who submitted the form record.

submitContext - The context in which the form record was submitted.

submitFrontendServer - The frontend server that received the submission.

submitServerBaseUrl - The base URL of the server that received the submission.

submitLocale - The locale of the submission.

formData - The data of the submission.

newDataEntry - Whether this submission should be stored as a new data entry.

Returns:

The updated form record with the added submission.

Since:

8.4.0

getParent

@Nullable
public Vorgang getParent(UserContext uc,
 Vorgang formRecord)

Parameters:

uc - The user context for the user who initiated this query.

formRecord - Form record for which to find the parent.

Returns:

The parent form record of the given form record, or null if no parent exists.

getChildren

public List<Vorgang> getChildren(UserContext uc,
 Vorgang formRecord)

Parameters:

uc - The user context for the user who initiated this query.

formRecord - Form record for which to find the parent.

Returns:

All children of the given form record, or an empty list if no children exist.

getAllByPostfach

public List<Vorgang> getAllByPostfach(UserContext uc,
 Postfach postfach)

Method for determining all Vorgang of a Postfach.

Parameters:

uc - UserContext the user context in which the action is to be performed.

postfach - Postfach, whose processes are to be determined.

Returns:

List of Vorgang.

Since:

2.4.5

getVorgaengeData

public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
 Projekt project,
 Postfach inbox,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType)

Method for determining of process data by a project and a inbox.

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt the processes are assigned.

inbox - the Postfach in which the processes lie.

qcm - QueryCriteriaManager with specific filter parameters.

tableType - EProjectSpecificDBTable specifies from which table the data should be determined. If the EProjectSpecificDBTable.DATA_INBOX table type is selected, the inbox parameter can be set to null.

Returns:

List with generic objects of process data.

Since:

4.3.2

getVorgaengeData

public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
 Projekt project,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType,
 Postfach... inboxes)

Method for determining of process data by a project and inboxes.

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt the processes are assigned.

qcm - QueryCriteriaManager with specific filter parameters.

tableType - EProjectSpecificDBTable specifies from which table the data should be determined. If the EProjectSpecificDBTable.DATA_INBOX table type is selected, the inbox parameter can be set to null.

inboxes - the array of Postfach in which the processes lie.

Returns:

List with generic objects of process data.

Since:

4.3.2

getVorgaengeData

public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
 Projekt project,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType)

Method for determining of process data by a Projekt.

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt the processes are assigned.

qcm - QueryCriteriaManager with specific filter parameters.

tableType - EProjectSpecificDBTable specifies from which table the data should be determined.

Returns:

List with generic objects of process data.

Since:

4.3.2

getVorgangsData

public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc,
 String prozessId,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType)

Method for determining of process data of a concrete Vorgang by a process ID.

Parameters:

uc - UserContext the user context in which the action is to be performed.

prozessId - String the process ID of the process which data should be loaded.

qcm - QueryCriteriaManager with specific filter parameters.

tableType - EProjectSpecificDBTable specifies from which table the data should be determined.

Returns:

generic object of process data.

Since:

4.3.2

getVorgangsData

public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc,
 Projekt project,
 Vorgang v,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType)

Method for determining of process data of a concrete Vorgang of a Projekt.

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt to which the process belongs.

v - the Vorgang whose data is to be determined.

qcm - QueryCriteriaManager with specific filter parameters.

tableType - EProjectSpecificDBTable specifies from which table the data should be determined.

Returns:

generic object of process data or null.

Since:

4.3.2

getVorgaengeDataTotalCount

public long getVorgaengeDataTotalCount(UserContext uc,
 Projekt project,
 Postfach inbox,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType)

Method for determining the total number of process data of the processes of a Projekt and a Postfach.

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt to which the processes belongs.

inbox - the Postfach in which the processes lie.

qcm - QueryCriteriaManager with specific filter parameters.

tableType - EProjectSpecificDBTable specifies from which table the data should be determined. If the EProjectSpecificDBTable.DATA_INBOX table type is selected, the inbox parameter can be set to null.

Returns:

Number of elements.

Since:

4.3.2

getVorgaengeDataTotalCount

public long getVorgaengeDataTotalCount(UserContext uc,
 Projekt project,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType,
 Postfach... inboxes)

Method for determining the total number of process data of the processes of a Projekt and a Postfach.

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt to which the processes belongs.

qcm - QueryCriteriaManager with specific filter parameters.

tableType - EProjectSpecificDBTable specifies from which table the data should be determined. If the EProjectSpecificDBTable.DATA_INBOX table type is selected, the inbox parameter can be set to null.

inboxes - the array of Postfach in which the processes lie.

Returns:

Number of elements.

Since:

4.3.2

getVorgaengeDataTotalCount

public long getVorgaengeDataTotalCount(UserContext uc,
 Projekt project,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType)

Method for determining the total number of process data of the processes of a Projekt.

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt to which the processes belongs.

qcm - QueryCriteriaManager with specific filter parameters.

tableType - EProjectSpecificDBTable specifies from which table the data should be determined.

Returns:

Number of elements.

Since:

4.3.2

getCustomAttributes

public Map<String,String> getCustomAttributes(UserContext uc,
 Vorgang formRecord)

Returns the custom attributes of a form record. This is needed because the custom attributes are loaded lazily. If you load a form record via the API and then attempt to access its custom attributes, you will get a LazyInitializationException.

Returns an empty map when the form record does not exist anymore.

Parameters:

uc - The context with the user who requested the custom attributes.

formRecord - The formRecord for which to retrieve the custom attributes.

Returns:

The custom attributes of the form record, never null, but may be empty.

Since:

4.2.0

getCustomData

public Map<String,String> getCustomData(UserContext uc,
 Vorgang formRecord)

Returns the Vorgang.getCustomData() () custom data} of a form record. This is needed because the custom data are loaded lazily. If you load a form record via the API and then attempt to access its custom attributes, you will get a LazyInitializationException.

Returns an empty map when the form record does not exist anymore.

Parameters:

uc - The context with the user who requested the custom data.

formRecord - The formRecord for which to retrieve the custom data.

Returns:

The custom data of the form record, never null, but may be empty.

Since:

8.3.3

getFormRecordReviewData

public IFormRecordReviewData getFormRecordReviewData(UserContext uc,
 IInboxFormRecordRequest inboxRequest)

Gets the form record review data for a given process id

Parameters:

uc - UserContext to use

inboxRequest - holds the request data

Returns:

the form record review data (including meta data) of the form record

Since:

7.0.0

getFormRecordUploadElementData

public List<IFormRecordUploadElementData> getFormRecordUploadElementData(UserContext uc,
 IInboxFormRecordUploadElementDataRequest request)

Gets the upload element data for a given form record.

Parameters:

uc - User context for accessing the database

request - holds the request data

Returns:

the upload element data of the form record

Since:

8.4.0

getFormRecordBaseData

public List<IFormRecordBaseData> getFormRecordBaseData(UserContext uc,
 de.xima.cmn.criteria.QueryCriteriaManager qcm)

Gets the form record base data for the given query

Parameters:

uc - UserContext to use

qcm - defines the query

Returns:

list of form record data (including meta data) of the form record

Since:

7.0.0

getExtendedFormRecordBaseData

public List<IFormRecordBaseData> getExtendedFormRecordBaseData(UserContext uc,
 de.xima.cmn.criteria.QueryCriteriaManager qcm,
 EProjectSpecificDBTable tableType,
 Projekt project,
 Postfach... inboxes)

getFormRecordBaseData

public IFormRecordBaseData getFormRecordBaseData(UserContext uc,
 Long processId)

getExtendedFormRecordBaseData

public IFormRecordBaseData getExtendedFormRecordBaseData(UserContext uc,
 Long processId,
 EProjectSpecificDBTable tableType,
 Projekt project,
 Postfach... inboxes)

getFormRecordDoiInitData

public IFormRecordDoiInitData getFormRecordDoiInitData(UserContext uc,
 Vorgang formRecord)

Gets the data that was used to initialize the Double opt-in of the given form record

Parameters:

uc - UserContext to use

formRecord - to get Double opt-in initialization data for

Returns:

data that was used to initialize the Double opt-in of the given form record or null if the form record is not in a Double opt-in 'state'

Since:

7.0.0

bulkMarkRead

public int bulkMarkRead(UserContext uc,
 List<Long> formRecordIds,
 boolean read)

Bulk updates the 'read' value of all form records with the given IDs to the given 'read' value iff the authenticated user given by the user context has permission to access the form records. If the user context does not provide an authenticated user (e.g. a virtual user) no form records will be updated.

Parameters:

uc - UserContext with an authenticated user for database transactions. For creating a user context for an authenticated user see UserContextFactory.forUser(IUser).

formRecordIds - List of IDs of the form records that the user requests to be updated.

read - Boolean value to set the attribute 'gelesen' to

Returns:

the number of updated records

Throws:

de.xima.cmn.dao.exceptions.UpdateException - if the given user context does not provide an authenticated user.

Since:

6.2.1

bulkMove

public int bulkMove(UserContext uc,
 Set<Long> formRecordIds,
 Postfach inbox)

Bulk moves all form records with the given IDs to the given inbox iff the authenticated user given by the user context has permission to access the form records. If the user context does not provide an authenticated user (e.g. a virtual user) no form records will be updated.

Parameters:

uc - UserContext with an authenticated user for database transactions. For creating a user context for an authenticated user see UserContextFactory.forUser(IUser).

formRecordIds - Set of IDs of the form records that the user requests to be updated.

Returns:

the number of updated records.

Throws:

de.xima.cmn.dao.exceptions.UpdateException - if the given user context does not provide an authenticated user.

Since:

8.0.2

bulkDelete

public int bulkDelete(UserContext uc,
 List<Long> formRecordIds)

Bulk deletes all form records with the given IDs iff the authenticated user given by the user context has permission to access the form records and the form records can be deleted (the state allows deletion). If the user context does not provide an authenticated user (e.g. a virtual user) no form records will be deleted.

Parameters:

uc - UserContext with an authenticated user for database transactions. For creating a user context for an authenticated user see UserContextFactory.forUser(IUser).

formRecordIds - List of IDs of the form records that the user requests to be deleted.

Returns:

the number of deleted form records.

Throws:

de.xima.cmn.dao.exceptions.DeleteException - if the given entity context does not provide an authenticated user.

Since:

6.2.1

correctStatus

@Deprecated
public Vorgang correctStatus(UserContext uc,
 Vorgang formRecord,
 Status targetState,
 IUser user)

Deprecated.

The old workflow is deprecated, use method for the new workflow.

Performs a correction on the form record, i.e. saves the form data and changes the state, but does not execute the workflow.

Parameters:

uc - Current user context.

formRecord - Form record to process.

targetState - Target state to set.

user - User who initiated the correction.

Returns:

The updated form record entity.

acquireExclusiveFormRecordLock

public IExclusiveFormRecordLockResult acquireExclusiveFormRecordLock(UserContext uc,
 IBasicFormRecordRequestData req)

Acquires an exclusive lock on the form record.

Parameters:

uc - UserContext to be used

req - IBasicFormRecordRequestData identifying the form record to be locked

Returns:

result which tells if the operation was successful or not

Since:

6.6.13 & 7.0.5

releaseExclusiveFormRecordLock

public IExclusiveFormRecordLockResult releaseExclusiveFormRecordLock(UserContext uc,
 IBasicFormRecordRequestData req)

Releases an exclusive lock on the form record.

Parameters:

uc - UserContext to be used

req - IBasicFormRecordRequestData identifying the form record to be unlocked

Returns:

result which tells if the operation was successful or not

Since:

6.6.13 & 7.0.5

getAllByBenutzer

@Deprecated
public List<Vorgang> getAllByBenutzer(UserContext uc,
 Benutzer benutzer)

Deprecated.

Method for determining all Vorgangs associated with the Benutzer. The Vorgang are determined by the BenutzerGruppe and its Postfach.

Parameters:

uc - UserContext the user context in which the action is to be performed.

benutzer - Benutzer, which is assigned to the processes.

Returns:

List of Vorgang

Since:

2.4.3

getVorgaengeData

@Deprecated
public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
 Projekt project,
 de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated.

use getVorgaengeData(UserContext, Projekt, QueryCriteriaManager, EProjectSpecificDBTable)

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt the processes are assigned.

qcm - QueryCriteriaManager with specific filter parameters.

Returns:

List with generic objects of process data.

getVorgaengeData

@Deprecated
public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
 Projekt project,
 Postfach inbox,
 de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated.

use getVorgaengeData(UserContext, Projekt, Postfach, QueryCriteriaManager, EProjectSpecificDBTable)

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt the processes are assigned.

inbox - the Postfach in which the processes lie.

qcm - QueryCriteriaManager with specific filter parameters.

Returns:

List with generic objects of process data.

getVorgangsData

@Deprecated
public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc,
 String prozessId,
 de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated.

use getVorgangsData(UserContext, String, QueryCriteriaManager, EProjectSpecificDBTable)

Parameters:

uc - UserContext the user context in which the action is to be performed.

prozessId - String the process ID of the process whose data is to be loaded.

qcm - QueryCriteriaManager with specific filter parameters.

Returns:

generic object of process data.

getVorgangsData

@Deprecated
public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc,
 Projekt project,
 Vorgang v,
 de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated.

use getVorgangsData(UserContext, Projekt, Vorgang, QueryCriteriaManager, EProjectSpecificDBTable)

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt to which the process belongs.

v - the Vorgang whose data is to be determined.

qcm - QueryCriteriaManager with specific filter parameters.

Returns:

generic object of process data or null.

getVorgaengeDataTotalCount

@Deprecated
public long getVorgaengeDataTotalCount(UserContext uc,
 Projekt project,
 de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated.

use getVorgaengeDataTotalCount(UserContext, Projekt, QueryCriteriaManager, EProjectSpecificDBTable)

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt to which the processes belongs.

qcm - QueryCriteriaManager with specific filter parameters.

Returns:

Number of elements.

getVorgaengeDataTotalCount

@Deprecated
public long getVorgaengeDataTotalCount(UserContext uc,
 Projekt project,
 Postfach inbox,
 de.xima.cmn.criteria.QueryCriteriaManager qcm)

Deprecated.

use getVorgaengeDataTotalCount(UserContext, Projekt, Postfach, QueryCriteriaManager, EProjectSpecificDBTable)

Parameters:

uc - UserContext the user context in which the action is to be performed.

project - the Projekt to which the processes belongs.

inbox - the Postfach in which the processes lie.

qcm - QueryCriteriaManager with specific filter parameters. If the EProjectSpecificDBTable.DATA_INBOX table type is selected, the inbox parameter can be set to null.

Returns:

Number of elements.

correctStatus

@Deprecated
public Vorgang correctStatus(UserContext uc,
 Vorgang formRecord,
 Status targetState,
 Benutzer user)

Deprecated.

The old workflow is deprecated, use method for the new workflow.

Performs a correction on the form record, i.e. saves the form data and changes the state, but does not execute the workflow.

Parameters:

uc - Current user context.

formRecord - Form record to process.

targetState - Target state to set.

user - User who initiated the correction.

Returns:

The updated form record entity.

changeStatusChangedReadFlag

public Vorgang changeStatusChangedReadFlag(UserContext uc,
 Vorgang process,
 boolean read)

sendMessage

public ISendMessageResponse sendMessage(UserContext uc,
 ISendMessageRequest messageRequest)

Since:

8.4.0

See Also:

• IVorgangHandler.sendMessage(UserContext, ISendMessageRequest)