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

Class CaseService

java.lang.Object

com.aquima.web.rest.v1.service.ProcessServiceBase

com.aquima.web.rest.v1.service.CaseService

public final class CaseService
extends ProcessServiceBase

Field Summary

Fields inherited from class com.aquima.web.rest.v1.service.ProcessServiceBase

dateConverter, repository

Method Summary

Modifier and Type	Method	Description
static CaseService	forPaged(com.aquima.interactions.process.impl.ProcessCaseRepository repository, IResourceConverter<com.aquima.interactions.process.dao.ICaseModel,Case> converter, IDateConverter dateConverter, IResourceLinker<Case> linker, PaginatorFactory paginatorFactory)	Creates an instance of this service usable in the /cases endpoint
static CaseService	forSingle(com.aquima.interactions.process.impl.ProcessCaseRepository repository, IResourceConverter<com.aquima.interactions.process.dao.ICaseModel,Case> converter, IDateConverter dateConverter)	Creates an instance of this service usable in the GET /cases/{caseId} endpoint
Case	getCase(Case resultCase, long caseId, String attributes, boolean includeAll)	This method is responsible for returning a case by its id
List<Case>	getCases(PagedObject<Case> pagedObject, Integer page, Integer pageSize, String sort, String attributes, List<ResourceFilter> resourceFilters, boolean includeAll)	This method is responsible for returning a PagedObject with cases

Methods inherited from class com.aquima.web.rest.v1.service.ProcessServiceBase

fillAttributes, fillAttributes, fillAttributes, getAttributeValue, getCaseIds, getIncluded, getInstanceIds, getInstanceIds

Methods inherited from class java.lang.Object

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

Method Details

forPaged

public static CaseService forPaged(com.aquima.interactions.process.impl.ProcessCaseRepository repository,
 IResourceConverter<com.aquima.interactions.process.dao.ICaseModel,Case> converter,
 IDateConverter dateConverter,
 IResourceLinker<Case> linker,
 PaginatorFactory paginatorFactory)

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

Parameters:

repository - the case repository

converter - converter from case model to case resources

dateConverter - the date converter

linker - HATEOAS linker for task

paginatorFactory - paginator factory

Returns:

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

forSingle

public static CaseService forSingle(com.aquima.interactions.process.impl.ProcessCaseRepository repository,
 IResourceConverter<com.aquima.interactions.process.dao.ICaseModel,Case> converter,
 IDateConverter dateConverter)

Creates an instance of this service usable in the GET /cases/{caseId} endpoint

Parameters:

repository - the case repository

converter - converter from case model to case resources

dateConverter - the data converter

Returns:

an instance of this service configured for use in the /task/{taskId} endpoint

getCases

public List<Case> getCases(PagedObject<Case> pagedObject,
 Integer page,
 Integer pageSize,
 String sort,
 String attributes,
 List<ResourceFilter> resourceFilters,
 boolean includeAll)

This method is responsible for returning a PagedObject with cases

Parameters:

pagedObject - The object which will be paged

page - Page number

pageSize - Page size

sort - Sort columns. Comma separated

attributes - the attributes

resourceFilters - A list of ResourceFilter objects. Used for filtering

includeAll - whether to include all

Returns:

result cases list

getCase

public Case getCase(Case resultCase,
 long caseId,
 String attributes,
 boolean includeAll)

This method is responsible for returning a case by its id

Parameters:

resultCase - The case resource

caseId - The id of the case

attributes - the attributes

includeAll - whether to include all

Returns:

result case object