Package com.aquima.web.rest.v1.service

Class CaseEventService

java.lang.Object

com.aquima.web.rest.v1.service.CaseEventService

public class CaseEventService
extends Object

Implements the logic of the /caseEvents endpoint.

Since:

9.6

Author:

Petru Galanton

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CASE_ID
static final String	ID
static final String	NAME
static final String	STATUS
static final String	TIMESTAMP
static final String	TYPE
static final String	USER

Method Summary

Modifier and Type	Method	Description
static CaseEventService	forPaged(com.aquima.interactions.process.impl.ProcessCaseRepository repository, IResourceConverter<com.aquima.interactions.process.dao.ICaseEventModel,CaseEvent> converter, IResourceLinker<CaseEvent> linker, PaginatorFactory paginatorFactory)	Creates an instance of this service usable in the /caseEvents endpoint
static CaseEventService	forReplay(com.aquima.interactions.portal.IPortalEngine portalEngine, com.aquima.interactions.process.impl.ProcessCaseRepository repository, IResourceConverter<com.aquima.interactions.process.dao.ICaseEventModel,CaseEvent> converter)	Creates an instance of this service usable in the POST /caseEvents/{eventId} endpoint (for replaying events).
static CaseEventService	forSingle(com.aquima.interactions.process.impl.ProcessCaseRepository repository, IResourceConverter<com.aquima.interactions.process.dao.ICaseEventModel,CaseEvent> converter)	Creates an instance of this service usable in the GET /caseEvents/{eventId} endpoint
CaseEvent	getCaseEvent(CaseEvent caseEvent, Long eventId)	Populates the given case event resource with the details of the case event with the given id.
List<CaseEvent>	getCaseEvents(PagedObject<CaseEvent> pagedObject, NullableLong caseId, Integer page, Integer pageSize, String sort, List<ResourceFilter> resourceFilters)	Populates the given paged object resource with a (potentially) paginated list of case events.
void	replayCaseEvent(CaseEvent eventResource, Long eventId, NullableLong caseId, com.aquima.interactions.project.IUserData userData)	Replays (re-triggers) the event with the given id and populates the given event resource with the details of the newly created event.

Methods inherited from class java.lang.Object

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

CASE_ID

public static final String CASE_ID

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

STATUS

public static final String STATUS

See Also:

• Constant Field Values

TIMESTAMP

public static final String TIMESTAMP

See Also:

• Constant Field Values

USER

public static final String USER

See Also:

• Constant Field Values

Method Details

forPaged

public static CaseEventService forPaged(com.aquima.interactions.process.impl.ProcessCaseRepository repository,
 IResourceConverter<com.aquima.interactions.process.dao.ICaseEventModel,CaseEvent> converter,
 IResourceLinker<CaseEvent> linker,
 PaginatorFactory paginatorFactory)

Creates an instance of this service usable in the /caseEvents endpoint

Parameters:

repository - the case repository

converter - converter from case event models to case event resources

linker - HATEOAS linker for case events

paginatorFactory - paginator factory

Returns:

an instance of this service configured for use in the GET /caseEvents endpoint

forSingle

public static CaseEventService forSingle(com.aquima.interactions.process.impl.ProcessCaseRepository repository,
 IResourceConverter<com.aquima.interactions.process.dao.ICaseEventModel,CaseEvent> converter)

Creates an instance of this service usable in the GET /caseEvents/{eventId} endpoint

Parameters:

repository - the case repository

converter - converter from case event models to case event resources

Returns:

an instance of this service configured for use in the /caseEvents/{eventId} endpoint

forReplay

public static CaseEventService forReplay(com.aquima.interactions.portal.IPortalEngine portalEngine,
 com.aquima.interactions.process.impl.ProcessCaseRepository repository,
 IResourceConverter<com.aquima.interactions.process.dao.ICaseEventModel,CaseEvent> converter)

Creates an instance of this service usable in the POST /caseEvents/{eventId} endpoint (for replaying events).

Parameters:

portalEngine - the portal engine, used for obtaining a process engine

repository - the case repository

converter - converter from case event models to case event resources

Returns:

an instance of this service configured for use in the POST /caseEvents/{eventId} endpoint

getCaseEvents

public List<CaseEvent> getCaseEvents(PagedObject<CaseEvent> pagedObject,
 NullableLong caseId,
 Integer page,
 Integer pageSize,
 String sort,
 List<ResourceFilter> resourceFilters)

Populates the given paged object resource with a (potentially) paginated list of case events.

Parameters:

pagedObject - the paged object resource where case events resources are placed

caseId - the caseId filter, may be null

page - the page number (may be null - null disables paging)

pageSize - the page size (may be null - null disables paging)

sort - the sorting order

resourceFilters - resource filters

Returns:

the case events

getCaseEvent

public CaseEvent getCaseEvent(CaseEvent caseEvent,
 Long eventId)

Populates the given case event resource with the details of the case event with the given id.

Parameters:

caseEvent - the case event resource

eventId - the id of the case event

Returns:

the case event

replayCaseEvent

public void replayCaseEvent(CaseEvent eventResource,
 Long eventId,
 NullableLong caseId,
 com.aquima.interactions.project.IUserData userData)

Replays (re-triggers) the event with the given id and populates the given event resource with the details of the newly created event.

Parameters:

eventResource - the event resource for the replayed event

eventId - the id of the original event

caseId - (optional) for message events, the id of the case where the new event should be triggered

userData - the user data