com.highqsoft.avalon.service

Interface VariableInterface

All Known Implementing Classes:

AbstractUpdateIni, AbstractVariable, DataSizeVariable, DbPasswordVariable, DebuglevelVariable, FileRootExtrefVariable, FileRootManagedVariable, FileRootVariable, FileSymbolVariable, MappedFilesVariable, MaxNoSessionVariable, MemoryUsageVariable, NoInstancesVariable, NoSessionVariable, ObjectUsageVariable, StatusVariable, SystemInfoVariable, UnmapFileVariable, WatchdogCountVariable

public interface VariableInterface

The variable interface for the avalon control service.

Author:

karst

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	get() Get the values of the variable
boolean	getable() Is the variable a READ variable, can this variable be used in the get method.
java.lang.String	getDescription() Get the description of the variable
java.lang.String	getName() Get the name of the variable
void	set(java.lang.String value) Set the value to the variable
boolean	setable() Is the variable a WRITE variable, can this variable be used in the set method.
void	setFactory(AoFactoryIF aoFactory) Set the factory for the access to the C implementation
void	setSession(AoSession aoSession) Set the session for the access to the C implementation

Method Detail

getName

java.lang.String getName()

Get the name of the variable

Returns:

the name

getDescription

java.lang.String getDescription()

Get the description of the variable

Returns:

the description

get

java.lang.String[] get()
                       throws com.highqsoft.avalon.AvalonException

Get the values of the variable

Returns:

the values

Throws:

com.highqsoft.avalon.AvalonException - any occurring Avalon exception.

set

void set(java.lang.String value)
         throws com.highqsoft.avalon.AvalonException

Set the value to the variable

Parameters:

value - the new value

Throws:

com.highqsoft.avalon.AvalonException - any occurring Avalon exception

getable

boolean getable()
                throws com.highqsoft.avalon.AvalonException

Is the variable a READ variable, can this variable be used in the get method.

Returns:

true when the get method can be used.

Throws:

com.highqsoft.avalon.AvalonException - any occurring Avalon exception

setable

boolean setable()
                throws com.highqsoft.avalon.AvalonException

Is the variable a WRITE variable, can this variable be used in the set method.

Returns:

true when the set method can be used.

Throws:

com.highqsoft.avalon.AvalonException - any occurring Avalon exception

setFactory

void setFactory(AoFactoryIF aoFactory)

Set the factory for the access to the C implementation

Parameters:

aoFactory - the com.highqsoft.avalon.AoFactory

setSession

void setSession(AoSession aoSession)

Set the session for the access to the C implementation

Parameters:

aoSession - the com.highqsoft.avalon.AoSession