gov.nasa.pds.registry.model

Class AuditableEvent

java.lang.Object

gov.nasa.pds.registry.model.Identifiable

gov.nasa.pds.registry.model.RegistryObject

gov.nasa.pds.registry.model.AuditableEvent

All Implemented Interfaces:

Serializable

@Entity
public class AuditableEvent
extends RegistryObject

AuditableEvent instances provide a long-term record of events that effected a change in a RegistryObject. A RegistryObject is associated with an ordered Set of AuditableEvent instances that provide a complete audit trail for that RegistryObject. AuditableEvents 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. An AuditableEvent is typically created when a request creates or alters the content or ownership of a RegistryObject. Read-only requests typically do not generate an AuditableEvent.

Author:

pramirez

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AuditableEvent()
AuditableEvent(EventType eventType, List<String> affectedObjects, String user)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getAffectedObjects()
EventType	getEventType()
String	getRequestId()
Date	getTimestamp()
String	getUser()
int	hashCode()
void	setAffectedObjects(List<String> affectedObjects)
void	setEventType(EventType eventType)
void	setRequestId(String requestId)
void	setTimestamp(Date timestamp)
void	setUser(String user)

Methods inherited from class gov.nasa.pds.registry.model.RegistryObject

getClassifications, getDescription, getExternalIdentifiers, getLid, getName, getObjectType, getStatus, getVersionName, setClassifications, setDescription, setExternalIdentifiers, setLid, setName, setObjectType, setStatus, setVersionName

Methods inherited from class gov.nasa.pds.registry.model.Identifiable

addSlot, getGuid, getHome, getSlot, getSlots, setGuid, setHome, setSlots

Methods inherited from class java.lang.Object

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

Constructor Detail

AuditableEvent

public AuditableEvent()

AuditableEvent

public AuditableEvent(EventType eventType,
              List<String> affectedObjects,
              String user)

Method Detail

getEventType

public EventType getEventType()

Returns:

the eventType

setEventType

public void setEventType(EventType eventType)

Parameters:

eventType - the eventType to set

getAffectedObjects

public List<String> getAffectedObjects()

Returns:

the guid of the registry object this event is associated with

setAffectedObjects

public void setAffectedObjects(List<String> affectedObjects)

Parameters:

affectedObjects - the guid of the registry object this event is associated with

getTimestamp

public Date getTimestamp()

Returns:

the timestamp when the event occurred

setTimestamp

public void setTimestamp(Date timestamp)

Parameters:

timestamp - the timestamp to when event occured

getUser

public String getUser()

Returns:

identifier that maps to a user

setUser

public void setUser(String user)

Parameters:

user - an unique user id to set

getRequestId

public String getRequestId()

Returns:

identifies the request made to cause this event

setRequestId

public void setRequestId(String requestId)

Parameters:

requestId - unique id for request that generated this event

hashCode

public int hashCode()

Overrides:

hashCode in class RegistryObject

equals

public boolean equals(Object obj)

Overrides:

equals in class RegistryObject