org.proteios.core
Class StainingEvent

java.lang.Object
  org.proteios.core.BasicItem<D>
      org.proteios.core.BioMaterialEvent<StainingEventData>
          org.proteios.core.StainingEvent

All Implemented Interfaces:

AccessControlled, Identifiable

public class StainingEvent
extends BioMaterialEvent<StainingEventData>

This class represent StainingEvent items. A StainingEvent has information about the stain in an experiment.

Version:

2.0

Author:

Olle

Last modified

$Date: 2006-09-12 12:33:12Z $

Field Summary

static Item

TYPE The type of item represented by this class.

Fields inherited from class org.proteios.core.BioMaterialEvent

MAX_COMMENT_LENGTH

Method Summary

Set<Annotatable>	getAnnotatableParents() Always null.
static StainingEvent	getById(DbControl dc, int id) Get a StainingEvent item when you know the id.
GelElectrophoresis	getGelElectrophoresis() Get the GelElectrophoresis this StainingEvent is associated with.
HardwareConfiguration	getHardwareSettings()
static ItemQuery<StainingEvent>	getQuery() Get a query that returns StainingEvent items.
String	getStain()
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Check that: no item has been created from this StainingEvent
void	setGelElectrophoresis(GelElectrophoresis gelElectrophoresis) Set the GelElectrophoresis this StainingEvent is associated with.
void	setHardwareSettings(HardwareConfiguration hardwareSettings)
void	setStain(String stain)

Methods inherited from class org.proteios.core.BioMaterialEvent

addSource, getBioMaterial, getComment, getEntryDate, getEventDate, getEventType, getPreviousBioMaterialEvent, getProtocol, getQuery, getSourceBioMaterials, getSources, getUsedQuantityInMicroLiters, getUsedQuantityInMicroLiters, getUser, removeSource, setBioMaterial, setComment, setEntryDate, setEventDate, setPreviousBioMaterialEvent, setProtocol, setUsedQuantityInMicroLiters, setUser

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

Field Detail

TYPE

public static final Item TYPE

The type of item represented by this class.

See Also:

Item.PROTEIOS_STAININGEVENT, getType()

Method Detail

getById

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

Get a StainingEvent item when you know the id.

Parameters:

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

id - The id of the item to load

Returns:

The StainingEvent item

Throws:

ItemNotFoundException - If an item with the specified id is not found

BaseException - If there is another error

getQuery

public static ItemQuery<StainingEvent> getQuery()

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

Specified by:

getType in interface Identifiable

Overrides:

getType in class BioMaterialEvent<StainingEventData>

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 StainingEvent

Overrides:

isUsed in class BioMaterialEvent<StainingEventData>

Returns:

Always false

Throws:

BaseException

getGelElectrophoresis

public GelElectrophoresis getGelElectrophoresis()
                                         throws BaseException

Get the GelElectrophoresis this StainingEvent is associated with.

Returns:

The GelElectrophoresis item or null if not known

Throws:

BaseException - If there is another error

setGelElectrophoresis

public void setGelElectrophoresis(GelElectrophoresis gelElectrophoresis)
                           throws BaseException

Set the GelElectrophoresis this StainingEvent is associated with.

Parameters:

gelElectrophoresis - The new GelElectrophoresis item

Throws:

BaseException - If there is another error

getStain

public String getStain()
                throws BaseException

Throws:

BaseException

setStain

public void setStain(String stain)
              throws InvalidDataException

Throws:

InvalidDataException

getHardwareSettings

public HardwareConfiguration getHardwareSettings()
                                          throws BaseException

Throws:

BaseException

setHardwareSettings

public void setHardwareSettings(HardwareConfiguration hardwareSettings)
                         throws InvalidDataException

Throws:

InvalidDataException