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
Classification	createClassification(Classification classification) Persists a new classification after adding default values.
ClassificationQuery	createClassificationQuery() This method provides a query builder for quering the database.
List<Classification>	getAllClassificationsWithKey(String key, String domain) Get all Classifications with the given key.
Classification	getClassification(String key, String domain) Get the Classification for key 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

getAllClassificationsWithKey

List<Classification> getAllClassificationsWithKey(String key,
                                                  String domain)

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

Parameters:

key - TODO

domain - TODO

Returns:

List with all versions of the Classification

getClassification

Classification getClassification(String key,
                                 String domain)
                          throws ClassificationNotFoundException

Get the Classification for key and domain. If there's no specification for the given domain, it returns the root domain.

Parameters:

key - TODO

domain - TODO

Returns:

If exist: domain-specific classification, else root classification

Throws:

ClassificationNotFoundException - TODO

createClassification

Classification createClassification(Classification classification)
                             throws ClassificationAlreadyExistException

Persists a new classification after adding default values.
The classification will be added to root-domain, too - if not already existing.

Parameters:

classification - the classification to insert

Returns:

classification which is persisted with unique ID.

Throws:

ClassificationAlreadyExistException - when the classification does already exists at the given 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