AuditableEvent

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.

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.
`java.sql.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.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
```
java.sql.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

Interface AuditableEvent

Field Summary

Method Summary

Methods inherited from interface javax.xml.registry.infomodel.RegistryObject

Methods inherited from interface javax.xml.registry.infomodel.ExtensibleObject

Field Detail

EVENT_TYPE_CREATED

EVENT_TYPE_DELETED

EVENT_TYPE_DEPRECATED

EVENT_TYPE_UPDATED

EVENT_TYPE_VERSIONED

EVENT_TYPE_UNDEPRECATED

Method Detail

getUser

getTimestamp

getEventType

getRegistryObject