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

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

public class SoftwareApplicationImpl
extends ParameterizableApplicationImpl
implements SoftwareApplication

The use of a piece of software 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  java.util.Date releaseDate
          When the software was released.
protected  Software software
          DOCUMENT ME
protected  java.lang.Long softwareId
          The internal ID of the associated software object.
protected  java.lang.String version
          The version of the software.
 
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
SoftwareApplicationImpl()
          Default constructor
 
Method Summary
 java.util.Date getReleaseDate()
          Returns the value of this SoftwareApplication object's releaseDate attribute.
 Software getSoftware()
          Returns the value of this SoftwareApplication object's software attribute.
 java.lang.String getVersion()
          Returns the value of this SoftwareApplication object's version attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 SoftwareApplication[] searchSoftwareApplications(SoftwareApplicationSearchCriteria criteria)
          Returns an array of SoftwareApplication objects that satisfy the given SoftwareApplicationSearchCriteria.
 void setReleaseDate(java.util.Date p_releaseDate)
          Sets the releaseDate attribute.
 void setSoftware(Software p_software)
          Sets the software attribute.
 void setVersion(java.lang.String p_version)
          Sets the version 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

version

protected java.lang.String version
The version of the software.


releaseDate

protected java.util.Date releaseDate
When the software was released.


software

protected Software software
DOCUMENT ME


softwareId

protected java.lang.Long softwareId
The internal ID of the associated software object.

Constructor Detail

SoftwareApplicationImpl

public SoftwareApplicationImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class ParameterizableApplicationImpl

searchSoftwareApplications

public SoftwareApplication[] searchSoftwareApplications(SoftwareApplicationSearchCriteria criteria)
                                                 throws gov.nih.nci.common.search.SearchException
Returns an array of SoftwareApplication objects that satisfy the given SoftwareApplicationSearchCriteria.

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

setVersion

public void setVersion(java.lang.String p_version)
Sets the version attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a SoftwareApplication object.

Specified by:
setVersion in interface SoftwareApplication
Parameters:
p_version - The new value for version.
See Also:
SoftwareApplication.getVersion()

getVersion

public java.lang.String getVersion()
Description copied from interface: SoftwareApplication
Returns the value of this SoftwareApplication object's version attribute. Description of version: The version of the software.

Specified by:
getVersion in interface SoftwareApplication
Returns:
String The value of version.
See Also:
SoftwareApplication.getVersion()

setReleaseDate

public void setReleaseDate(java.util.Date p_releaseDate)
Sets the releaseDate attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a SoftwareApplication object.

Specified by:
setReleaseDate in interface SoftwareApplication
Parameters:
p_releaseDate - The new value for releaseDate.
See Also:
SoftwareApplication.getReleaseDate()

getReleaseDate

public java.util.Date getReleaseDate()
Description copied from interface: SoftwareApplication
Returns the value of this SoftwareApplication object's releaseDate attribute. Description of releaseDate: When the software was released.

Specified by:
getReleaseDate in interface SoftwareApplication
Returns:
Date The value of releaseDate.
See Also:
SoftwareApplication.getReleaseDate()

setSoftware

public void setSoftware(Software p_software)
Sets the software attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a SoftwareApplication object.

Specified by:
setSoftware in interface SoftwareApplication
Parameters:
p_software - The new value for software.
See Also:
SoftwareApplication.getSoftware()

getSoftware

public Software getSoftware()
Description copied from interface: SoftwareApplication
Returns the value of this SoftwareApplication object's software attribute.

Specified by:
getSoftware in interface SoftwareApplication
Returns:
gov.nih.nci.mageom.bean.Protocol.Software The value of software.
See Also:
SoftwareApplication.getSoftware()

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.