alma.ACS.jbaci

Interface DataAccess

All Known Implementing Classes:

DataAccessSupport, MemoryDataAccess

public interface DataAccess

Data access interface.

Author:

Matej Sekoranja

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataAccess.OnChangeNotSupportedException Exeption thrown if DataAccess does not support on-change notifications.
static interface	DataAccess.ValueChangeListener Value change listener interface.

Method Summary

Modifier and Type	Method and Description
void	addValueChangeListener(DataAccess.ValueChangeListener listener) Add value change listener.
java.lang.Object	get(CompletionHolder completionHolder) Retrieve value or throw AcsJExcption in case of failure.
boolean	initializeValue() Flag indicating if property should initialize value (to default value) when initializing.
void	removeValueChangeListener(DataAccess.ValueChangeListener listener) Remove value change listener.
void	set(java.lang.Object value, CompletionHolder completion) Set value or throw AcsJExcption in case of failure.

Method Detail

addValueChangeListener

void addValueChangeListener(DataAccess.ValueChangeListener listener)
                     throws DataAccess.OnChangeNotSupportedException

Add value change listener.

Parameters:

listener - listener to be notified on every value change.

Throws:

NotSupportedException - throws id this DataAccess does not support on-change notifications - exeptions provides recommended pool time property.

DataAccess.OnChangeNotSupportedException

See Also:

NotSupportedException

removeValueChangeListener

void removeValueChangeListener(DataAccess.ValueChangeListener listener)

Remove value change listener.

Parameters:

listener - listener to be removed.

get

java.lang.Object get(CompletionHolder completionHolder)
              throws AcsJException

Retrieve value or throw AcsJExcption in case of failure.

Parameters:

completionHolder - completion holder. If completionHolder.value is left to null (by this method), caller is responsible to create a no-error completion with current timestamp later. Use alma.ACS.jbaci.CompletionUtil class to generate no-error completion.

Returns:

read value, non-null.

Throws:

ACS - exception if case of failure.

AcsJException

See Also:

CompletionUtil.generateNoErrorCompletion()

initializeValue

boolean initializeValue()

Flag indicating if property should initialize value (to default value) when initializing.

Returns:

flag indicating if property should initialize value (to default value) when initializing.

set

void set(java.lang.Object value,
         CompletionHolder completion)
  throws AcsJException

Set value or throw AcsJExcption in case of failure.

Parameters:

value - value to be set, non-null.

completionHolder - completion holder. If completionHolder.value is left to null (by this method), caller is responsible to create a no-error completion with current timestamp later. Use alma.ACS.jbaci.CompletionUtil class to generate no-error completion.

Throws:

ACS - exception if case of failure.

AcsJException