Package de.xima.fc.handler.entity
Class VorgangHandler
- java.lang.Object
-
- de.xima.fc.handler.AMSApiHandler
-
- de.xima.fc.handler.entity.GenericHandler
-
- de.xima.fc.handler.entity.VorgangHandler
-
- All Implemented Interfaces:
IAPIHandler
,IGenericHandler
,IVorgangHandler
,Serializable
public class VorgangHandler extends GenericHandler implements IVorgangHandler
The Class VorgangHandler.- Author:
- XIMA MEDIA GmbH
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class de.xima.fc.handler.entity.GenericHandler
LOG
-
-
Constructor Summary
Constructors Constructor Description VorgangHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods 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)
Vorgang
addSubmission(UserContext uc, Vorgang formRecord, IUser user, EFormRecordSubmitContext submitContext, FrontendServer submitFrontendServer, String submitServerBaseUrl, 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.Vorgang
correctStatus(UserContext uc, Vorgang formRecord, Status targetState, IUser user)
Deprecated.void
delete(UserContext uc, Vorgang formRecord)
List<Vorgang>
getAllByPostfach(UserContext uc, Postfach postfach)
List<Vorgang>
getByUser(UserContext uc, IUser user)
Gets a list of all form records the user has submitted at some point, in descending order of their (last) modification instant.PagedResult<Vorgang>
getByUser(UserContext uc, IUser user, int page, int pageSize)
Gets a sub list of form records the user has submitted at some point, in descending order of their (last) modification instant.Vorgang
getByUuidAndUser(UserContext uc, UUID uuid, IUser user)
Finds the form record for the given UUID if the given user has submitted it at some point.List<Vorgang>
getChildren(UserContext uc, Vorgang formRecord)
Map<String,String>
getCustomAttributes(UserContext uc, Vorgang process)
List<IFormRecordBaseData>
getFormRecordBaseData(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm)
IFormRecordDoiInitData
getFormRecordDoiInitData(UserContext uc, Vorgang formRecord)
IFormRecordReviewData
getFormRecordReviewData(UserContext uc, IInboxFormRecordRequest inboxRequest)
IFormRecordUploadRequestData
getFormRecordUploadRequestData(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)
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)
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 class de.xima.fc.handler.entity.GenericHandler
create, create, delete, delete, deleteBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, serializableList, update, update
-
Methods inherited from class de.xima.fc.handler.AMSApiHandler
getName
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
-
getByUuidAndUser
public Vorgang getByUuidAndUser(UserContext uc, UUID uuid, IUser user)
Description copied from interface:IVorgangHandler
Finds the form record for the given UUID if the given user has submitted it at some point.- Specified by:
getByUuidAndUser
in interfaceIVorgangHandler
- Parameters:
uc
- user context for accessing the database.uuid
- the UUID of the form recorduser
- to get the form record for.- Returns:
- The form record with the given UUID if it exists and the user has submitted it at one point.
null
otherwise.
-
getByUser
public List<Vorgang> getByUser(UserContext uc, IUser user)
Description copied from interface:IVorgangHandler
Gets a list of all form records the user has submitted at some point, in descending order of their (last) modification instant.- Specified by:
getByUser
in interfaceIVorgangHandler
- Parameters:
uc
- user context for database transactions.user
- that has submitted the form records at some point.- Returns:
- a list of all form records the user has submitted at some point, in descending order of their (last) modification instant.
-
getByUser
public PagedResult<Vorgang> getByUser(UserContext uc, IUser user, int page, int pageSize)
Description copied from interface:IVorgangHandler
Gets a sub list of form records the user has submitted at some point, in descending order of their (last) modification instant.- Specified by:
getByUser
in interfaceIVorgangHandler
- Parameters:
uc
- user context for database transactions.user
- that has submitted the form records at some point.page
- to get.pageSize
- size of the page to get. Defines the size of the returned sub list.- Returns:
- a sub list of form records the user has submitted at some point, in descending order of their (last) modification instant.
-
addAttachment
public Vorgang addAttachment(UserContext uc, Long vorgangId, Long attachmentId)
- Specified by:
addAttachment
in interfaceIVorgangHandler
-
addAttachment
public Vorgang addAttachment(UserContext uc, Vorgang vorgang, Attachment attachment)
- Specified by:
addAttachment
in interfaceIVorgangHandler
-
getAllByPostfach
public List<Vorgang> getAllByPostfach(UserContext uc, Postfach postfach)
- Specified by:
getAllByPostfach
in interfaceIVorgangHandler
-
getVorgaengeData
public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc, Projekt pro, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType, Postfach... inboxes)
- Specified by:
getVorgaengeData
in interfaceIVorgangHandler
-
getVorgaengeDataTotalCount
public long getVorgaengeDataTotalCount(UserContext uc, Projekt pro, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType, Postfach... inboxes)
- Specified by:
getVorgaengeDataTotalCount
in interfaceIVorgangHandler
-
getVorgangsData
public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc, String prozessId, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)
- Specified by:
getVorgangsData
in interfaceIVorgangHandler
-
getVorgangsData
public ExtendedEntityModel<Vorgang> getVorgangsData(UserContext uc, Projekt pro, Vorgang v, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)
- Specified by:
getVorgangsData
in interfaceIVorgangHandler
-
getCustomAttributes
public Map<String,String> getCustomAttributes(UserContext uc, Vorgang process)
- Specified by:
getCustomAttributes
in interfaceIVorgangHandler
-
getFormRecordReviewData
public IFormRecordReviewData getFormRecordReviewData(UserContext uc, IInboxFormRecordRequest inboxRequest)
- Specified by:
getFormRecordReviewData
in interfaceIVorgangHandler
-
getFormRecordUploadRequestData
public IFormRecordUploadRequestData getFormRecordUploadRequestData(UserContext uc, IInboxFormRecordRequest inboxRequest)
- Specified by:
getFormRecordUploadRequestData
in interfaceIVorgangHandler
-
getFormRecordBaseData
public List<IFormRecordBaseData> getFormRecordBaseData(UserContext uc, de.xima.cmn.criteria.QueryCriteriaManager qcm)
- Specified by:
getFormRecordBaseData
in interfaceIVorgangHandler
-
getFormRecordDoiInitData
public IFormRecordDoiInitData getFormRecordDoiInitData(UserContext uc, Vorgang formRecord)
- Specified by:
getFormRecordDoiInitData
in interfaceIVorgangHandler
-
bulkMarkRead
public int bulkMarkRead(UserContext uc, List<Long> formRecordIds, boolean read)
Description copied from interface:IVorgangHandler
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. avirtual user
) no form records will be updated.- Specified by:
bulkMarkRead
in interfaceIVorgangHandler
- Parameters:
uc
-UserContext
with an authenticated user for database transactions. For creating a user context for an authenticated user seeUserContextFactory.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
-
bulkMove
public int bulkMove(UserContext uc, Set<Long> formRecordIds, Postfach inbox)
Description copied from interface:IVorgangHandler
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. avirtual user
) no form records will be updated.- Specified by:
bulkMove
in interfaceIVorgangHandler
- Parameters:
uc
-UserContext
with an authenticated user for database transactions. For creating a user context for an authenticated user seeUserContextFactory.forUser(IUser)
.formRecordIds
-Set
of IDs of the form records that the user requests to be updated.- Returns:
- the number of updated records.
-
bulkDelete
public int bulkDelete(UserContext uc, List<Long> formRecordIds)
Description copied from interface:IVorgangHandler
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. avirtual user
) no form records will be deleted.- Specified by:
bulkDelete
in interfaceIVorgangHandler
- Parameters:
uc
-UserContext
with an authenticated user for database transactions. For creating a user context for an authenticated user seeUserContextFactory.forUser(IUser)
.formRecordIds
-List
of IDs of the form records that the user requests to be deleted.- Returns:
- the number of deleted form records.
-
delete
public void delete(UserContext uc, Vorgang formRecord)
- Specified by:
delete
in interfaceIVorgangHandler
-
getParent
public Vorgang getParent(UserContext uc, Vorgang formRecord)
- Specified by:
getParent
in interfaceIVorgangHandler
- 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)
- Specified by:
getChildren
in interfaceIVorgangHandler
- 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
public IExclusiveFormRecordLockResult acquireExclusiveFormRecordLock(UserContext uc, IBasicFormRecordRequestData req)
- Specified by:
acquireExclusiveFormRecordLock
in interfaceIVorgangHandler
-
releaseExclusiveFormRecordLock
public IExclusiveFormRecordLockResult releaseExclusiveFormRecordLock(UserContext uc, IBasicFormRecordRequestData req)
- Specified by:
releaseExclusiveFormRecordLock
in interfaceIVorgangHandler
-
correctStatus
@Deprecated public Vorgang correctStatus(UserContext uc, Vorgang formRecord, Status targetState, IUser user)
Deprecated.- Specified by:
correctStatus
in interfaceIVorgangHandler
-
correctStatus
@Deprecated public Vorgang correctStatus(UserContext uc, Vorgang formRecord, Status targetState, Benutzer user)
Deprecated.- Specified by:
correctStatus
in interfaceIVorgangHandler
-
getVorgaengeByBenutzer
@Deprecated public List<Vorgang> getVorgaengeByBenutzer(UserContext uc, Benutzer benutzer)
Deprecated.- Specified by:
getVorgaengeByBenutzer
in interfaceIVorgangHandler
-
getVorgaengeData
public List<ExtendedEntityModel<Vorgang>> getVorgaengeData(UserContext uc, Projekt pro, Postfach pf, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)
- Specified by:
getVorgaengeData
in interfaceIVorgangHandler
-
getVorgaengeDataTotalCount
public long getVorgaengeDataTotalCount(UserContext uc, Projekt pro, Postfach pf, de.xima.cmn.criteria.QueryCriteriaManager qcm, EProjectSpecificDBTable tableType)
- Specified by:
getVorgaengeDataTotalCount
in interfaceIVorgangHandler
-
changeStatusChangedReadFlag
public Vorgang changeStatusChangedReadFlag(UserContext uc, Vorgang process, boolean read)
- Specified by:
changeStatusChangedReadFlag
in interfaceIVorgangHandler
-
addSubmission
public Vorgang addSubmission(UserContext uc, Vorgang formRecord, IUser user, EFormRecordSubmitContext submitContext, FrontendServer submitFrontendServer, String submitServerBaseUrl, String formData, boolean newDataEntry)
Description copied from interface:IVorgangHandler
Adds a new submission to the form record.- Specified by:
addSubmission
in interfaceIVorgangHandler
- Parameters:
uc
- The user context.formRecord
- Theform record
to which the submission should be added.user
- 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.
-
-