pro.taskana

Interface Classification

All Known Implementing Classes:

ClassificationImpl

public interface Classification

Interface used to specify the Classification-Model.

Method Summary

Modifier and Type	Method and Description
ClassificationSummary	asSummary() Return a summary of the current Classification.
String	getApplicationEntryPoint() Get the logical name of the associated application entry point.
String	getCategory()
java.time.Instant	getCreated() Get the timestamp when this classification was as created.
String	getCustom1() Get the 1.
String	getCustom2() Get the 2.
String	getCustom3() Get the 3.
String	getCustom4() Get the 4.
String	getCustom5() Get the 5.
String	getCustom6() Get the 6.
String	getCustom7() Get the 7.
String	getCustom8() Get the 8.
String	getDescription() Get the description of a classification.
String	getDomain() Get the current domain-name of this classification.
String	getId()
Boolean	getIsValidInDomain() Get a flag if the classification if currently valid in the used domain.
String	getKey()
java.time.Instant	getModified() Get the timestamp when this classification was as modified the last time.
String	getName() Get the classification name.
String	getParentId() Used to get the ID of the parent classification.
String	getParentKey() Used to get the key of the parent classification.
int	getPriority() Get the current classification priority (numeric).
String	getServiceLevel() Get the current service level.
String	getType() Get the type of the current classification.
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	setCustom1(String custom1) Set/Change the 1.
void	setCustom2(String custom2) Set/Change the 2.
void	setCustom3(String custom3) Set/Change the 3.
void	setCustom4(String custom4) Set/Change the 4.
void	setCustom5(String custom5) Set/Change the 5.
void	setCustom6(String custom6) Set/Change the 6.
void	setCustom7(String custom7) Set/Change the 7.
void	setCustom8(String custom8) Set/Change the 8.
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.

Method Detail

getId

String getId()

Returns:

unique classification ID

getKey

String getKey()

Returns:

externally known key to the classification like a code or abbreviation.

getParentId

String getParentId()

Used to get the ID of the parent classification.

Returns:

unique ID or null if parent itself.

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.

getParentKey

String getParentKey()

Used to get the key of the parent classification.

Returns:

key of the parent classification or null if there is no parent.

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.

getCategory

String getCategory()

Returns:

category of this classification.

setCategory

void setCategory(String category)

Set/Change the category of this classification.

Parameters:

category - The category of the classification.

getType

String getType()

Get the type of the current classification.

Returns:

type

getDomain

String getDomain()

Get the current domain-name of this classification.

Returns:

domain name

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

java.time.Instant getCreated()

Get the timestamp when this classification was as created.

Returns:

created as instant

getModified

java.time.Instant getModified()

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

Returns:

modified as instant

getName

String getName()

Get the classification name.

Returns:

name

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

getPriority

int getPriority()

Get the current classification priority (numeric).

Returns:

priority

setPriority

void setPriority(int priority)

Set/Change the numeric priority of a classification.

Parameters:

priority - the Priority of the Classification

getServiceLevel

String getServiceLevel()

Get the current service level.

Returns:

serviceLevel

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.

getApplicationEntryPoint

String getApplicationEntryPoint()

Get the logical name of the associated application entry point.

Returns:

applicationEntryPoint

setApplicationEntryPoint

void setApplicationEntryPoint(String applicationEntryPoint)

Set the logical name of the associated application entry point.

Parameters:

applicationEntryPoint - The application entry point

getCustom1

String getCustom1()

Get the 1. custom-attribute.

Returns:

custom1

setCustom1

void setCustom1(String custom1)

Set/Change the 1. custom-attribute.

Parameters:

custom1 - the first custom attribute

getCustom2

String getCustom2()

Get the 2. custom-attribute.

Returns:

custom2

setCustom2

void setCustom2(String custom2)

Set/Change the 2. custom-attribute.

Parameters:

custom2 - the second custom attribute

getCustom3

String getCustom3()

Get the 3. custom-attribute.

Returns:

custom3

setCustom3

void setCustom3(String custom3)

Set/Change the 3. custom-attribute.

Parameters:

custom3 - the third custom attribute

getCustom4

String getCustom4()

Get the 4. custom-attribute.

Returns:

custom4

setCustom4

void setCustom4(String custom4)

Set/Change the 4. custom-attribute.

Parameters:

custom4 - the fourth custom attribute

getCustom5

String getCustom5()

Get the 5. custom-attribute.

Returns:

custom5

setCustom5

void setCustom5(String custom5)

Set/Change the 5. custom-attribute.

Parameters:

custom5 - the fifth custom attribute

getCustom6

String getCustom6()

Get the 6. custom-attribute.

Returns:

custom6

setCustom6

void setCustom6(String custom6)

Set/Change the 6. custom-attribute.

Parameters:

custom6 - the sixth custom attribute

getCustom7

String getCustom7()

Get the 7. custom-attribute.

Returns:

custom7

setCustom7

void setCustom7(String custom7)

Set/Change the 7. custom-attribute.

Parameters:

custom7 - the seventh custom attribute

getCustom8

String getCustom8()

Get the 8. custom-attribute.

Returns:

custom8

setCustom8

void setCustom8(String custom8)

Set/Change the 8. custom-attribute.

Parameters:

custom8 - the eight custom attribute

asSummary

ClassificationSummary asSummary()

Return a summary of the current Classification.

Returns:

the ClassificationSummary object for the current classification