public interface Ownable extends Identifiable
Ownable
item is an item which has a User
as its owner.
The OwnableUtil
class provides methods that includes data validation
to make it easy to implement this interface.
Reference implementation
public User getOwner() throws PermissionDeniedException, BaseException { return getDbControl().getItem(User.class, getData().getOwner()); } public void setOwner(User owner) throws PermissionDeniedException, InvalidDataException { checkPermission(Permission.SET_OWNER); OwnableUtil.setOwner(getData(), owner); }
OwnedItem
,
OwnableUtil
Modifier and Type | Method and Description |
---|---|
User |
getOwner()
Get the
User that is the owner of the item. |
boolean |
isOwner()
Check if the logged in user is the owner of this item or not.
|
void |
setOwner(User owner)
Change the owner of the item.
|
void |
takeOwnership()
Take ownership of the item.
|
getId, getType, getVersion
checkPermission, getPermissions, hasPermission
User getOwner() throws PermissionDeniedException, BaseException
User
that is the owner of the item.PermissionDeniedException
- If the logged in user doesn't
have read permission to the ownerBaseException
- If there is another errorvoid setOwner(User owner) throws PermissionDeniedException, InvalidDataException
owner
- The new owner of the itemPermissionDeniedException
- If the logged in user doesn't
have permission to change the owner on the itemInvalidDataException
- If the owner is nulltakeOwnership()
void takeOwnership() throws PermissionDeniedException
PermissionDeniedException
- If the logged in user doesn't have
permission to take ownershipboolean isOwner()