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

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.ProtocolApplicationImpl
All Implemented Interfaces:
Describable, Extendable, ParameterizableApplication, ProtocolApplication, java.io.Serializable

public class ProtocolApplicationImpl
extends ParameterizableApplicationImpl
implements ProtocolApplication

The use of a protocol with the requisite Parameters and ParameterValues.

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

Field Summary
protected  java.lang.String activityDate
          When the protocol was applied.
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  HardwareApplication[] hardwareApplications
          DOCUMENT ME
protected  int hardwareApplicationsCount
          The count of HardwareApplication objects.
protected  Person[] performers
          DOCUMENT ME
protected  int performersCount
          The count of Person objects.
protected  Protocol protocol
          DOCUMENT ME
protected  java.lang.Long protocolId
          The internal ID of the associated protocol object.
protected  SoftwareApplication[] softwareApplications
          DOCUMENT ME
protected  int softwareApplicationsCount
          The count of SoftwareApplication objects.
 
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
ProtocolApplicationImpl()
          Default constructor
 
Method Summary
 java.lang.String getActivityDate()
          Returns the value of this ProtocolApplication object's activityDate attribute.
 HardwareApplication[] getHardwareApplications()
          Returns the value of this ProtocolApplication object's hardwareApplications attribute.
 int getHardwareApplicationsCount()
          Returns the count of all HardwareApplication associated with this ProtocolApplication object.
 Person[] getPerformers()
          Returns the value of this ProtocolApplication object's performers attribute.
 int getPerformersCount()
          Returns the count of all Person associated with this ProtocolApplication object.
 Protocol getProtocol()
          Returns the value of this ProtocolApplication object's protocol attribute.
 SoftwareApplication[] getSoftwareApplications()
          Returns the value of this ProtocolApplication object's softwareApplications attribute.
 int getSoftwareApplicationsCount()
          Returns the count of all SoftwareApplication associated with this ProtocolApplication object.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 ProtocolApplication[] searchProtocolApplications(ProtocolApplicationSearchCriteria criteria)
          Returns an array of ProtocolApplication objects that satisfy the given ProtocolApplicationSearchCriteria.
 void setActivityDate(java.lang.String p_activityDate)
          Sets the activityDate attribute.
 void setHardwareApplications(HardwareApplication[] p_hardwareApplications)
          Sets the hardwareApplications attribute.
 void setPerformers(Person[] p_performers)
          Sets the performers attribute.
 void setProtocol(Protocol p_protocol)
          Sets the protocol attribute.
 void setSoftwareApplications(SoftwareApplication[] p_softwareApplications)
          Sets the softwareApplications 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

activityDate

protected java.lang.String activityDate
When the protocol was applied.


softwareApplicationsCount

protected int softwareApplicationsCount
The count of SoftwareApplication objects.


softwareApplications

protected SoftwareApplication[] softwareApplications
DOCUMENT ME


hardwareApplicationsCount

protected int hardwareApplicationsCount
The count of HardwareApplication objects.


hardwareApplications

protected HardwareApplication[] hardwareApplications
DOCUMENT ME


protocol

protected Protocol protocol
DOCUMENT ME


protocolId

protected java.lang.Long protocolId
The internal ID of the associated protocol object.


performersCount

protected int performersCount
The count of Person objects.


performers

protected Person[] performers
DOCUMENT ME

Constructor Detail

ProtocolApplicationImpl

public ProtocolApplicationImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ParameterizableApplicationImpl

searchProtocolApplications

public ProtocolApplication[] searchProtocolApplications(ProtocolApplicationSearchCriteria criteria)
                                                 throws gov.nih.nci.common.search.SearchException
Returns an array of ProtocolApplication objects that satisfy the given ProtocolApplicationSearchCriteria.

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

setActivityDate

public void setActivityDate(java.lang.String p_activityDate)
Sets the activityDate attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ProtocolApplication object.

