gov.nih.nci.mageom.domain.AuditAndSecurity.impl
Class AuditImpl

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.AuditAndSecurity.impl.AuditImpl
All Implemented Interfaces:
Audit, Describable, Extendable, java.io.Serializable

public class AuditImpl
extends DescribableImpl
implements Audit

Tracks information on the contact that creates or modifies an object.

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

Field Summary
protected  java.lang.String action
          Indicates whether an action is a creation or a modification.
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  java.util.Date date
          The date of a change.
protected  Contact performer
          DOCUMENT ME
protected  java.lang.Long performerId
          The internal ID of the associated performer object.
 
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
AuditImpl()
          Default constructor
 
Method Summary
 java.lang.String getAction()
          Returns the value of this Audit object's action attribute.
 java.util.Date getDate()
          Returns the value of this Audit object's date attribute.
 Contact getPerformer()
          Returns the value of this Audit object's performer attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Audit[] searchAudits(AuditSearchCriteria criteria)
          Returns an array of Audit objects that satisfy the given AuditSearchCriteria.
 void setAction(java.lang.String p_action)
          Sets the action attribute.
 void setDate(java.util.Date p_date)
          Sets the date attribute.
 void setPerformer(Contact p_performer)
          Sets the performer 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

date

protected java.util.Date date
The date of a change.


action

protected java.lang.String action
Indicates whether an action is a creation or a modification.


performer

protected Contact performer
DOCUMENT ME


performerId

protected java.lang.Long performerId
The internal ID of the associated performer object.

Constructor Detail

AuditImpl

public AuditImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class DescribableImpl

searchAudits

public Audit[] searchAudits(AuditSearchCriteria criteria)
                     throws gov.nih.nci.common.search.SearchException
Returns an array of Audit objects that satisfy the given AuditSearchCriteria.

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

setDate

public void setDate(java.util.Date p_date)
Sets the date attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Audit object.

Specified by:
setDate in interface Audit
Parameters:
p_date - The new value for date.
See Also:
Audit.getDate()

getDate

public java.util.Date getDate()
Description copied from interface: Audit
Returns the value of this Audit object's date attribute. Description of date: The date of a change.

Specified by:
getDate in interface Audit
Returns:
Date The value of date.
See Also:
Audit.getDate()

setAction

public void setAction(java.lang.String p_action)
Sets the action attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Audit object.

Specified by:
setAction in interface Audit
Parameters:
p_action - The new value for action.
See Also:
Audit.getAction()

getAction

public java.lang.String getAction()
Description copied from interface: Audit
Returns the value of this Audit object's action attribute. Description of action: Indicates whether an action is a creation or a modification.

Specified by:
getAction in interface Audit
Returns:
enum {creation,modification} The value of action.
See Also:
Audit.getAction()

setPerformer

public void setPerformer(Contact p_performer)
Sets the performer attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Audit object.

Specified by:
setPerformer in interface Audit
Parameters:
p_performer - The new value for performer.
See Also:
Audit.getPerformer()

getPerformer

public Contact getPerformer()
Description copied from interface: Audit
Returns the value of this Audit object's performer attribute.

Specified by:
getPerformer in interface Audit
Returns:
gov.nih.nci.mageom.bean.AuditAndSecurity.Contact The value of performer.
See Also:
Audit.getPerformer()

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.