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

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
All Implemented Interfaces:
Describable, Extendable, ParameterizableApplication, java.io.Serializable
Direct Known Subclasses:
HardwareApplicationImpl, ProtocolApplicationImpl, SoftwareApplicationImpl

public class ParameterizableApplicationImpl
extends DescribableImpl
implements ParameterizableApplication

The interface that is the use of a Parameterizable class.

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

Field Summary
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  ParameterValue[] parameterValues
          DOCUMENT ME
protected  int parameterValuesCount
          The count of ParameterValue objects.
 
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
ParameterizableApplicationImpl()
          Default constructor
 
Method Summary
 ParameterValue[] getParameterValues()
          Returns the value of this ParameterizableApplication object's parameterValues attribute.
 int getParameterValuesCount()
          Returns the count of all ParameterValue associated with this ParameterizableApplication object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 ParameterizableApplication[] searchParameterizableApplications(ParameterizableApplicationSearchCriteria criteria)
          Returns an array of ParameterizableApplication objects that satisfy the given ParameterizableApplicationSearchCriteria.
 void setParameterValues(ParameterValue[] p_parameterValues)
          Sets the parameterValues 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.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.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

parameterValuesCount

protected int parameterValuesCount
The count of ParameterValue objects.


parameterValues

protected ParameterValue[] parameterValues
DOCUMENT ME

Constructor Detail

ParameterizableApplicationImpl

public ParameterizableApplicationImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DescribableImpl

searchParameterizableApplications

public ParameterizableApplication[] searchParameterizableApplications(ParameterizableApplicationSearchCriteria criteria)
                                                               throws gov.nih.nci.common.search.SearchException
Returns an array of ParameterizableApplication objects that satisfy the given ParameterizableApplicationSearchCriteria.

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

setParameterValues

public void setParameterValues(ParameterValue[] p_parameterValues)
Sets the parameterValues attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ParameterizableApplication object.

Specified by:
setParameterValues in interface ParameterizableApplication
Parameters:
p_parameterValues - The new value for parameterValues.
See Also:
ParameterizableApplication.getParameterValues()

getParameterValues

public ParameterValue[] getParameterValues()
Description copied from interface: ParameterizableApplication
Returns the value of this ParameterizableApplication object's parameterValues attribute.

Specified by:
getParameterValues in interface ParameterizableApplication
Returns:
gov.nih.nci.mageom.bean.Protocol.ParameterValue[] The value of parameterValues.
See Also:
ParameterizableApplication.getParameterValues()

getParameterValuesCount

public int getParameterValuesCount()
Returns the count of all ParameterValue associated with this ParameterizableApplication object.

Returns:
the count
See Also:
ParameterizableApplication.getParameterValues()

toXML

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

toXMLDoc

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

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 DescribableImpl
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 DescribableImpl
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 DescribableImpl
Returns:
the String representation.