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 and Description
WorkbasketSummary	copy() Duplicates this WorkbasketSummary without the id.
String	getCustomAttribute(WorkbasketCustomField customField) Gets the custom attribute of the workbasket.
String	getDescription() Gets the description of the workbasket.
String	getDomain() Gets the domain of the workbasket.
String	getId() Gets the id of the workbasket.
String	getKey() Gets the key of the workbasket.
String	getName() Gets the name of the workbasket.
String	getOrgLevel1() Gets the orglevel1 property of the workbasket.
String	getOrgLevel2() Gets the orglevel2 property of the workbasket.
String	getOrgLevel3() Gets the orglevel3 property of the workbasket.
String	getOrgLevel4() Gets the orglevel4 property of the workbasket.
String	getOwner() Gets the owner of the workbasket.
WorkbasketType	getType() Gets the type of the workbasket.
boolean	isMarkedForDeletion() Gets the markedForDeletion property of the workbasket.

Method Detail

getId

String getId()

Gets the id of the workbasket.

Returns:

workbasketId

getKey

String getKey()

Gets the key of the workbasket.

Returns:

workbasketKey

getName

String getName()

Gets the name of the workbasket.

Returns:

workbasket's name

getDescription

String getDescription()

Gets the description of the workbasket.

Returns:

workbasket's description

getOwner

String getOwner()

Gets the owner of the workbasket.

Returns:

workbasket's owner

getDomain

String getDomain()

Gets the domain of the workbasket.

Returns:

workbasket's domain

getType

WorkbasketType getType()

Gets the type of the workbasket.

Returns:

workbasket's type

getCustomAttribute

String getCustomAttribute(WorkbasketCustomField customField)

Gets the custom attribute of the workbasket.

Parameters:

customField - identifies which custom attribute is requested.

Returns:

the value for the given customField

getOrgLevel1

String getOrgLevel1()

Gets the orglevel1 property of the workbasket.

Returns:

the workbasket's orglevel1 property

getOrgLevel2

String getOrgLevel2()

Gets the orglevel2 property of the workbasket.

Returns:

the workbasket's orglevel2 property

getOrgLevel3

String getOrgLevel3()

Gets the orglevel3 property of the workbasket.

Returns:

the workbasket's orglevel3 property

getOrgLevel4

String getOrgLevel4()

Gets the orglevel4 property of the workbasket.

Returns:

the workbasket's orglevel4 property

isMarkedForDeletion

boolean isMarkedForDeletion()

Gets the markedForDeletion property of the workbasket.

Returns:

the workbasket's markedForDeletion property

copy

WorkbasketSummary copy()

Duplicates this WorkbasketSummary without the id.

Returns:

a copy of this WorkbasketSummary