gov.nih.nci.mageom.domain.BioMaterial
Interface Treatment

All Superinterfaces:
BioEvent, Describable, Extendable, Identifiable
All Known Implementing Classes:
TreatmentImpl

public interface Treatment
extends BioEvent

The process by which a biomaterial is created (from source biomaterials). Treatments have an order and an action.

Version:
%I%, %G%

Method Summary
 OntologyEntry getAction()
          Returns the value of this Treatment object's action attribute.
 Measurement getActionMeasurement()
          Returns the value of this Treatment object's actionMeasurement attribute.
 CompoundMeasurement[] getCompoundMeasurements()
          Returns the value of this Treatment object's compoundMeasurements attribute.
 java.lang.Integer getOrder()
          Returns the value of this Treatment object's order attribute.
 BioMaterialMeasurement[] getSourceBioMaterialMeasurements()
          Returns the value of this Treatment object's sourceBioMaterialMeasurements attribute.
 void setAction(OntologyEntry p_action)
          Sets the action attribute.
 void setActionMeasurement(Measurement p_actionMeasurement)
          Sets the actionMeasurement attribute.
 void setCompoundMeasurements(CompoundMeasurement[] p_compoundMeasurements)
          Sets the compoundMeasurements attribute.
 void setOrder(java.lang.Integer p_order)
          Sets the order attribute.
 void setSourceBioMaterialMeasurements(BioMaterialMeasurement[] p_sourceBioMaterialMeasurements)
          Sets the sourceBioMaterialMeasurements attribute.
 
Methods inherited from interface gov.nih.nci.mageom.domain.BioEvent.BioEvent
getProtocolApplications, setProtocolApplications
 
Methods inherited from interface gov.nih.nci.mageom.domain.Identifiable
getIdentifier, getName, setIdentifier, setName
 
Methods inherited from interface gov.nih.nci.mageom.domain.Describable
getAuditTrail, getDescriptions, getSecurity, setAuditTrail, setDescriptions, setSecurity
 
Methods inherited from interface gov.nih.nci.mageom.domain.Extendable
getPropertySets, setPropertySets
 

Method Detail

setOrder

void setOrder(java.lang.Integer p_order)
Sets the order attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Treatment object.

Parameters:
p_order - The new value for order.
See Also:
getOrder()

getOrder

java.lang.Integer getOrder()
Returns the value of this Treatment object's order attribute. Description of order: The chronological order in which a treatment occurred (in relation to other treatments). More than one treatment can have the same chronological order indicating that they happened (or were caused to happen) simultaneously.

Returns:
int The value of order.

setActionMeasurement

void setActionMeasurement(Measurement p_actionMeasurement)
Sets the actionMeasurement attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Treatment object.

Parameters:
p_actionMeasurement - The new value for actionMeasurement.
See Also:
getActionMeasurement()

getActionMeasurement

Measurement getActionMeasurement()
Returns the value of this Treatment object's actionMeasurement attribute.

Returns:
gov.nih.nci.mageom.bean.Measurement.Measurement The value of actionMeasurement.
See Also:
Measurement

setSourceBioMaterialMeasurements

void setSourceBioMaterialMeasurements(BioMaterialMeasurement[] p_sourceBioMaterialMeasurements)
Sets the sourceBioMaterialMeasurements attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Treatment object.

Parameters:
p_sourceBioMaterialMeasurements - The new value for sourceBioMaterialMeasurements.
See Also:
getSourceBioMaterialMeasurements()

getSourceBioMaterialMeasurements

BioMaterialMeasurement[] getSourceBioMaterialMeasurements()
Returns the value of this Treatment object's sourceBioMaterialMeasurements attribute.

Returns:
gov.nih.nci.mageom.bean.BioMaterial.BioMaterialMeasurement[] The value of sourceBioMaterialMeasurements.
See Also:
BioMaterialMeasurement

setCompoundMeasurements

void setCompoundMeasurements(CompoundMeasurement[] p_compoundMeasurements)
Sets the compoundMeasurements attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Treatment object.

Parameters:
p_compoundMeasurements - The new value for compoundMeasurements.
See Also:
getCompoundMeasurements()

getCompoundMeasurements

CompoundMeasurement[] getCompoundMeasurements()
Returns the value of this Treatment object's compoundMeasurements attribute.

Returns:
gov.nih.nci.mageom.bean.BioMaterial.CompoundMeasurement[] The value of compoundMeasurements.
See Also:
CompoundMeasurement

setAction

void setAction(OntologyEntry p_action)
Sets the action attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Treatment object.

Parameters:
p_action - The new value for action.
See Also:
getAction()

getAction

OntologyEntry getAction()
Returns the value of this Treatment object's action attribute.

Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry The value of action.
See Also:
OntologyEntry