gov.nih.nci.mageom.domain.Protocol.impl
Class HardwareApplicationImpl

java.lang.Object
  extended by gov.nih.nci.mageom.domain.impl.MAGEOMObject
      extended by gov.nih.nci.mageom.domain.impl.ExtendableImpl
          extended by gov.nih.nci.mageom.domain.impl.DescribableImpl
              extended by gov.nih.nci.mageom.domain.Protocol.impl.ParameterizableApplicationImpl
                  extended by gov.nih.nci.mageom.domain.Protocol.impl.HardwareApplicationImpl
All Implemented Interfaces:
Describable, Extendable, HardwareApplication, ParameterizableApplication, java.io.Serializable

public class HardwareApplicationImpl
extends ParameterizableApplicationImpl
implements HardwareApplication

The use of a piece of hardware with the requisite Parameters and ParameterValues.

Version:
%I%, %G%
See Also:
Serialized Form

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  Hardware hardware
          DOCUMENT ME
protected  java.lang.Long hardwareId
          The internal ID of the associated hardware object.
protected  java.lang.String serialNumber
          Manufacturer's identifier for the Hardware.
 
Fields inherited from class gov.nih.nci.mageom.domain.Protocol.impl.ParameterizableApplicationImpl
parameterValues, parameterValuesCount
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.DescribableImpl
auditTrail, auditTrailCount, descriptions, descriptionsCount, security, securityId
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
HardwareApplicationImpl()
          Default constructor
 
Method Summary
 Hardware getHardware()
          Returns the value of this HardwareApplication object's hardware attribute.
 java.lang.String getSerialNumber()
          Returns the value of this HardwareApplication object's serialNumber attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 HardwareApplication[] searchHardwareApplications(HardwareApplicationSearchCriteria criteria)
          Returns an array of HardwareApplication objects that satisfy the given HardwareApplicationSearchCriteria.
 void setHardware(Hardware p_hardware)
          Sets the hardware attribute.
 void setSerialNumber(java.lang.String p_serialNumber)
          Sets the serialNumber attribute.
 java.lang.String toString()
          Returns a String representation of this object suitable for console display.
 org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc, java.util.ArrayList fillOutValues)
          Returns an XML representation of the object.
 
Methods inherited from class gov.nih.nci.mageom.domain.Protocol.impl.ParameterizableApplicationImpl
getParameterValues, getParameterValuesCount, searchParameterizableApplications, setParameterValues
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.DescribableImpl
getAuditTrail, getAuditTrailCount, getDescriptions, getDescriptionsCount, getSecurity, searchDescribables, setAuditTrail, setDescriptions, setSecurity
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
getPropertySets, getPropertySetsCount, getSecuredElementId, searchExtendables, setPropertySets, setSecuredElementId
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.MAGEOMObject
getId, getIsEditable, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.nih.nci.mageom.domain.Protocol.ParameterizableApplication
getParameterValues, setParameterValues
 
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
 

Field Detail

allAssociationMethods

protected static java.util.ArrayList allAssociationMethods

associationMethods

protected static java.util.Hashtable associationMethods

serialNumber

protected java.lang.String serialNumber
Manufacturer's identifier for the Hardware.


hardware

protected Hardware hardware
DOCUMENT ME


hardwareId

protected java.lang.Long hardwareId
The internal ID of the associated hardware object.

Constructor Detail

HardwareApplicationImpl

public HardwareApplicationImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ParameterizableApplicationImpl

searchHardwareApplications

public HardwareApplication[] searchHardwareApplications(HardwareApplicationSearchCriteria criteria)
                                                 throws gov.nih.nci.common.search.SearchException
Returns an array of HardwareApplication objects that satisfy the given HardwareApplicationSearchCriteria.

Parameters:
criteria - The HardwareApplicationSearchCriteria which represents a query for HardwareApplication objects.
Returns:
An array of HardwareApplication objects.
Throws:
A - gov.nih.nci.common.search.SearchException if there is a problem searching.
gov.nih.nci.common.search.SearchException

setSerialNumber

public void setSerialNumber(java.lang.String p_serialNumber)
Sets the serialNumber attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a HardwareApplication object.

Specified by:
setSerialNumber in interface HardwareApplication
Parameters:
p_serialNumber - The new value for serialNumber.
See Also:
HardwareApplication.getSerialNumber()

getSerialNumber

public java.lang.String getSerialNumber()
Description copied from interface: HardwareApplication
Returns the value of this HardwareApplication object's serialNumber attribute. Description of serialNumber: Manufacturer's identifier for the Hardware.

Specified by:
getSerialNumber in interface HardwareApplication
Returns:
String The value of serialNumber.
See Also:
HardwareApplication.getSerialNumber()

setHardware

public void setHardware(Hardware p_hardware)
Sets the hardware attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a HardwareApplication object.

Specified by:
setHardware in interface HardwareApplication
Parameters:
p_hardware - The new value for hardware.
See Also:
HardwareApplication.getHardware()

getHardware

public Hardware getHardware()
Description copied from interface: HardwareApplication
Returns the value of this HardwareApplication object's hardware attribute.

Specified by:
getHardware in interface HardwareApplication
Returns:
gov.nih.nci.mageom.bean.Protocol.Hardware The value of hardware.
See Also:
HardwareApplication.getHardware()

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
Overrides:
toXML in class ParameterizableApplicationImpl

toXMLDoc

public org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
Overrides:
toXMLDoc in class ParameterizableApplicationImpl

toXMLProcessor

public org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc,
                                          java.util.ArrayList fillOutValues)
Returns an XML representation of the object. The document is not modified.

Overrides:
toXMLProcessor in class ParameterizableApplicationImpl
Parameters:
doc - the working document
fillOutValues - a list of attribute names that should have full XML for their values.
Returns:
org.w3c.dom.Element an XML representation

getXMLMethodDescriptors

public java.util.Hashtable getXMLMethodDescriptors()
Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.

Overrides:
getXMLMethodDescriptors in class ParameterizableApplicationImpl
Returns:
Hashtable The Hashtable of descriptors.

toString

public java.lang.String toString()
Returns a String representation of this object suitable for console display.

Overrides:
toString in class ParameterizableApplicationImpl
Returns:
the String representation.