Package pro.taskana.workbasket.api.models

Interface WorkbasketAccessItem

All Known Implementing Classes:

WorkbasketAccessItemImpl

public interface WorkbasketAccessItem

Interface for WorkbasketAccessItem. This interface is used to control access of users to Workbaskets.

Method Summary

Modifier and Type	Method	Description
WorkbasketAccessItem	copy()	Duplicates this WorkbasketAccessItem without the id.
String	getAccessId()	Returns the id of the group or the user for which this WorkbasketAccessItem controls access permissions.
String	getAccessName()	Returns the name of the group or user for which this WorkbasketAccessItem controls access permissions.
String	getId()	Returns the current id of the WorkbasketAccessItem.
boolean	getPermission(WorkbasketPermission permission)	Returns whether the given permissions is permitted or not.
String	getWorkbasketId()	Returns the id of the referenced Workbasket.
String	getWorkbasketKey()	Returns the key of the referenced Workbasket.
void	setAccessName(String name)	Set the name of the group or user for which this WorkbasketAccessItem controls access permissions.
void	setPermission(WorkbasketPermission permission, boolean value)	Sets a given permissions for the referenced Workbasket.

Method Detail

getId

String getId()

Returns the current id of the WorkbasketAccessItem.

Returns:

id

getWorkbasketId

String getWorkbasketId()

Returns the id of the referenced Workbasket.

Returns:

workbasketId

getWorkbasketKey

String getWorkbasketKey()

Returns the key of the referenced Workbasket.

Returns:

key

getAccessId

String getAccessId()

Returns the id of the group or the user for which this WorkbasketAccessItem controls access permissions.

Returns:

the accessId, this is the group id or user id

getAccessName

String getAccessName()

Returns the name of the group or user for which this WorkbasketAccessItem controls access permissions.

Returns:

the accessName, this is the name of the group or user

setAccessName

void setAccessName(String name)

Set the name of the group or user for which this WorkbasketAccessItem controls access permissions.

Parameters:

name - the name of the group or user for which this WorkbasketAccessItem controls access permissions

setPermission

void setPermission(WorkbasketPermission permission,
                   boolean value)

Sets a given permissions for the referenced Workbasket.

Parameters:

permission - the permissions which is set

value - the value for the permissions

getPermission

boolean getPermission(WorkbasketPermission permission)

Returns whether the given permissions is permitted or not.

Parameters:

permission - the permissions in question

Returns:

True, if the given permissions is permitted; otherwise false

copy

WorkbasketAccessItem copy()

Duplicates this WorkbasketAccessItem without the id.

Returns:

a copy of this WorkbasketAccessItem