Package pro.taskana.workbasket.api.models

Interface Workbasket

All Superinterfaces:

WorkbasketSummary

All Known Implementing Classes:

WorkbasketImpl

public interface Workbasket
extends WorkbasketSummary

Workbasket entity interface.

Method Summary

Modifier and Type	Method	Description
WorkbasketSummary	asSummary()	Return a summary of the current workbasket.
Workbasket	copy(String key)	Duplicates this Workbasket without the id.
Instant	getCreated()	Returns the date when the workbasket was created.
Instant	getModified()	Returns the date when the workbasket was modified the last time.
boolean	isMarkedForDeletion()	Return the value for the markedForDeletion attribute.
void	setCustomAttribute(WorkbasketCustomField customField, String value)	Deprecated. Use setCustomField(WorkbasketCustomField, String) instead
void	setCustomField(WorkbasketCustomField customField, String value)	Sets the value for custom field.
void	setDescription(String description)	Sets the workbasket-descriptions.
void	setMarkedForDeletion(boolean markedForDeletion)	Sets the value for markedForDeletion attribute.
void	setName(String workbasketName)	Sets the name of the workbasket.
void	setOrgLevel1(String orgLevel1)	Sets the value for orgLevel1 attribute.
void	setOrgLevel2(String orgLevel2)	Sets the value for orgLevel2 attribute.
void	setOrgLevel3(String orgLevel3)	Sets the value for orgLevel3 attribute.
void	setOrgLevel4(String orgLevel4)	Sets the value for orgLevel4 attribute.
void	setOwner(String owner)	Sets the owner-ID of the workbasket.
void	setType(WorkbasketType type)	Sets the type of the workbasket.

Methods inherited from interface pro.taskana.workbasket.api.models.WorkbasketSummary

copy, getCustomAttribute, getCustomField, getDescription, getDomain, getId, getKey, getName, getOrgLevel1, getOrgLevel2, getOrgLevel3, getOrgLevel4, getOwner, getType

Method Detail

setName

void setName(String workbasketName)

Sets the name of the workbasket.

Parameters:

workbasketName - the name of the workbasket

setDescription

void setDescription(String description)

Sets the workbasket-descriptions.

Parameters:

description - the description of the workbasket

setType

void setType(WorkbasketType type)

Sets the type of the workbasket.

Parameters:

type - the type of the workbasket

setCustomAttribute

void setCustomAttribute(WorkbasketCustomField customField,
                        String value)

Deprecated.

Use setCustomField(WorkbasketCustomField, String) instead

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

setCustomField

void setCustomField(WorkbasketCustomField customField,
                    String value)

Sets the value for custom field.

Parameters:

customField - identifies which custom field is to be set.

value - the value of the custom field to be set

setOrgLevel1

void setOrgLevel1(String orgLevel1)

Sets the value for orgLevel1 attribute.

Parameters:

orgLevel1 - the orgLevel1 property of the workbasket

setOrgLevel2

void setOrgLevel2(String orgLevel2)

Sets the value for orgLevel2 attribute.

Parameters:

orgLevel2 - the orgLevel2 property of the workbasket

setOrgLevel3

void setOrgLevel3(String orgLevel3)

Sets the value for orgLevel3 attribute.

Parameters:

orgLevel3 - the orgLevel3 property of the workbasket

setOrgLevel4

void setOrgLevel4(String orgLevel4)

Sets the value for orgLevel4 attribute.

Parameters:

orgLevel4 - the orgLevel4 property of the workbasket

isMarkedForDeletion

boolean isMarkedForDeletion()

Return the value for the markedForDeletion attribute.

Specified by:

isMarkedForDeletion in interface WorkbasketSummary

Returns:

markedForDeletion

setMarkedForDeletion

void setMarkedForDeletion(boolean markedForDeletion)

Sets the value for markedForDeletion attribute.

Parameters:

markedForDeletion - the markedForDeletion property of the workbasket

copy

Workbasket copy(String key)

Duplicates this Workbasket without the id.

Parameters:

key - for the new Workbasket

Returns:

a copy of this Workbasket

setOwner

void setOwner(String owner)

Sets the owner-ID of the workbasket.

Parameters:

owner - of the current workbasket

getCreated

Instant getCreated()

Returns the date when the workbasket was created.

Returns:

created as Instant

getModified

Instant getModified()

Returns the date when the workbasket was modified the last time.

Returns:

modified as Instant

asSummary

WorkbasketSummary asSummary()

Return a summary of the current workbasket.

Returns:

the WorkbasketSummary object for the current work basket