org.proteios.core
Class HardwareConfiguration

java.lang.Object
  org.proteios.core.BasicItem<D>
      org.proteios.core.OwnedItem<D>
          org.proteios.core.SharedItem<D>
              org.proteios.core.CommonItem<D>
                  org.proteios.core.AnnotatedItem<D>
                      org.proteios.core.InstrumentConfiguration<HardwareConfigurationData>
                          org.proteios.core.HardwareConfiguration

All Implemented Interfaces:

AccessControlled, Annotatable, FileAttachable, Identifiable, Nameable, Ownable, Removable, Shareable

public class HardwareConfiguration
extends InstrumentConfiguration<HardwareConfigurationData>

This class represent hardware configuration items. A hardware configuration has information about the hardware used in an experiment.

Version:

2.0

Author:

Olle

Last modified

$Date: 2006-05-31 12:33:12Z $

Field Summary

static Item

TYPE The type of item represented by this class.

Fields inherited from class org.proteios.core.InstrumentConfiguration

MAX_DATETIME_LENGTH

Fields inherited from interface org.proteios.core.Nameable

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Method Summary

Set<Annotatable>	getAnnotatableParents() Always null.
Hardware	getHardware() Get the Hardware that is configured.
static ItemQuery<HardwareConfiguration>	getQuery() Get a query that returns hardwareconfiguration items.
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Check that: no item has been created from this hardwareconfiguration
void	setHardware(Hardware hardware) Set the Hardware that is configured.

Methods inherited from class org.proteios.core.InstrumentConfiguration

getDateTime, getFile, setDateTime, setFile

Methods inherited from class org.proteios.core.CommonItem

getDescription, getName, isRemoved, setDescription, setName, setRemoved

Methods inherited from class org.proteios.core.SharedItem

getItemKey, getProjectKey, isShared, setItemKey, setProjectKey

Methods inherited from class org.proteios.core.OwnedItem

getOwner, setOwner

Methods inherited from class org.proteios.core.BasicItem

checkPermission, equals, getDbControl, getId, getPermissions, getSessionControl, getVersion, hashCode, hasPermission, isDetached, isInDatabase, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.proteios.core.Identifiable

getId, getVersion

Methods inherited from interface org.proteios.core.AccessControlled

checkPermission, hasPermission

Methods inherited from interface org.proteios.core.Ownable

getOwner, setOwner

Field Detail

TYPE

public static final Item TYPE

The type of item represented by this class.

See Also:

Item.HARDWARECONFIGURATION, getType()

Method Detail

getQuery

public static ItemQuery<HardwareConfiguration> getQuery()

Get a query that returns hardwareconfiguration items.

Returns:

An ItemQuery object.

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.

Returns:

A value indicating the type of item

getAnnotatableParents

public Set<Annotatable> getAnnotatableParents()
                                       throws BaseException

Always null.

Throws:

BaseException

isUsed

public boolean isUsed()
               throws BaseException

Check that:

• no item has been created from this hardwareconfiguration

Specified by:

isUsed in class BasicItem<HardwareConfigurationData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getHardware

public Hardware getHardware()
                     throws BaseException

Get the Hardware that is configured.

Returns:

A Hardware object

Throws:

BaseException - If there is another error

setHardware

public void setHardware(Hardware hardware)
                 throws InvalidDataException

Set the Hardware that is configured.

Parameters:

hardware - The new Hardware item

Throws:

InvalidDataException - If the hardware is null