2.17.2: 2011-06-17

net.sf.basedb.core
Interface Ownable

All Superinterfaces:
AccessControlled, Identifiable
All Known Subinterfaces:
DiskConsumable, Shareable
All Known Implementing Classes:
AnnotatedItem, AnnotationType, AnnotationTypeCategory, ArrayBatch, ArrayDesign, ArraySlide, BioMaterial, BioMaterialList, BioPlate, BioPlateEvent, BioSource, Client, CommonItem, Directory, Experiment, Extract, File, FileServer, Formula, Hardware, Hybridization, Job, JobAgent, Label, LabeledExtract, MeasuredBioMaterial, OwnedItem, PermissionTemplate, Plate, PlateMapping, PlateType, PluginConfiguration, PluginDefinition, Project, Protocol, RawBioAssay, ReporterList, Sample, Scan, SharedItem, Software

public interface Ownable
extends Identifiable

An 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);
}

Version:
2.0
Author:
Nicklas
See Also:
OwnedItem, OwnableUtil
Last modified
$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

Method Summary
 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.
 
Methods inherited from interface net.sf.basedb.core.Identifiable
getId, getType, getVersion
 
Methods inherited from interface net.sf.basedb.core.AccessControlled
checkPermission, getPermissions, hasPermission
 

Method Detail

getOwner

User getOwner()
              throws PermissionDeniedException,
                     BaseException
Get the User that is the owner of the item.

Returns:
The owner of the item
Throws:
PermissionDeniedException - If the logged in user doesn't have read permission to the owner
BaseException - If there is another error

setOwner

void setOwner(User owner)
              throws PermissionDeniedException,
                     InvalidDataException
Change the owner of the item.

Parameters:
owner - The new owner of the item
Throws:
PermissionDeniedException - If the logged in user doesn't have permission to change the owner on the item
InvalidDataException - If the owner is null
See Also:
takeOwnership()

takeOwnership

void takeOwnership()
                   throws PermissionDeniedException
Take ownership of the item.

Throws:
PermissionDeniedException - If the logged in user doesn't have permission to take ownership
Since:
2.2

isOwner

boolean isOwner()
Check if the logged in user is the owner of this item or not.

Returns:
TRUE if the logged in user is the owner, FALSE otherwise
Since:
2.2

2.17.2: 2011-06-17