org.proteios.core
Class DataProcessingStep

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<DataProcessingStepData>
                      org.proteios.core.DataProcessingStep

All Implemented Interfaces:

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

public class DataProcessingStep
extends AnnotatedItem<DataProcessingStepData>

This class represent data processing steps items. It contains information on the data processing steps of the peak list sets in an experiment.

Version:

2.0

Author:

Olle

Last modified

$Date: 2006-06-02 11:33:12Z $

Field Summary

static int	MAX_DESCRIPTION_LENGTH The maximum length of the description string that can be stored in the database.
static Item	TYPE The type of item represented by this class.

Fields inherited from interface org.proteios.core.Nameable

MAX_NAME_LENGTH

Method Summary

Set<Annotatable>	getAnnotatableParents() Always null.
Date	getCompletionTime() Get the completionTime date.
String	getDescription() Get the description of this DataProcessingStep.
static ItemQuery<DataProcessingStep>	getQuery() Get a query that returns dataprocessingstep items.
Software	getSoftware() Get the Software software.
Item	getType() Get the type of item represented by the object.
boolean	isUsed() Check that: no item has been created from this dataprocessingstep
void	setCompletionTime(Date completionTime) Set the completionTime date.
void	setDescription(String description) Set the description for this DataProcessingStep item.
void	setSoftware(Software software) Set the Software software.

Methods inherited from class org.proteios.core.CommonItem

getName, isRemoved, 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.PROTEIOS_DATAPROCESSINGSTEP, getType()

MAX_DESCRIPTION_LENGTH

public static final int MAX_DESCRIPTION_LENGTH

The maximum length of the description string that can be stored in the database.

See Also:

setDescription(String), Constant Field Values

Method Detail

getQuery

public static ItemQuery<DataProcessingStep> getQuery()

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

Specified by:

isUsed in class BasicItem<DataProcessingStepData>

Returns:

TRUE if this item is used, FALSE otherwise

Throws:

BaseException

getCompletionTime

public Date getCompletionTime()

Get the completionTime date.

Returns:

A Date object, or null if not known

setCompletionTime

public void setCompletionTime(Date completionTime)
                       throws PermissionDeniedException

Set the completionTime date.

Parameters:

completionTime - The date, or null if not known

Throws:

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

getDescription

public String getDescription()

Get the description of this DataProcessingStep.

Specified by:

getDescription in interface Nameable

Overrides:

getDescription in class CommonItem<DataProcessingStepData>

Returns:

the description of this data processing step

setDescription

public void setDescription(String description)
                    throws PermissionDeniedException,
                           InvalidDataException

Set the description for this DataProcessingStep item. The value may be null but must not be longer than the value specified by the MAX_DESCRIPTION_LENGTH constant.

Specified by:

setDescription in interface Nameable

Overrides:

setDescription in class CommonItem<DataProcessingStepData>

Parameters:

description - The new description for this item

Throws:

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

InvalidDataException - If the description is longer than MAX_DESCRIPTION_LENGTH

getSoftware

public Software getSoftware()
                     throws PermissionDeniedException,
                            BaseException

Get the Software software.

Returns:

A Software object

Throws:

PermissionDeniedException - If the logged in user doesn't have read permission for the instrumentconfiguration

BaseException - If there is another error

setSoftware

public void setSoftware(Software software)
                 throws PermissionDeniedException,
                        InvalidDataException

Set the Software software.

Parameters:

software - The new Software item

Throws:

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

InvalidDataException - If software is null

BaseException - If there is another error