net.sf.basedb.core.data
Class PlateEventTypeData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.PlateEventTypeData

All Implemented Interfaces:

IdentifiableData, NameableData, RemovableData

public class PlateEventTypeData
extends BasicData
implements NameableData, RemovableData

This class holds information about a plate event type.

Version:

2.0

Author:

Nicklas

See Also:

PlateEventType, Array LIMS - Plates overview

Last modified

$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

Hibernate: class

table="`PlateEventTypes`" lazy="false"

Field Summary

private String	description
private String	name
private int	ordinal
private Set<PlateEventData>	plateEvents
private PlateTypeData	plateType
private ProtocolTypeData	protocolType
private boolean	removed

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

PlateEventTypeData()

Method Summary

String	getDescription() Get the description for the item.
String	getName() Get the name of the item.
int	getOrdinal() The ordinal of this event type among all event types defined for the plate type.
(package private) Set<PlateEventData>	getPlateEvents() This is the inverse end.
PlateTypeData	getPlateType() The plate type this event type belongs to.
ProtocolTypeData	getProtocolType() The protocol type that events of this event type should pick their protocols from.
boolean	isRemoved() Check if the removed flag is set for this item.
void	setDescription(String description) Set the description for the item.
void	setName(String name) Set the name of the item.
void	setOrdinal(int ordinal)
(package private) void	setPlateEvents(Set<PlateEventData> plateEvents)
void	setPlateType(PlateTypeData plateType)
void	setProtocolType(ProtocolTypeData protocolType)
void	setRemoved(boolean removed) Set the removed flag for this item.

Methods inherited from class net.sf.basedb.core.data.BasicData

equals, getId, getVersion, hashCode, setId, setVersion, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.basedb.core.data.IdentifiableData

getId, getVersion

Field Detail

name

private String name

description

private String description

removed

private boolean removed

plateType

private PlateTypeData plateType

ordinal

private int ordinal

protocolType

private ProtocolTypeData protocolType

plateEvents

private Set<PlateEventData> plateEvents

Constructor Detail

PlateEventTypeData

public PlateEventTypeData()

Method Detail

getName

public String getName()

Description copied from interface: NameableData

Get the name of the item.

Specified by:

getName in interface NameableData

Returns:

A String with the name of the item

setName

public void setName(String name)

Description copied from interface: NameableData

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

Specified by:

setName in interface NameableData

Parameters:

name - The new name for the item

getDescription

public String getDescription()

Description copied from interface: NameableData

Get the description for the item.

Specified by:

getDescription in interface NameableData

Returns:

A String with a description of the item

setDescription

public void setDescription(String description)

Description copied from interface: NameableData

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

Specified by:

setDescription in interface NameableData

Parameters:

description - The new description for the item

isRemoved

public boolean isRemoved()

Description copied from interface: RemovableData

Check if the removed flag is set for this item.

Specified by:

isRemoved in interface RemovableData

Returns:

TRUE if the item is flagged as removed, FALSE otherwise

setRemoved

public void setRemoved(boolean removed)

Description copied from interface: RemovableData

Set the removed flag for this item.

Specified by:

setRemoved in interface RemovableData

Parameters:

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

getPlateType

public PlateTypeData getPlateType()

The plate type this event type belongs to.

See Also:

PlateTypeData.getEventTypes()

Hibernate: many-to-one

column="`platetype_id`" not-null="true" outer-join="false" update="false"

setPlateType

public void setPlateType(PlateTypeData plateType)

getOrdinal

public int getOrdinal()

The ordinal of this event type among all event types defined for the plate type.

Hibernate: property

column="`ordinal`" type="int" not-null="true"

setOrdinal

public void setOrdinal(int ordinal)

getProtocolType

public ProtocolTypeData getProtocolType()

The protocol type that events of this event type should pick their protocols from.

Hibernate: many-to-one

column="`protocoltype_id`" outer-join="false" not-null="false"

setProtocolType

public void setProtocolType(ProtocolTypeData protocolType)

getPlateEvents

Set<PlateEventData> getPlateEvents()

This is the inverse end.

See Also:

PlateEventData.getPlateEventType()

Hibernate: set

lazy="true" inverse="true"

Hibernate: collection-key

column="`plateeventtype_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.PlateEventData"

setPlateEvents

void setPlateEvents(Set<PlateEventData> plateEvents)