Package de.xima.fc.handler.interfaces.entity

Interface IVorgangHandler

All Superinterfaces:

IAPIHandler, IGenericHandler, Serializable

All Known Implementing Classes:

VorgangHandler

public interface IVorgangHandler
extends IGenericHandler

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IExclusiveFormRecordLockResult	acquireExclusiveFormRecordLock(UserContext uc, IBasicFormRecordRequestData req)
Vorgang	addAttachment(UserContext uc, Vorgang vorgang, Attachment attachment)
Vorgang	addAttachment(UserContext uc, Long vorgangId, Long attachmentId)
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	correctStatus(UserContext uc, Vorgang formRecord, Status targetState, Benutzer user)	Deprecated. Use correctStatus(UserContext, Vorgang, de.xima.fc.entities.Status, IUser) instead.
Vorgang	correctStatus(UserContext uc, Vorgang formRecord, Status targetState, IUser user)	Deprecated. The old workflow engine is deprecated, use the new workflow engine.
void	delete(UserContext uc, Vorgang formRecord)
List<Vorgang>	getAllByPostfach(UserContext uc, Postfach postfach)
List<Vorgang>	getChildren(UserContext uc, Vorgang formRecord)
Map<String,String>	getCustomAttributes(UserContext uc, Vorgang v)
List<IFormRecordBaseData>	getFormRecordBaseData(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm)
IFormRecordDoiInitData	getFormRecordDoiInitData(UserContext uc, Vorgang formRecord)
IFormRecordReviewData	getFormRecordReviewData(UserContext uc, IInboxFormRecordRequest inboxRequest)
Vorgang	getParent(UserContext uc, Vorgang formRecord)
List<Vorgang>	getVorgaengeByBenutzer(UserContext uc, Benutzer benutzer)	Deprecated.
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt pro, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType, Postfach... inboxes)
List<ExtendedEntityModel<Vorgang>>	getVorgaengeData(UserContext uc, Projekt pro, Postfach pf, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)	Deprecated.
long	getVorgaengeDataTotalCount(UserContext uc, Projekt pro, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType, Postfach... inboxes)
long	getVorgaengeDataTotalCount(UserContext uc, Projekt pro, Postfach pf, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)	Deprecated.
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, Projekt pro, Vorgang v, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)
ExtendedEntityModel<Vorgang>	getVorgangsData(UserContext uc, String prozessID, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)
IExclusiveFormRecordLockResult	releaseExclusiveFormRecordLock(UserContext uc, IBasicFormRecordRequestData req)

Methods inherited from interface de.xima.fc.com.interfaces.IAPIHandler

getName

Methods inherited from interface de.xima.fc.handler.interfaces.entity.IGenericHandler

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

Method Detail

addAttachment

Vorgang addAttachment(UserContext uc,
                      Long vorgangId,
                      Long attachmentId)

addAttachment

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

getAllByPostfach

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

getVorgaengeData

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

getVorgaengeDataTotalCount

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

getVorgangsData

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

getVorgangsData

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

getCustomAttributes

Map<String,String> getCustomAttributes(UserContext uc,
                                             Vorgang v)

getFormRecordReviewData

IFormRecordReviewData getFormRecordReviewData(UserContext uc,
                                              IInboxFormRecordRequest inboxRequest)

getFormRecordBaseData

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

getFormRecordDoiInitData

IFormRecordDoiInitData getFormRecordDoiInitData(UserContext uc,
                                                Vorgang formRecord)

bulkMarkRead

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

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

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

delete

void delete(UserContext uc,
            Vorgang formRecord)

getParent

@Nullable
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

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.

acquireExclusiveFormRecordLock

IExclusiveFormRecordLockResult acquireExclusiveFormRecordLock(UserContext uc,
                                                              IBasicFormRecordRequestData req)

releaseExclusiveFormRecordLock

IExclusiveFormRecordLockResult releaseExclusiveFormRecordLock(UserContext uc,
                                                              IBasicFormRecordRequestData req)

correctStatus

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

Deprecated.

The old workflow engine is deprecated, use the new workflow engine.

correctStatus

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

Deprecated.

Use correctStatus(UserContext, Vorgang, de.xima.fc.entities.Status, IUser) instead.

getVorgaengeByBenutzer

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

Deprecated.

getVorgaengeData

@Deprecated
List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc,
                                                    Projekt pro,
                                                    Postfach pf,
                                                    de.xima.cmn.criteria.QueryCriteriaManager qcm,
                                                    EProjectSpecificDBTable tableType)

Deprecated.

getVorgaengeDataTotalCount

@Deprecated
long getVorgaengeDataTotalCount(UserContext uc,
                                Projekt pro,
                                Postfach pf,
                                de.xima.cmn.criteria.QueryCriteriaManager qcm,
                                EProjectSpecificDBTable tableType)

Deprecated.