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<ClassificationSummary>	getAllClassifications(String key, String domain) Get all ClassificationSummaries with the given key.
Classification	getClassification(String key, String domain) Get the Classification for key and domain.
List<ClassificationSummary>	getClassificationTree() Get all available Classification summaries as a tree.
Classification	newClassification(String domain, String key, String type) Creating a new Classification with unchangeable default values.
Classification	updateClassification(Classification classification) Update a Classification.

Method Detail

getClassificationTree

List<ClassificationSummary> getClassificationTree()

Get all available Classification summaries as a tree.

Returns:

The List of all Classification summaries

getAllClassifications

List<ClassificationSummary> getAllClassifications(String key,
                                                  String domain)

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

Parameters:

key - the key of the searched-for classifications

domain - the domain of the searched-for classifications

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 Classification in the given domain, return the Classification from the root domain.

Parameters:

key - the key of the searched-for classifications

domain - the domain of the searched-for classifications

Returns:

If exist: domain-specific classification, else root classification

Throws:

ClassificationNotFoundException - if no classification is found that matches the key either in domain or in the root domain.

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

Classification updateClassification(Classification classification)
                             throws ClassificationNotFoundException

Update a Classification.

Parameters:

classification - the Classification to update

Returns:

the updated Classification.

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(String domain,
                                 String key,
                                 String type)

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

Parameters:

domain - the domain of the new classification

key - the key of the classification

type - the type of the new classification

Returns:

classification to specify