TSK-1867: Refactor Java-doc in ClassificationService
This commit is contained in:
ryzheboka
Elena Mokeeva
parent
5468fef9c5
commit
0f91db4b7c
|
|
@ -5,12 +5,16 @@ import pro.taskana.classification.api.exceptions.ClassificationInUseException;
|
|||
import pro.taskana.classification.api.exceptions.ClassificationNotFoundException;
|
||||
import pro.taskana.classification.api.exceptions.MalformedServiceLevelException;
|
||||
import pro.taskana.classification.api.models.Classification;
|
||||
import pro.taskana.common.api.TaskanaRole;
|
||||
import pro.taskana.common.api.exceptions.ConcurrencyException;
|
||||
import pro.taskana.common.api.exceptions.DomainNotFoundException;
|
||||
import pro.taskana.common.api.exceptions.InvalidArgumentException;
|
||||
import pro.taskana.common.api.exceptions.NotAuthorizedException;
|
||||
import pro.taskana.task.api.models.Task;
|
||||
|
||||
/** This class manages {@linkplain Classification Classifications}. */
|
||||
/**
|
||||
* The ClassificationService manages all operations on {@linkplain Classification Classifications}.
|
||||
*/
|
||||
public interface ClassificationService {
|
||||
|
||||
/**
|
||||
|
|
@ -23,11 +27,11 @@ public interface ClassificationService {
|
|||
* Classification}
|
||||
* @param domain the {@linkplain Classification#getDomain() domain} of the searched-for
|
||||
* {@linkplain Classification}
|
||||
* @return if exist: domain-specific {@linkplain Classification}, else master {@linkplain
|
||||
* @return if exists: domain-specific {@linkplain Classification}, else master {@linkplain
|
||||
* Classification}
|
||||
* @throws ClassificationNotFoundException if no {@linkplain Classification} is found that matches
|
||||
* the {@linkplain Classification#getKey() key} either in {@linkplain
|
||||
* Classification#getDomain() domain} or in the master {@linkplain Classification#getDomain()
|
||||
* @throws ClassificationNotFoundException if no {@linkplain Classification} with specified
|
||||
* {@linkplain Classification#getKey() key} was found neither in the specified {@linkplain
|
||||
* Classification#getDomain() domain} nor in the master {@linkplain Classification#getDomain()
|
||||
* domain}
|
||||
*/
|
||||
Classification getClassification(String key, String domain)
|
||||
|
|
@ -40,8 +44,8 @@ public interface ClassificationService {
|
|||
* @param id the {@linkplain Classification#getId() id} of the searched-for {@linkplain
|
||||
* Classification}
|
||||
* @return the {@linkplain Classification} identified by {@linkplain Classification#getId() id}
|
||||
* @throws ClassificationNotFoundException if no {@linkplain Classification} is found that matches
|
||||
* the {@linkplain Classification#getId() id}
|
||||
* @throws ClassificationNotFoundException if no {@linkplain Classification} with the specified
|
||||
* {@linkplain Classification#getId() id} was found
|
||||
*/
|
||||
Classification getClassification(String id) throws ClassificationNotFoundException;
|
||||
|
||||
|
|
@ -51,13 +55,12 @@ public interface ClassificationService {
|
|||
*
|
||||
* @param id the {@linkplain Classification#getId() id} of the searched-for {@linkplain
|
||||
* Classification}
|
||||
* @throws ClassificationInUseException if there are {@linkplain
|
||||
* pro.taskana.task.api.models.Task}s which refer to this {@linkplain Classification}
|
||||
* @throws ClassificationInUseException if there are {@linkplain Task Tasks} which refer to this
|
||||
* {@linkplain Classification}
|
||||
* @throws ClassificationNotFoundException if no {@linkplain Classification} with the specified
|
||||
* {@linkplain Classification#getId() id} is found
|
||||
* @throws NotAuthorizedException if the current user is not member of role {@linkplain
|
||||
* pro.taskana.common.api.TaskanaRole#BUSINESS_ADMIN} or {@linkplain
|
||||
* pro.taskana.common.api.TaskanaRole#ADMIN}
|
||||
* {@linkplain Classification#getId() id} was found
|
||||
* @throws NotAuthorizedException if the current user is not member of {@linkplain
|
||||
* TaskanaRole#BUSINESS_ADMIN} or {@linkplain TaskanaRole#ADMIN}
|
||||
*/
|
||||
void deleteClassification(String id)
|
||||
throws ClassificationInUseException, ClassificationNotFoundException, NotAuthorizedException;
|
||||
|
|
@ -70,36 +73,34 @@ public interface ClassificationService {
|
|||
* @param classificationKey the {@linkplain Classification#getKey() key} of the {@linkplain
|
||||
* Classification} you want to delete.
|
||||
* @param domain the {@linkplain Classification#getDomain() domain} of the the {@linkplain
|
||||
* Classification} you want to delete. if "", the function tries to delete the "master domain"
|
||||
* {@linkplain Classification} and any other {@linkplain Classification} with this {@linkplain
|
||||
* Classification#getKey() key}.
|
||||
* @throws ClassificationInUseException if there are {@linkplain
|
||||
* pro.taskana.task.api.models.Task}s which refer to this {@linkplain Classification}.
|
||||
* Classification} you want to delete. if "", the function tries to delete the {@linkplain
|
||||
* Classification} from the master {@linkplain Classification#getDomain() domain} and any
|
||||
* other {@linkplain Classification} with this {@linkplain Classification#getKey() key}
|
||||
* @throws ClassificationInUseException if there are {@linkplain Task Tasks} which refer to this
|
||||
* {@linkplain Classification}
|
||||
* @throws ClassificationNotFoundException if no {@linkplain Classification} with the specified
|
||||
* {@linkplain Classification#getKey() key} and {@linkplain Classification#getDomain() domain}
|
||||
* is found.
|
||||
* @throws NotAuthorizedException if the current user is not member of role {@linkplain
|
||||
* pro.taskana.common.api.TaskanaRole#BUSINESS_ADMIN} or {@linkplain
|
||||
* pro.taskana.common.api.TaskanaRole#ADMIN}
|
||||
* was found
|
||||
* @throws NotAuthorizedException if the current user is not member of {@linkplain
|
||||
* TaskanaRole#BUSINESS_ADMIN} or {@linkplain TaskanaRole#ADMIN}
|
||||
*/
|
||||
void deleteClassification(String classificationKey, String domain)
|
||||
throws ClassificationInUseException, ClassificationNotFoundException, NotAuthorizedException;
|
||||
|
||||
/**
|
||||
* Inserts a new {@linkplain Classification} after applying default values. <br>
|
||||
* The {@linkplain Classification} will be added to master-domain, too - if not already existing.
|
||||
* <br>
|
||||
* Inserts a new {@linkplain Classification} after applying default values.
|
||||
*
|
||||
* <p>The {@linkplain Classification} will be added to master-domain, too - if not already
|
||||
* existing. <br>
|
||||
* The default values are:
|
||||
*
|
||||
* <ul>
|
||||
* <li><b>{@linkplain Classification#getId() id}</b> - generated by {@linkplain
|
||||
* pro.taskana.common.internal.util.IdGenerator IdGenerator}
|
||||
* <li><b>{@linkplain Classification#getId() id}</b> - generated automatically
|
||||
* <li><b>{@linkplain Classification#getParentId() parentId}</b> - ""
|
||||
* <li><b>{@linkplain Classification#getParentKey() parentKey}</b> - ""
|
||||
* <li><b>{@linkplain Classification#getServiceLevel() serviceLevel}</b> - "P0D"
|
||||
* <li><b>{@linkplain Classification#getIsValidInDomain() isValidInDomain}</b> - {@code true}
|
||||
* <br>
|
||||
* if {@linkplain Classification#getDomain() domain} an empty string than {@code false}
|
||||
* <li><b>{@linkplain Classification#getIsValidInDomain() isValidInDomain}</b> - true <br>
|
||||
* if {@linkplain Classification#getDomain() domain} is the master domain: false
|
||||
* </ul>
|
||||
*
|
||||
* @param classification the {@linkplain Classification} to insert
|
||||
|
|
@ -107,9 +108,8 @@ public interface ClassificationService {
|
|||
* id}.
|
||||
* @throws ClassificationAlreadyExistException if the {@linkplain Classification} already exists
|
||||
* in the given {@linkplain Classification#getDomain() domain}.
|
||||
* @throws NotAuthorizedException if the current user is not member of role {@linkplain
|
||||
* pro.taskana.common.api.TaskanaRole#BUSINESS_ADMIN} or {@linkplain
|
||||
* pro.taskana.common.api.TaskanaRole#ADMIN}
|
||||
* @throws NotAuthorizedException if the current user is not member of {@linkplain
|
||||
* TaskanaRole#BUSINESS_ADMIN} or {@linkplain TaskanaRole#ADMIN}
|
||||
* @throws DomainNotFoundException if the {@linkplain Classification#getDomain() domain} does not
|
||||
* exist in the configuration
|
||||
* @throws MalformedServiceLevelException if the {@linkplain Classification#getServiceLevel()
|
||||
|
|
@ -125,14 +125,13 @@ public interface ClassificationService {
|
|||
*
|
||||
* @param classification the {@linkplain Classification} to update
|
||||
* @return the updated {@linkplain Classification}.
|
||||
* @throws ClassificationNotFoundException if the {@linkplain Classification} or its parent does
|
||||
* not exist.
|
||||
* @throws NotAuthorizedException if the caller got no {@linkplain
|
||||
* pro.taskana.common.api.TaskanaRole#BUSINESS_ADMIN} or {@linkplain
|
||||
* pro.taskana.common.api.TaskanaRole#ADMIN} permissions.
|
||||
* @throws ClassificationNotFoundException if the specified {@linkplain Classification} or its
|
||||
* parent does not exist
|
||||
* @throws NotAuthorizedException if the caller is neither member of{@linkplain
|
||||
* TaskanaRole#BUSINESS_ADMIN} nor {@linkplain TaskanaRole#ADMIN}
|
||||
* @throws ConcurrencyException if the {@linkplain Classification} was modified in the meantime
|
||||
* and is not the most up to date anymore; that's the case if the given modified timestamp
|
||||
* differs from the one in the database
|
||||
* and is not the most up to date anymore; that's the case if the given {@linkplain
|
||||
* Classification#getModified() modified} timestamp differs from the one in the database
|
||||
* @throws MalformedServiceLevelException if the {@linkplain Classification#getServiceLevel()
|
||||
* serviceLevel} does not comply with the ISO 8601 specification
|
||||
* @throws InvalidArgumentException if the {@linkplain Classification} contains invalid properties
|
||||
|
|
@ -142,24 +141,26 @@ public interface ClassificationService {
|
|||
InvalidArgumentException, MalformedServiceLevelException;
|
||||
|
||||
/**
|
||||
* This method provides a query builder for querying the database.
|
||||
* Creates an empty {@linkplain ClassificationQuery}.
|
||||
*
|
||||
* @return a {@linkplain ClassificationQuery}
|
||||
*/
|
||||
ClassificationQuery createClassificationQuery();
|
||||
|
||||
/**
|
||||
* Creating a new {@link Classification} initialized with unchangeable values for {@linkplain
|
||||
* Instantiates a non-persistent/non-inserted {@linkplain Classification}.
|
||||
*
|
||||
* <p>The {@linkplain Classification} is initialized with unchangeable values for {@linkplain
|
||||
* Classification#getKey() key}, {@linkplain Classification#getDomain() domain} and {@linkplain
|
||||
* Classification#getType() type}. The classification will not be inserted into the database until
|
||||
* {@linkplain ClassificationService#createClassification(Classification)} call.
|
||||
* Classification#getType() type}. The {@linkplain Classification} will not be inserted into the
|
||||
* database until {@linkplain ClassificationService#createClassification(Classification)} call.
|
||||
*
|
||||
* @param key the {@linkplain Classification#getKey() key} of the {@linkplain Classification}
|
||||
* @param domain the {@linkplain Classification#getDomain() domain} of the new {@linkplain
|
||||
* Classification}
|
||||
* @param type the {@linkplain Classification#getType() type} of the new {@linkplain
|
||||
* Classification}
|
||||
* @return the initialized {@linkplain Classification}
|
||||
* @return the instantiated {@linkplain Classification}
|
||||
*/
|
||||
Classification newClassification(String key, String domain, String type);
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue