pro.taskana.classification.api.models

Interface Classification

All Superinterfaces:

ClassificationSummary

All Known Implementing Classes:

ClassificationImpl

public interface Classification
extends ClassificationSummary

Interface used to specify the Classification-Model.

Method Summary

Modifier and Type	Method and Description
ClassificationSummary	asSummary() Return a summary of the current Classification.
Classification	copy(String key) Duplicates this Classification without the id.
String	getApplicationEntryPoint() Get the logical name of the associated application entry point.
Instant	getCreated() Get the timestamp when this classification was as created.
String	getDescription() Get the description of a classification.
String	getDomain() Get the current domain-name of this classification.
Boolean	getIsValidInDomain() Get a flag if the classification if currently valid in the used domain.
Instant	getModified() Get the timestamp when this classification was as modified the last time.
void	setApplicationEntryPoint(String applicationEntryPoint) Set the logical name of the associated application entry point.
void	setCategory(String category) Set/Change the category of this classification.
void	setCustomAttribute(ClassificationCustomField customField, String value) Sets the value for custom Attribute.
void	setDescription(String description) Set/Change the classification description.
void	setIsValidInDomain(Boolean isValidInDomain) Set/Change the flag which marks the classification as valid/invalid in the currently used domain.
void	setName(String name) Set/Change the classification name.
void	setParentId(String parentId) Set/Change a reference to the current parent classification via ID.
void	setParentKey(String parentKey) Set/Change a reference to the current parent classification via key.
void	setPriority(int priority) Set/Change the numeric priority of a classification.
void	setServiceLevel(String serviceLevel) Set/Change the service level.

Methods inherited from interface pro.taskana.classification.api.models.ClassificationSummary

copy, getCategory, getCustomAttribute, getId, getKey, getName, getParentId, getParentKey, getPriority, getServiceLevel, getType

Method Detail

setParentId

void setParentId(String parentId)

Set/Change a reference to the current parent classification via ID. EMPTY if there is no parent.

Parameters:

parentId - The ID of the parent classification.

setParentKey

void setParentKey(String parentKey)

Set/Change a reference to the current parent classification via key. EMPTY if there is no parent.

Parameters:

parentKey - The key of the parent classification.

setCategory

void setCategory(String category)

Set/Change the category of this classification.

Parameters:

category - The category of the classification.

getDomain

String getDomain()

Get the current domain-name of this classification.

Specified by:

getDomain in interface ClassificationSummary

Returns:

domain name

getApplicationEntryPoint

String getApplicationEntryPoint()

Get the logical name of the associated application entry point.

Specified by:

getApplicationEntryPoint in interface ClassificationSummary

Returns:

applicationEntryPoint

setApplicationEntryPoint

void setApplicationEntryPoint(String applicationEntryPoint)

Set the logical name of the associated application entry point.

Parameters:

applicationEntryPoint - The application entry point

copy

Classification copy(String key)

Duplicates this Classification without the id.

Parameters:

key - for the new Classification

Returns:

a copy of this Classification

getIsValidInDomain

Boolean getIsValidInDomain()

Get a flag if the classification if currently valid in the used domain.

Returns:

isValidInDomain - flag

setIsValidInDomain

void setIsValidInDomain(Boolean isValidInDomain)

Set/Change the flag which marks the classification as valid/invalid in the currently used domain.

Parameters:

isValidInDomain - - flag

getCreated

Instant getCreated()

Get the timestamp when this classification was as created.

Returns:

created as instant

getModified

Instant getModified()

Get the timestamp when this classification was as modified the last time.

Returns:

modified as instant

setName

void setName(String name)

Set/Change the classification name.

Parameters:

name - the name of the Classification

getDescription

String getDescription()

Get the description of a classification.

Returns:

description

setDescription

void setDescription(String description)

Set/Change the classification description.

Parameters:

description - the description of the Classification

setPriority

void setPriority(int priority)

Set/Change the numeric priority of a classification.

Parameters:

priority - the Priority of the Classification

setServiceLevel

void setServiceLevel(String serviceLevel)

Set/Change the service level.

Parameters:

serviceLevel - the service level. Must be a String in ISO-8601 duration format. See the parse() method of Duration for details.

setCustomAttribute

void setCustomAttribute(ClassificationCustomField customField,
                        String value)

Sets the value for custom Attribute.

Parameters:

customField - identifies which custom attribute is to be set.

value - the value of the custom attribute to be set

asSummary

ClassificationSummary asSummary()

Return a summary of the current Classification.

Returns:

the ClassificationSummary object for the current classification