net.sf.basedb.core
Class HardwareType

java.lang.Object
  net.sf.basedb.core.BasicItem<HardwareTypeData>
      net.sf.basedb.core.HardwareType

All Implemented Interfaces:

AccessControlled, Identifiable, Nameable, Registered, Removable, SystemItem

public class HardwareType
extends BasicItem<HardwareTypeData>
implements Nameable, SystemItem, Removable, Registered

This class is used to represent the type of Hardware items in BASE. It is not possible for client applications to create new hardware types or modify existing ones.

Version:

2.0

Author:

enell

See Also:

Hardware

Last modified

$Date: 2010-05-07 12:30:10 +0200 (Fri, 07 May 2010) $

Field Summary

static String	FREEZER The id for the HardwareType object representing a freezer.
static String	HYBRIDIZATION_STATION The id for the HardwareType object representing a hybridization station.
static String	OTHER The id for the HardwareType object representing something else.
static String	PRINT_ROBOT The id for the HardwareType object representing a print robot.
static String	SCANNER The id for the HardwareType object representing a scanner.
static Item	TYPE The type of item represented by this class.

Fields inherited from interface net.sf.basedb.core.Nameable

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Fields inherited from interface net.sf.basedb.core.SystemItem

MAX_SYSTEM_ID_LENGTH

Constructor Summary

HardwareType(HardwareTypeData data)
Creates a hardwaretype item.

Method Summary

static HardwareType	getById(DbControl dc, int id) Get a HardwareType object when you know the ID.
String	getDescription() Get the description for the item.
Date	getEntryDate() Get the date that the item was registered in the database.
ItemQuery<Hardware>	getHardware() Get a query that returns all hardware of this type
String	getName() Get the name of the item.
static HardwareType	getNew(DbControl dc) Create a new HardwareType item.
static ItemQuery<HardwareType>	getQuery() Get a query configured to retrieve hardware types.
String	getSystemId() Get the system id for the item.
Item	getType() Get the type of item represented by the object.
Set<ItemProxy>	getUsingItems() Get all: Hardware:s if this type
(package private) void	initPermissions(int granted, int denied) If this is a system hardware type, delete and create permissions are revoked.
boolean	isRemoved() Check if the removed flag is set for this item.
boolean	isSystemItem() Check if the item is a system item or not.
boolean	isUsed() Check if: A Hardware of this type exists
Hardware	newHardware() Create a new Hardware item of this type.
void	setDescription(String description) Set the description for the item.
void	setName(String name) Set the name of the item.
void	setRemoved(boolean removed) Set the removed flag for this item.

Methods inherited from class net.sf.basedb.core.BasicItem

addUsingItems, addUsingItems, checkPermission, equals, getData, getDbControl, getId, getPermissions, getPluginPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, onAfterCommit, onAfterInsert, onBeforeCommit, onRollback, setDbControl, setProjectDefaults, toString, toTransferable, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.sf.basedb.core.Identifiable

getId, getVersion

Methods inherited from interface net.sf.basedb.core.AccessControlled

checkPermission, getPermissions, hasPermission

Field Detail

TYPE

public static final Item TYPE

The type of item represented by this class.

See Also:

ITEM.FILETYPE, getType()

SCANNER

public static final String SCANNER

The id for the HardwareType object representing a scanner.

See Also:

Constant Field Values

PRINT_ROBOT

public static final String PRINT_ROBOT

The id for the HardwareType object representing a print robot.

See Also:

Constant Field Values

HYBRIDIZATION_STATION

public static final String HYBRIDIZATION_STATION

The id for the HardwareType object representing a hybridization station.

See Also:

Constant Field Values

FREEZER

public static final String FREEZER

The id for the HardwareType object representing a freezer.

See Also:

Constant Field Values

OTHER

public static final String OTHER

The id for the HardwareType object representing something else.

Since:

2.16

See Also:

Constant Field Values

Constructor Detail

HardwareType

HardwareType(HardwareTypeData data)

Creates a hardwaretype item.

Parameters:

data - the data

Method Detail

getNew

public static HardwareType getNew(DbControl dc)
                           throws BaseException

Create a new HardwareType item.

Parameters:

dc - The DbControl which will be used for permission checking and database access

Returns:

The new HardwareType item

Throws:

BaseException - If there is an error

getById

public static HardwareType getById(DbControl dc,
                                   int id)
                            throws ItemNotFoundException,
                                   PermissionDeniedException,
                                   BaseException

Get a HardwareType object when you know the ID.

Parameters:

dc - The DbControl which will be used for permission checking and database access.

id - The system ID of the item to load.

Returns:

