pro.taskana.classification.api

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.
void	deleteClassification(String id) Delete a classification with all child classifications.
void	deleteClassification(String classificationKey, String domain) Delete a classification with all child classifications.
Classification	getClassification(String id) Get the Classification by id.
Classification	getClassification(String key, String domain) Get the Classification for key and domain.
Classification	newClassification(String key, String domain, String type) Creating a new Classification with unchangeable default values.
Classification	updateClassification(Classification classification) Updates a Classification.

Method Detail

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 master 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 master classification

Throws:

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

getClassification

Classification getClassification(String id)
                          throws ClassificationNotFoundException

Get the Classification by id.

Parameters:

id - the id of the searched-for classifications

Returns:

the classification identified by id

Throws:

ClassificationNotFoundException - if no classification is found that matches the id.

deleteClassification

void deleteClassification(String id)
                   throws ClassificationInUseException,
                          ClassificationNotFoundException,
                          NotAuthorizedException

Delete a classification with all child classifications.

Parameters:

id - the id of the searched-for classifications

Throws:

ClassificationInUseException - if there are Task existing, which refer to this classification.

ClassificationNotFoundException - if for an domain no classification specification is found.

NotAuthorizedException - if the current user is not member of role BUSINESS_ADMIN or ADMIN

deleteClassification

void deleteClassification(String classificationKey,
                          String domain)
                   throws ClassificationInUseException,
                          ClassificationNotFoundException,
                          NotAuthorizedException

Delete a classification with all child classifications.

Parameters:

classificationKey - the key of the classification you want to delete.

domain - the domains for which you want to delete the classification. if "", the function tries to delete the "master domain" classification and any other classification with this key.

Throws:

ClassificationInUseException - if there are Task existing, which refer to this classification.

ClassificationNotFoundException - if for an domain no classification specification is found.

NotAuthorizedException - if the current user is not member of role BUSINESS_ADMIN or ADMIN

createClassification

Classification createClassification(Classification classification)
                             throws ClassificationAlreadyExistException,
                                    NotAuthorizedException,
                                    DomainNotFoundException,
                                    InvalidArgumentException

Persists a new classification after adding default values.
The classification will be added to master-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.

NotAuthorizedException - if the current user is not member of role BUSINESS_ADMIN or ADMIN

DomainNotFoundException - if the domain does not exist in the configuration

InvalidArgumentException - if the ServiceLevel property does not comply with the ISO 8601 specification

updateClassification

Classification updateClassification(Classification classification)
                             throws ClassificationNotFoundException,
                                    NotAuthorizedException,
                                    ConcurrencyException,
                                    InvalidArgumentException

Updates a Classification.

Parameters:

classification - the Classification to update

Returns:

the updated Classification.

Throws:

ClassificationNotFoundException - when the classification OR it´s parent does not exist.

NotAuthorizedException - when the caller got no ADMIN or BUSINESS_ADMIN permissions.

ConcurrencyException - when the Classification was modified meanwhile and is not latest anymore.

InvalidArgumentException - if the ServiceLevel property does not comply with the ISO 8601 specification

createClassificationQuery

ClassificationQuery createClassificationQuery()

This method provides a query builder for quering the database.

Returns:

a ClassificationQuery

newClassification

Classification newClassification(String key,
                                 String domain,
                                 String type)

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

Parameters:

key - the key of the classification

domain - the domain of the new classification

type - the type of the new classification

Returns:

classification to specify