org.proteios.core
Class SoftwareConfiguration

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<SoftwareConfigurationData>
                          org.proteios.core.SoftwareConfiguration

All Implemented Interfaces:

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

public class SoftwareConfiguration
extends InstrumentConfiguration<SoftwareConfigurationData>

This class represent software configuration items. A software configuration has information about the software 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.
static ItemQuery<SoftwareConfiguration>	getQuery() Get a query that returns softwareconfiguration items.
Software	getSoftware() Get the Software that is configured.
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Check that: no item has been created from this softwareconfiguration
void	setSoftware(Software software) Set the Software 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.SOFTWARECONFIGURATION, getType()

Method Detail

getQuery

public static ItemQuery<SoftwareConfiguration> getQuery()

Get a query that returns softwareconfiguration 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 softwareconfiguration

Specified by:

isUsed in class BasicItem<SoftwareConfigurationData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getSoftware

public Software getSoftware()
                     throws BaseException

Get the Software that is configured.

Returns:

A Software object

Throws:

BaseException - If there is another error

setSoftware

public void setSoftware(Software software)
                 throws InvalidDataException

Set the Software that is configured.

Parameters:

software - The new Software item

Throws:

InvalidDataException - If the software is null