Package pro.taskana.workbasket.api.models

Interface WorkbasketSummary

All Known Subinterfaces:

Workbasket

All Known Implementing Classes:

WorkbasketImpl, WorkbasketSummaryImpl

public interface WorkbasketSummary

Interface for WorkbasketSummary. This is a specific short model-object which only contains the most important information.

Method Summary

Modifier and Type	Method	Description
WorkbasketSummary	copy()	Duplicates this WorkbasketSummary without the id.
String	getCustomAttribute(WorkbasketCustomField customField)	Deprecated. Use getCustomField(WorkbasketCustomField) instead
String	getCustomField(WorkbasketCustomField customField)	Returns the value of the specified WorkbasketCustomField of the Workbasket.
String	getDescription()	Returns the description of the Workbasket.
String	getDomain()	Returns the domain of the Workbasket.
String	getId()	Returns the id of the Workbasket.
String	getKey()	Returns the key of the Workbasket.
String	getName()	Returns the name of the Workbasket.
String	getOrgLevel1()	Returns the orglevel1 of the Workbasket.
String	getOrgLevel2()	Returns the orglevel2 of the Workbasket.
String	getOrgLevel3()	Returns the orglevel3 of the Workbasket.
String	getOrgLevel4()	Returns the orglevel4 of the Workbasket.
String	getOwner()	Returns the owner of the Workbasket.
WorkbasketType	getType()	Returns the type of the Workbasket.
boolean	isMarkedForDeletion()	Checks if the Workbasket is marked for deletion.

Method Detail

getId

String getId()

Returns the id of the Workbasket.

Returns:

id

getKey

String getKey()

Returns the key of the Workbasket.

Returns:

key

getName

String getName()

Returns the name of the Workbasket.

Returns:

name

getDescription

String getDescription()

Returns the description of the Workbasket.

Returns:

description

getOwner

String getOwner()

Returns the owner of the Workbasket.

Returns:

owner

getDomain

String getDomain()

Returns the domain of the Workbasket.

Returns:

domain

getType

WorkbasketType getType()

Returns the type of the Workbasket.

Returns:

type

getCustomAttribute

@Deprecated
String getCustomAttribute(WorkbasketCustomField customField)

Deprecated.

Use getCustomField(WorkbasketCustomField) instead

Returns the value of the specified WorkbasketCustomField of the Workbasket.

Parameters:

customField - identifies which WorkbasketCustomField is requested

Returns:

the value for the given WorkbasketCustomField

getCustomField

String getCustomField(WorkbasketCustomField customField)

Returns the value of the specified WorkbasketCustomField of the Workbasket.

Parameters:

customField - identifies which the value of the specified WorkbasketCustomField of the Workbasket is requested

Returns:

the value for the given the value of the specified WorkbasketCustomField of the Workbasket

getOrgLevel1

String getOrgLevel1()

Returns the orglevel1 of the Workbasket.

Returns:

orglevel1

getOrgLevel2

String getOrgLevel2()

Returns the orglevel2 of the Workbasket.

Returns:

orglevel2

getOrgLevel3

String getOrgLevel3()

Returns the orglevel3 of the Workbasket.

Returns:

orglevel3

getOrgLevel4

String getOrgLevel4()

Returns the orglevel4 of the Workbasket.

Returns:

orglevel4

isMarkedForDeletion

boolean isMarkedForDeletion()

Checks if the Workbasket is marked for deletion.

Returns:

the markedForDeletion flag

copy

WorkbasketSummary copy()

Duplicates this WorkbasketSummary without the id.

Returns:

a copy of this WorkbasketSummary