pro.taskana

Interface ClassificationService

All Known Implementing Classes:

ClassificationServiceImpl

public interface ClassificationService

This class manages the classifications.

Method Summary

Modifier and Type	Method and Description
void	createClassification(Classification classification) Persist a new classification.
ClassificationQuery	createClassificationQuery() This method provides a query builder for quering the database.
List<Classification>	getAllClassificationsWithId(String id, String domain) Get all Classifications with the given id.
Classification	getClassification(String id, String domain) Get the Classification for id and domain.
List<Classification>	getClassificationTree() Get all available Classifications as a tree.
Classification	newClassification() Creating a new Classification with unchangeable default values.
void	updateClassification(Classification classification) Update a Classification.

Method Detail

getClassificationTree

List<Classification> getClassificationTree()
                                    throws NotAuthorizedException

Get all available Classifications as a tree.

Returns:

The List of all Classifications

Throws:

NotAuthorizedException - TODO

getAllClassificationsWithId

List<Classification> getAllClassificationsWithId(String id,
                                                 String domain)

Get all Classifications with the given id. Returns also older and domain-specific versions of the classification.

Parameters:

id - TODO

domain - TODO

Returns:

List with all versions of the Classification

getClassification

Classification getClassification(String id,
                                 String domain)
                          throws ClassificationNotFoundException

Get the Classification for id and domain.

Parameters:

id - TODO

domain - TODO

Returns:

If exist: domain-specific classification, else default classification

Throws:

ClassificationNotFoundException - TODO

createClassification

void createClassification(Classification classification)
                   throws ClassificationAlreadyExistException

Persist a new classification. If the classification does already exist in a domain, it will just be updated.

Parameters:

classification - the classification to insert

Throws:

ClassificationAlreadyExistException - when the classification does already exists with same ID+domain.

updateClassification

void updateClassification(Classification classification)
                   throws ClassificationNotFoundException

Update a Classification.

Parameters:

classification - the Classification to update

Throws:

ClassificationNotFoundException - when the classification does not exist already.

createClassificationQuery

ClassificationQuery createClassificationQuery()

This method provides a query builder for quering the database.

Returns:

a ClassificationQuery

newClassification

Classification newClassification()

Creating a new Classification with unchangeable default values. It will be only generated and is not persisted until CREATE-call.

Returns:

classification to specify