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

All Superinterfaces:
Describable, Extendable, Identifiable
All Known Implementing Classes:
CompoundImpl

public interface Compound
extends Identifiable

A Compound can be a simple compound such as SDS (sodium dodecyl sulfate). It may also be made of other Compounds in proportions using CompoundMeasurements to enumerate the Compounds and their amounts such as LB (Luria Broth) Media.

Version:
%I%, %G%

Method Summary
 CompoundMeasurement[] getComponentCompounds()
          Returns the value of this Compound object's componentCompounds attribute.
 OntologyEntry[] getCompoundIndices()
          Returns the value of this Compound object's compoundIndices attribute.
 DatabaseEntry getExternalLIMS()
          Returns the value of this Compound object's externalLIMS attribute.
 java.lang.Boolean getIsSolvent()
          Returns the value of this Compound object's isSolvent attribute.
 void setComponentCompounds(CompoundMeasurement[] p_componentCompounds)
          Sets the componentCompounds attribute.
 void setCompoundIndices(OntologyEntry[] p_compoundIndices)
          Sets the compoundIndices attribute.
 void setExternalLIMS(DatabaseEntry p_externalLIMS)
          Sets the externalLIMS attribute.
 void setIsSolvent(java.lang.Boolean p_isSolvent)
          Sets the isSolvent attribute.
 
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

setIsSolvent

void setIsSolvent(java.lang.Boolean p_isSolvent)
Sets the isSolvent attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Compound object.

Parameters:
p_isSolvent - The new value for isSolvent.
See Also:
getIsSolvent()

getIsSolvent

java.lang.Boolean getIsSolvent()
Returns the value of this Compound object's isSolvent attribute. Description of isSolvent: A Compound may be a special case Solvent.

Returns:
boolean The value of isSolvent.

setComponentCompounds

void setComponentCompounds(CompoundMeasurement[] p_componentCompounds)
Sets the componentCompounds attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Compound object.

Parameters:
p_componentCompounds - The new value for componentCompounds.
See Also:
getComponentCompounds()

getComponentCompounds

CompoundMeasurement[] getComponentCompounds()
Returns the value of this Compound object's componentCompounds attribute.

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

setCompoundIndices

void setCompoundIndices(OntologyEntry[] p_compoundIndices)
Sets the compoundIndices attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Compound object.

Parameters:
p_compoundIndices - The new value for compoundIndices.
See Also:
getCompoundIndices()

getCompoundIndices

OntologyEntry[] getCompoundIndices()
Returns the value of this Compound object's compoundIndices attribute.

Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry[] The value of compoundIndices.
See Also:
OntologyEntry

setExternalLIMS

void setExternalLIMS(DatabaseEntry p_externalLIMS)
Sets the externalLIMS attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Compound object.

Parameters:
p_externalLIMS - The new value for externalLIMS.
See Also:
getExternalLIMS()

getExternalLIMS

DatabaseEntry getExternalLIMS()
Returns the value of this Compound object's externalLIMS attribute.

Returns:
gov.nih.nci.mageom.bean.Description.DatabaseEntry The value of externalLIMS.
See Also:
DatabaseEntry