org.biomage.AuditAndSecurity
Class Audit

java.lang.Object
  |
  +--org.biomage.Common.Extendable
        |
        +--org.biomage.Common.Describable
              |
              +--org.biomage.AuditAndSecurity.Audit

All Implemented Interfaces:

HasAuditTrail, HasDescriptions, HasPerformer, HasPropertySets, HasSecurity, java.io.Serializable

public class Audit

extends Describable

implements java.io.Serializable, HasPerformer

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

See Also:

Serialized Form

Nested Class Summary

class

Audit.Action Inner class for the enumeration values that the attribute action can assume.

Nested classes inherited from class org.biomage.Interface.HasAuditTrail

HasAuditTrail.AuditTrail_list

Nested classes inherited from class org.biomage.Interface.HasDescriptions

HasDescriptions.Descriptions_list

Nested classes inherited from class org.biomage.Interface.HasPropertySets

HasPropertySets.PropertySets_list

Field Summary

protected Contact

performer The contact for creating or changing the instance referred to by the Audit.

Fields inherited from class org.biomage.Common.Describable

auditTrail, descriptions, security

Fields inherited from class org.biomage.Common.Extendable

propertySets

Constructor Summary

Audit()
Default constructor.

Audit(org.xml.sax.Attributes atts)
Attribute constructor.

Method Summary

Audit.Action	getAction() Get method for action
java.util.Date	getDate() Get method for date
java.lang.String	getNameAction() Return the current name of the Enumeration type of Action.
java.lang.String	getNameByValueAction(int val) For Action get the Name of the Enumeration type by passing a Value to it.
Contact	getPerformer() Get method for performer
int	getValueAction() Return the currrent value of the Enumeration type of Action.
int	getValueByNameAction(java.lang.String name) For Action get the Value of the Enumeration type by passing a Name to it.
void	setAction(Audit.Action action) Set method for action
void	setDate(java.util.Date date) Set method for date
java.lang.String	setNameByValueAction(int val) For Action set the Name of the Enumeration type by passing a value (int)
void	setPerformer(Contact performer) Set method for performer
int	setValueByNameAction(java.lang.String name) For Action set the Value of the Enumeration type by passing a Name to it.
void	writeAssociations(java.io.Writer out) writeAssociations This method is responsible for assembling the association data into XML.
void	writeAttributes(java.io.Writer out) writeAttributes This method is responsible for assembling the attribute data into XML.
void	writeMAGEML(java.io.Writer out) writeMAGEML This method is responsible for assembling the attribute and association data into XML.

Methods inherited from class org.biomage.Common.Describable

addToAuditTrail, addToAuditTrail, addToDescriptions, addToDescriptions, getAuditTrail, getDescriptions, getFromAuditTrail, getFromDescriptions, getSecurity, removeElementAtFromAuditTrail, removeElementAtFromDescriptions, removeFromAuditTrail, removeFromDescriptions, setAuditTrail, setDescriptions, setSecurity

Methods inherited from class org.biomage.Common.Extendable

addToPropertySets, addToPropertySets, getFromPropertySets, getPropertySets, removeElementAtFromPropertySets, removeFromPropertySets, setPropertySets

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

performer

protected Contact performer

The contact for creating or changing the instance referred to by the Audit.

Constructor Detail

Audit

public Audit()

Default constructor.

Audit

public Audit(org.xml.sax.Attributes atts)

Attribute constructor. Looks up the attributes in the parameter and casts them from strings appropriately

Method Detail

writeMAGEML

public void writeMAGEML(java.io.Writer out)
                 throws java.io.IOException

writeMAGEML This method is responsible for assembling the attribute and association data into XML. It creates the object tag and then calls the writeAttributes and writeAssociation methods.

Overrides:

writeMAGEML in class Describable

java.io.IOException

writeAttributes

public void writeAttributes(java.io.Writer out)
                     throws java.io.IOException

writeAttributes This method is responsible for assembling the attribute data into XML. It calls the super method to write out all attributes of this class and it's ancestors.

Overrides:

writeAttributes in class Describable

java.io.IOException

writeAssociations

public void writeAssociations(java.io.Writer out)
                       throws java.io.IOException

writeAssociations This method is responsible for assembling the association data into XML. It calls the super method to write out all associations of this class's ancestors.

Overrides:

writeAssociations in class Describable

java.io.IOException

setDate

public void setDate(java.util.Date date)

Set method for date

getDate

public java.util.Date getDate()

Get method for date

Returns:

value of the attribute

setAction

public void setAction(Audit.Action action)

Set method for action

getAction

public Audit.Action getAction()

Get method for action

Returns:

value of the attribute

setNameByValueAction

public java.lang.String setNameByValueAction(int val)

For Action set the Name of the Enumeration type by passing a value (int)

setValueByNameAction

public int setValueByNameAction(java.lang.String name)

For Action set the Value of the Enumeration type by passing a Name to it.

getNameByValueAction

public java.lang.String getNameByValueAction(int val)

For Action get the Name of the Enumeration type by passing a Value to it.

getValueByNameAction

public int getValueByNameAction(java.lang.String name)

For Action get the Value of the Enumeration type by passing a Name to it.

getNameAction

public java.lang.String getNameAction()

Return the current name of the Enumeration type of Action.

getValueAction

public int getValueAction()

Return the currrent value of the Enumeration type of Action.

setPerformer

public void setPerformer(Contact performer)

Set method for performer

Specified by:

setPerformer in interface HasPerformer

getPerformer

public Contact getPerformer()

Get method for performer

Specified by:

getPerformer in interface HasPerformer

Returns:

value of the attribute