javax.xml.registry.infomodel
Interface AuditableEvent

All Superinterfaces:
ExtensibleObject, RegistryObject, java.io.Serializable

public interface AuditableEvent
extends RegistryObject

AuditableEvent instances provide a long term record of events that effect a change of state in a RegistryObject. Such events are usually a result of a client initiated request. AuditableEvent instances are generated by the registry service to log such events.

Often such events effect a change in the life cycle of a RegistryObject. For example a client request could Create, Update, Deprecate or Delete a RegistryObject. No AuditableEvent is created for requests that do not alter t he state of a RegistryObject. Specifically, read-only requests do not generate an AuditableEvent. No AuditableEvent is generated for a RegistryObject when it is classified, assigned to a Package or associated with another Object.

A RegistryObject is associated with an ordered Collection of AuditableEvent instances that provide a complete audit trail for that Object.

See Also:
RegistryObject

Method Summary
 Concept getEventType()
          The type of this event
 RegistryObject getRegistryObject()
          Gets the RegistryObject associated with this AudiatbleEvent
 java.sql.Timestamp getTimestamp()
          Gets the Timestamp for when this event occured.
 User getUser()
          Gets the AuditableIdentity that sent the request that effected this event.
 
Methods inherited from interface javax.xml.registry.infomodel.RegistryObject
addAssociation, addAssociations, addClassification, addClassifications, addExternalIdentifier, addExternalIdentifiers, addExternalLink, addExternalLinks, getAssociatedObjects, getAssociations, getAuditTrail, getClassifications, getConnection, getDescription, getExternalIdentifiers, getExternalLinks, getKey, getName, getObjectType, getOrganization, getPackages, removeAssociation, removeAssociations, removeClassification, removeClassifications, removeExternalIdentifier, removeExternalIdentifiers, removeExternalLink, removeExternalLinks, setAssociations, setClassifications, setDescription, setExternalIdentifiers, setExternalLinks, setKey, setName, toXML
 
Methods inherited from interface javax.xml.registry.infomodel.ExtensibleObject
addSlot, addSlots, getSlot, getSlotAt, getSlots, removeSlot, removeSlots
 

Method Detail

getUser

public User getUser()
             throws JAXRException
Gets the AuditableIdentity that sent the request that effected this event.

Capability Level: 1
This interface is required to be implemented by JAXR Providers at or above capability level 1.

getTimestamp

public java.sql.Timestamp getTimestamp()
                                throws JAXRException
Gets the Timestamp for when this event occured.

Capability Level: 1

getEventType

public Concept getEventType()
                     throws JAXRException
The type of this event

Capability Level: 1

getRegistryObject

public RegistryObject getRegistryObject()
                                 throws JAXRException
Gets the RegistryObject associated with this AudiatbleEvent

Capability Level: 1