kaos.policy.history
Interface HistoryMonitor

All Superinterfaces:

KAoSEventHistoryComponent, KAoSExtensionComponent

All Known Implementing Classes:

HistoryMonitorImpl

public interface HistoryMonitor
extends KAoSEventHistoryComponent

This interface defines methods to access logged events

Method Summary

void	deleteAllLogs() Delete all the events logged so far.
java.util.Vector	deleteLogsforActionType(java.lang.String actionType) Delete all logged events that contain the given action type.
java.util.Vector	deleteLogsforActor(java.lang.String actorID) Delete all logged events that contain the given actor.
java.util.Vector	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.Vector	getAllLogs() Get all the events logged so far.
java.util.Vector	getLogsforActionType(java.lang.String actionType) Get all events logged that contain the given action type.
java.util.Vector	getLogsforActor(java.lang.String actorID) Get all logged events that contain the given actor.
java.util.Vector	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.
void	logEvent(ActionInstanceDescription event) Log an event

Methods inherited from interface kaos.policy.history.KAoSEventHistoryComponent

countEventsOfType

Methods inherited from interface kaos.policy.guard.KAoSExtensionComponent

changeKAoSExtensionComponentEnabledStatus, getAssociatedOntologyType, getKAoSExtensionComponentEnabledStatus, getKAoSExtensionComponentName

Method Detail

logEvent

void logEvent(ActionInstanceDescription event)

Log an event

Parameters:

event - The event to be logged.

getAllLogs

java.util.Vector getAllLogs()

Get all the events logged so far.

Returns:

A Vector containing aid objects logged so far.

deleteAllLogs

void deleteAllLogs()

Delete all the events logged so far.

getLogsforActionType

java.util.Vector getLogsforActionType(java.lang.String actionType)

Get all events logged that contain the given action type.

Parameters:

actionType - A String indicating the action type.

Returns:

A vector containing aid objects logged for that action.

deleteLogsforActionType

java.util.Vector 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.Vector 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.Vector 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.Vector 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.Vector 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