kaos.core.csi.extension.history.logging
Interface HistoryMonitor

All Superinterfaces:

EventHistoryComponent, KAoSExtensionComponent

All Known Subinterfaces:

PolicyDecisionHistoryComponent

public interface HistoryMonitor
extends EventHistoryComponent, KAoSExtensionComponent

This interface defines methods to access logged events

Method Summary

void	deleteAllLogs() Delete all the events logged so far.
void	deleteLogs(java.util.List<ActionInstanceDescription> logs)
java.util.List<ActionInstanceDescription>	deleteLogsforActionType(java.lang.String actionType) Delete all logged events that contain the given action type.
java.util.List<ActionInstanceDescription>	deleteLogsforActor(java.lang.String actorID) Delete all logged events that contain the given actor.
java.util.List<ActionInstanceDescription>	deleteSpecifiedLogs(java.lang.String actionType, java.lang.String actorID, java.lang.String startTime, java.lang.String endTime, java.lang.Boolean latest) This method calls 'getSpecifiedLogs' with its input parameters and then deletes the logs returned by that call.
java.util.List<ActionInstanceDescription>	getAllLogs() Get all the events logged so far.
java.util.List<ActionInstanceDescription>	getLogsforActionType(java.lang.String actionType) Get all events logged that contain the given action type.
java.util.List<ActionInstanceDescription>	getLogsforActor(java.lang.String actorID) Get all logged events that contain the given actor.
java.util.List<ActionInstanceDescription>	getSpecifiedLogs(java.lang.String actionType, java.lang.String actorID, java.lang.String startTime, java.lang.String endTime, java.lang.Boolean latest) This method returns the logged events specified by the given parameters.

Methods inherited from interface kaos.core.csi.extension.history.EventHistoryComponent

findEventsOfType, logEvent

Methods inherited from interface kaos.core.csi.extension.KAoSExtensionComponent

addOntologicalAttribute, getEnabledStatus, getName, getOntologicalAttributes, setEnabledStatus, setName, setProperties

Method Detail

getAllLogs

java.util.List<ActionInstanceDescription> getAllLogs()

Get all the events logged so far.

Specified by:

getAllLogs in interface EventHistoryComponent

Returns:

A Vector containing aid objects logged so far.

deleteAllLogs

void deleteAllLogs()

Delete all the events logged so far.

getLogsforActionType

java.util.List<ActionInstanceDescription> getLogsforActionType(java.lang.String actionType)

Get all events logged that contain the given action type.

Specified by:

getLogsforActionType in interface EventHistoryComponent

Parameters:

actionType - A String indicating the action type.

Returns:

A vector containing aid objects logged for that action.

deleteLogsforActionType

java.util.List<ActionInstanceDescription> deleteLogsforActionType(java.lang.String actionType)

Delete all logged events that contain the given action type.

Parameters:

actionType - A String indicating the action type.

Returns:

Vector A Vector containing deleted logs

getLogsforActor

java.util.List<ActionInstanceDescription> getLogsforActor(java.lang.String actorID)

Get all logged events that contain the given actor.

Parameters:

actorID - A String indicating the actor id.

Returns:

A vector containing aid objects logged for that actor.

deleteLogsforActor

java.util.List<ActionInstanceDescription> deleteLogsforActor(java.lang.String actorID)

Delete all logged events that contain the given actor.

Parameters:

actorID - A String indicating the actor id.

Returns:

Vector A Vector containing deleted logs

getSpecifiedLogs

java.util.List<ActionInstanceDescription> getSpecifiedLogs(java.lang.String actionType,
                                                           java.lang.String actorID,
                                                           java.lang.String startTime,
                                                           java.lang.String endTime,
                                                           java.lang.Boolean latest)

This method returns the logged events specified by the given parameters. The input parameters are interpreted as follows:

Parameters:

actionType - A String indicating the action type of requested logs. If it is null, 'all action types' would be assumed.

actorID - A String indicating the actor of requested logs. If null, 'all actors' would be assumed.

startTime - A long, indicating the start of time period for which logs are requested. If null, 'the begining of logs' time would be assumed.

endTime - A long, indicating the end of time period for which logs are requested. If null, 'time of the latest log' would be assumed.

latest - A boolean, indicating if only latest logs are requested. If it is set: a) start and end time parameters are ignored. b) If actionType is null, and actorID is null, the latest log for each actor is returned. c) If actorID is null and actionType is not null the latest logs for each actor for the given actionType are returned. d) If actorID is not null, the latest log for that actor is returned. If actionType also is not null, the latest log for that actor and that action is returned. If this boolean is not set, log are retrieved based on preceding parameters.

deleteSpecifiedLogs

java.util.List<ActionInstanceDescription> deleteSpecifiedLogs(java.lang.String actionType,
                                                              java.lang.String actorID,
                                                              java.lang.String startTime,
                                                              java.lang.String endTime,
                                                              java.lang.Boolean latest)

This method calls 'getSpecifiedLogs' with its input parameters and then deletes the logs returned by that call. For method documentation, see the heading for 'getSpecifiedLogs'.

Returns:

Vector A Vector containing deleted logs

deleteLogs

void deleteLogs(java.util.List<ActionInstanceDescription> logs)