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.

Author:

bbr

Method Summary

Modifier and Type	Method and Description
WorkbasketAccessItem	copy() Duplicates this WorkbasketAccessItem without the id.
String	getAccessId() Returns the group id or user id 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 weather the given permission 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 permission 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:

the workbasket Id

getWorkbasketKey

String getWorkbasketKey()

Returns the Key of the referenced workbasket.

Returns:

the workbasket Key

getAccessId

String getAccessId()

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

Returns:

access id, 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:

access name, 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 permission for the referenced workbasket.

Parameters:

permission - the permission which is set.

value - the value for the permission.

getPermission

boolean getPermission(WorkbasketPermission permission)

Returns weather the given permission is permitted or not.

Parameters:

permission - the permission in question.

Returns:

True, when the given permission is permitted. Otherwise false.

copy

WorkbasketAccessItem copy()

Duplicates this WorkbasketAccessItem without the id.

Returns:

a copy of this WorkbasketAccessItem