kaos.policy.state
Interface KAoSStateRecorderComponent

All Superinterfaces:

KAoSExtensionComponent

public interface KAoSStateRecorderComponent
extends KAoSExtensionComponent

This interface defines the necessary methods that a state recorder must implement in order to monitor state programatically. Please note that at the moment, none of the methods takes in a parameter to specify the frequency of recording. It is assumed that the state is recorded only when it changes. This may change in subsequent versions.

Method Summary

void	addPropertiesToRecord(java.util.ArrayList properties) This method tells the recorder to record state of multiple properties, in addition to recording the current state (if any).
void	addPropertyToRecord(java.lang.String propertyName) This method tells the recorder to record state of the given property, in addition to recording the current state (if any).
java.lang.Object	getCurrentState() This method returns the current state of the properties that this recorder is recording.
void	removePropertiesToRecord(java.util.ArrayList properties) This method tells the recorder to remove the given multiple property from its current set of properties whose state it is recording.
void	removePropertyToRecord(java.lang.String propertyName) This method tells the recorder to remove the given property from its current set of properties whose state it is recording.

Methods inherited from interface kaos.policy.guard.KAoSExtensionComponent

changeKAoSExtensionComponentEnabledStatus, getAssociatedOntologyType, getKAoSExtensionComponentEnabledStatus, getKAoSExtensionComponentName

Method Detail

addPropertyToRecord

void addPropertyToRecord(java.lang.String propertyName)

This method tells the recorder to record state of the given property, in addition to recording the current state (if any).

Parameters:

propertyName - a String, specifying the property.

addPropertiesToRecord

void addPropertiesToRecord(java.util.ArrayList properties)

This method tells the recorder to record state of multiple properties, in addition to recording the current state (if any).

Parameters:

properties - an ArrayList, specifying the properties.

removePropertyToRecord

void removePropertyToRecord(java.lang.String propertyName)

This method tells the recorder to remove the given property from its current set of properties whose state it is recording.

Parameters:

propertyName - a String, specifying the property.

removePropertiesToRecord

void removePropertiesToRecord(java.util.ArrayList properties)

This method tells the recorder to remove the given multiple property from its current set of properties whose state it is recording.

Parameters:

properties - an ArrayList, specifying the properties.

getCurrentState

java.lang.Object getCurrentState()

This method returns the current state of the properties that this recorder is recording. Please note that the return type is an object, which will be intrepreted according to the ontological type of the recorder.

Parameters:

none. -

Returns:

An Object returning the current state of the properties that this recorder is recording.