The HardwareType item

Throws:

ItemNotFoundException - This exception is thrown if an item with the specified ID is not found

PermissionDeniedException - This exception is thrown if the logged in user doesn't have READ permission to the item

BaseException - This exception is thrown if there is another error

getQuery

public static ItemQuery<HardwareType> getQuery()

Get a query configured to retrieve hardware types.

Returns:

An ItemQuery object

getEntryDate

public Date getEntryDate()

Description copied from interface: Registered

Get the date that the item was registered in the database.

Specified by:

getEntryDate in interface Registered

Returns:

A date or null if this is not known

isUsed

public boolean isUsed()
               throws BaseException

Check if:

• A Hardware of this type exists

Overrides:

isUsed in class BasicItem<HardwareTypeData>

Returns:

TRUE if the hardwaretype is used.

Throws:

BaseException - If there is an error.

See Also:

BasicItem.getUsingItems()

getUsingItems

public Set<ItemProxy> getUsingItems()

Get all:

• Hardware:s if this type

  Overrides:

  getUsingItems in class BasicItem<HardwareTypeData>

  Returns:

  A set containing proxies for the items, or an empty set if no items are using this item

  Since:

  2.2

  See Also:

  BasicItem.addUsingItems(Set, Item, org.hibernate.Query)

initPermissions

void initPermissions(int granted,
                     int denied)
               throws BaseException

If this is a system hardware type, delete and create permissions are revoked.

Overrides:

initPermissions in class BasicItem<HardwareTypeData>

Parameters:

granted - Permissions that have been granted by the subclass

denied - Permissions that have been denied by the subclass

Throws:

BaseException - If the permissions couldn't be initialised

getType

public Item getType()

Description copied from interface: Identifiable

Get the type of item represented by the object. The returned value is one of the values defined in the Item enumeration.

Specified by:

getType in interface Identifiable

Returns:

A value indicating the type of item

isRemoved

public boolean isRemoved()

Description copied from interface: Removable

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface Removable

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)
                throws PermissionDeniedException

Description copied from interface: Removable

Set the removed flag for this item.

Specified by:

setRemoved in interface Removable

Parameters:

removed - TRUE if the item should be flagged as removed, FALSE otherwise

Throws:

PermissionDeniedException - If the logged in user doesn't have Permission.DELETE permission for setting the flag to TRUE or Permission.WRITE permission for setting the flag to FALSE

getSystemId

public String getSystemId()

Description copied from interface: SystemItem

Get the system id for the item.

Specified by:

getSystemId in interface SystemItem

Returns:

The id of the item or null if it is not a system item

isSystemItem

public boolean isSystemItem()

Description copied from interface: SystemItem

Check if the item is a system item or not. A system item have a non-null value for the system id.

Specified by:

isSystemItem in interface SystemItem

Returns:

TRUE if this item is a system item, FALSE otherwise

getName

public String getName()

Description copied from interface: Nameable

Get the name of the item.

Specified by:

getName in interface Nameable

Returns:

A String with the name of the item

setName

public void setName(String name)
             throws PermissionDeniedException,
                    InvalidDataException

Description copied from interface: Nameable

Set the name of the item. The name cannot be null and mustn't be longer than the value specified by the Nameable.MAX_NAME_LENGTH constant.

Specified by:

setName in interface Nameable

Parameters:

name - The new name for the item

Throws:

PermissionDeniedException - If the logged in user doesn't have write permission

InvalidDataException - If the name is null or longer than specified by the Nameable.MAX_NAME_LENGTH constant

getDescription

public String getDescription()

Description copied from interface: Nameable

Get the description for the item.

Specified by:

getDescription in interface Nameable

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)
                    throws PermissionDeniedException,
                           InvalidDataException

Description copied from interface: Nameable

Set the description for the item. The description can be null but mustn't be longer than the value specified by the Nameable.MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface Nameable

Parameters:

description - The new description for the item

Throws:

PermissionDeniedException - If the logged in user doesn't have write permission

InvalidDataException - If the description longer than specified by the Nameable.MAX_DESCRIPTION_LENGTH constant

newHardware

public Hardware newHardware()
                     throws PermissionDeniedException,
                            BaseException

Create a new Hardware item of this type.

Returns:

The new Hardware item

Throws:

DetachedItemException - If this HardwareType is detached from DbControl.

PermissionDeniedException - This exception is thrown if the logged in user doesn't have CREATE permission for hardware items or USE permission for this hardware type

BaseException - This exception is thrown if there is another error

getHardware

public ItemQuery<Hardware> getHardware()

Get a query that returns all hardware of this type

Returns:

An ItemQuery object