Package pro.taskana.spi.history.api

Interface TaskanaHistory

public interface TaskanaHistory

Interface for TASKANA History Service Provider.

Method Summary

Modifier and Type	Method	Description
void	create(ClassificationHistoryEvent event)	Create a new ClassificationHistoryEvent.
void	create(TaskHistoryEvent event)	Create a new TaskHistoryEvent.
void	create(WorkbasketHistoryEvent event)	Create a new WorkbasketHistoryEvent.
void	deleteHistoryEventsByTaskIds(List<String> taskIds)	Delete history events by taskIds.
void	initialize(TaskanaEngine taskanaEngine)	Initialize TaskanaHistory service.

Method Details

initialize

void initialize(TaskanaEngine taskanaEngine)

Initialize TaskanaHistory service.

Parameters:

taskanaEngine - TaskanaEngine The Taskana engine for needed initialization.

create

void create(TaskHistoryEvent event)

Create a new TaskHistoryEvent.

Parameters:

event - TaskHistoryEvent The event to be created.

create

void create(WorkbasketHistoryEvent event)

Create a new WorkbasketHistoryEvent.

Parameters:

event - WorkbasketHistoryEvent The event to be created.

create

void create(ClassificationHistoryEvent event)

Create a new ClassificationHistoryEvent.

Parameters:

event - ClassificationHistoryEvent The event to be created.

deleteHistoryEventsByTaskIds

void deleteHistoryEventsByTaskIds(List<String> taskIds)
                           throws InvalidArgumentException,
NotAuthorizedException

Delete history events by taskIds. Invalid/non-existing taskIds will be ignored

Parameters:

taskIds - the task ids for which all history events must be deleted

Throws:

InvalidArgumentException - If the list of taskIds is null

NotAuthorizedException - if the current user is not member of TaskanaRole.ADMIN