Specified by:
setActivityDate in interface ProtocolApplication
Parameters:
p_activityDate - The new value for activityDate.
See Also:
ProtocolApplication.getActivityDate()

getActivityDate

public java.lang.String getActivityDate()
Description copied from interface: ProtocolApplication
Returns the value of this ProtocolApplication object's activityDate attribute. Description of activityDate: When the protocol was applied.

Specified by:
getActivityDate in interface ProtocolApplication
Returns:
String The value of activityDate.
See Also:
ProtocolApplication.getActivityDate()

setSoftwareApplications

public void setSoftwareApplications(SoftwareApplication[] p_softwareApplications)
Sets the softwareApplications attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ProtocolApplication object.

Specified by:
setSoftwareApplications in interface ProtocolApplication
Parameters:
p_softwareApplications - The new value for softwareApplications.
See Also:
ProtocolApplication.getSoftwareApplications()

getSoftwareApplications

public SoftwareApplication[] getSoftwareApplications()
Description copied from interface: ProtocolApplication
Returns the value of this ProtocolApplication object's softwareApplications attribute.

Specified by:
getSoftwareApplications in interface ProtocolApplication
Returns:
gov.nih.nci.mageom.bean.Protocol.SoftwareApplication[] The value of softwareApplications.
See Also:
ProtocolApplication.getSoftwareApplications()

setHardwareApplications

public void setHardwareApplications(HardwareApplication[] p_hardwareApplications)
Sets the hardwareApplications attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ProtocolApplication object.

Specified by:
setHardwareApplications in interface ProtocolApplication
Parameters:
p_hardwareApplications - The new value for hardwareApplications.
See Also:
ProtocolApplication.getHardwareApplications()

getHardwareApplications

public HardwareApplication[] getHardwareApplications()
Description copied from interface: ProtocolApplication
Returns the value of this ProtocolApplication object's hardwareApplications attribute.

Specified by:
getHardwareApplications in interface ProtocolApplication
Returns:
gov.nih.nci.mageom.bean.Protocol.HardwareApplication[] The value of hardwareApplications.
See Also:
ProtocolApplication.getHardwareApplications()

setProtocol

public void setProtocol(Protocol p_protocol)
Sets the protocol attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ProtocolApplication object.

Specified by:
setProtocol in interface ProtocolApplication
Parameters:
p_protocol - The new value for protocol.
See Also:
ProtocolApplication.getProtocol()

getProtocol

public Protocol getProtocol()
Description copied from interface: ProtocolApplication
Returns the value of this ProtocolApplication object's protocol attribute.

Specified by:
getProtocol in interface ProtocolApplication
Returns:
gov.nih.nci.mageom.bean.Protocol.Protocol The value of protocol.
See Also:
ProtocolApplication.getProtocol()

setPerformers

public void setPerformers(Person[] p_performers)
Sets the performers attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a ProtocolApplication object.

Specified by:
setPerformers in interface ProtocolApplication
Parameters:
p_performers - The new value for performers.
See Also:
ProtocolApplication.getPerformers()

getPerformers

public Person[] getPerformers()
Description copied from interface: ProtocolApplication
Returns the value of this ProtocolApplication object's performers attribute.

Specified by:
getPerformers in interface ProtocolApplication
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Person[] The value of performers.
See Also:
ProtocolApplication.getPerformers()

getSoftwareApplicationsCount

public int getSoftwareApplicationsCount()
Returns the count of all SoftwareApplication associated with this ProtocolApplication object.

Returns:
the count
See Also:
ProtocolApplication.getSoftwareApplications()

getHardwareApplicationsCount

public int getHardwareApplicationsCount()
Returns the count of all HardwareApplication associated with this ProtocolApplication object.

Returns:
the count
See Also:
ProtocolApplication.getHardwareApplications()

getPerformersCount

public int getPerformersCount()
Returns the count of all Person associated with this ProtocolApplication object.

Returns:
the count
See Also:
ProtocolApplication.getPerformers()

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.