-
- All Superinterfaces:
- ExtensibleObject, RegistryObject
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 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
Fields Modifier and Type Field and Description static int
EVENT_TYPE_CREATED
An event where a RegistryObject is created.static int
EVENT_TYPE_DELETED
An event where a RegistryObject is deleted.static int
EVENT_TYPE_DEPRECATED
An event where a RegistryObject is deprecated.static int
EVENT_TYPE_UNDEPRECATED
An event where a RegistryObject is undeprecated.static int
EVENT_TYPE_UPDATED
An event where a RegistryObject is updated.static int
EVENT_TYPE_VERSIONED
An event where a RegistryObject is versioned.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description int
getEventType()
Gets the type of this event.RegistryObject
getRegistryObject()
Gets the RegistryObject associated with this AuditableEvent.Timestamp
getTimestamp()
Gets the Timestamp for when this event occurred.User
getUser()
Gets the User associated with this object.-
Methods inherited from interface javax.xml.registry.infomodel.RegistryObject
addAssociation, addAssociations, addClassification, addClassifications, addExternalIdentifier, addExternalIdentifiers, addExternalLink, addExternalLinks, getAssociatedObjects, getAssociations, getAuditTrail, getClassifications, getDescription, getExternalIdentifiers, getExternalLinks, getKey, getLifeCycleManager, getName, getObjectType, getRegistryPackages, getSubmittingOrganization, 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, getSlots, removeSlot, removeSlots
-
-
-
-
Field Detail
-
EVENT_TYPE_CREATED
static final int EVENT_TYPE_CREATED
An event where a RegistryObject is created.- See Also:
- Constant Field Values
-
EVENT_TYPE_DELETED
static final int EVENT_TYPE_DELETED
An event where a RegistryObject is deleted.- See Also:
- Constant Field Values
-
EVENT_TYPE_DEPRECATED
static final int EVENT_TYPE_DEPRECATED
An event where a RegistryObject is deprecated.- See Also:
- Constant Field Values
-
EVENT_TYPE_UPDATED
static final int EVENT_TYPE_UPDATED
An event where a RegistryObject is updated.- See Also:
- Constant Field Values
-
EVENT_TYPE_VERSIONED
static final int EVENT_TYPE_VERSIONED
An event where a RegistryObject is versioned.- See Also:
- Constant Field Values
-
EVENT_TYPE_UNDEPRECATED
static final int EVENT_TYPE_UNDEPRECATED
An event where a RegistryObject is undeprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getUser
User getUser() throws JAXRException
Gets the User associated with this object.- Capability Level: 1
- Returns:
- the User that sent the request that generated this this AuditableEvent. Must not be null
- Throws:
JAXRException
- If the JAXR provider encounters an internal error
-
getTimestamp
Timestamp getTimestamp() throws JAXRException
Gets the Timestamp for when this event occurred.- Capability Level: 1
- Returns:
- the timestamp that records the time the event occured
- Throws:
JAXRException
- If the JAXR provider encounters an internal error
-
getEventType
int getEventType() throws JAXRException
Gets the type of this event.- Capability Level: 1
- Returns:
- the type of this event
- Throws:
JAXRException
- If the JAXR provider encounters an internal error- See Also:
EVENT_TYPE_CREATED
-
getRegistryObject
RegistryObject getRegistryObject() throws JAXRException
Gets the RegistryObject associated with this AuditableEvent.- Capability Level: 1
- Returns:
- the RegistryObject that was the focus of this event
- Throws:
JAXRException
- If the JAXR provider encounters an internal error
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/xml/registry/infomodel/AuditableEvent.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.