Top Description Fields Methods
javax.xml.registry.infomodel

public Interface AuditableEvent

extends RegistryObject
Imports
java.util.*, java.sql.Timestamp, javax.xml.registry.*

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 the 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.

Author
Farrukh S. Najmi
See Also
RegistryObject

Field Summary

Modifier and TypeField and Description
public static final int
EVENT_TYPE_CREATED

An event where a RegistryObject is created.

public static final int
EVENT_TYPE_DELETED

An event where a RegistryObject is deleted.

public static final int
EVENT_TYPE_DEPRECATED

An event where a RegistryObject is deprecated.

public static final int
EVENT_TYPE_UNDEPRECATED

An event where a RegistryObject is undeprecated.

public static final int
EVENT_TYPE_UPDATED

An event where a RegistryObject is updated.

public static final int
EVENT_TYPE_VERSIONED

An event where a RegistryObject is versioned.

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the type of this event
getEventType
()

Gets the type of this event.

public RegistryObject

Returns:

the RegistryObject that was the focus of this event
getRegistryObject
()

Gets the RegistryObject associated with this AuditableEvent.

public Timestamp

Returns:

the timestamp that records the time the event occured
getTimestamp
()

Gets the Timestamp for when this event occurred.

public User

Returns:

the User that sent the request that generated this this AuditableEvent. Must not be null
getUser
()

Gets the User associated with this object.

Inherited from javax.xml.registry.infomodel.RegistryObject:
addAssociationaddAssociationsaddClassificationaddClassificationsaddExternalIdentifieraddExternalIdentifiersaddExternalLinkaddExternalLinksgetAssociatedObjectsgetAssociationsgetAuditTrailgetClassificationsgetDescriptiongetExternalIdentifiersgetExternalLinksgetKeygetLifeCycleManagergetNamegetObjectTypegetRegistryPackagesgetSubmittingOrganizationremoveAssociationremoveAssociationsremoveClassificationremoveClassificationsremoveExternalIdentifierremoveExternalIdentifiersremoveExternalLinkremoveExternalLinkssetAssociationssetClassificationssetDescriptionsetExternalIdentifierssetExternalLinkssetKeysetNametoXML

Field Detail

EVENT_TYPE_CREATEDback to summary
public static final int EVENT_TYPE_CREATED

An event where a RegistryObject is created.

EVENT_TYPE_DELETEDback to summary
public static final int EVENT_TYPE_DELETED

An event where a RegistryObject is deleted.

EVENT_TYPE_DEPRECATEDback to summary
public static final int EVENT_TYPE_DEPRECATED

An event where a RegistryObject is deprecated.

EVENT_TYPE_UNDEPRECATEDback to summary
public static final int EVENT_TYPE_UNDEPRECATED

An event where a RegistryObject is undeprecated.

EVENT_TYPE_UPDATEDback to summary
public static final int EVENT_TYPE_UPDATED

An event where a RegistryObject is updated.

EVENT_TYPE_VERSIONEDback to summary
public static final int EVENT_TYPE_VERSIONED

An event where a RegistryObject is versioned.

Method Detail

getEventTypeback to summary
public int getEventType() throws JAXRException

Gets the type of this event.

Capability Level: 1
Returns:int

the type of this event

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
AuditableEvent#EVENT_TYPE_CREATED
getRegistryObjectback to summary
public RegistryObject getRegistryObject() throws JAXRException

Gets the RegistryObject associated with this AuditableEvent.

Capability Level: 1
Returns:RegistryObject

the RegistryObject that was the focus of this event

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getTimestampback to summary
public Timestamp getTimestamp() throws JAXRException

Gets the Timestamp for when this event occurred.

Capability Level: 1
Returns:Timestamp

the timestamp that records the time the event occured

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getUserback to summary
public User getUser() throws JAXRException

Gets the User associated with this object.

Capability Level: 1
Returns:User

the User that sent the request that generated this this AuditableEvent. Must not be null

Exceptions
JAXRException:
If the JAXR provider encounters an internal error