com.aldebaran.qi.helper.proxies

Class ALPreferenceManager

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALPreferenceManager

public class ALPreferenceManager
extends ALProxy

See Also:

NAOqi APIs for ALPreferenceManager

Field Summary

Fields inherited from class com.aldebaran.qi.helper.ALProxy

name, service

Constructor Summary

Constructors

Constructor and Description
ALPreferenceManager(Session session)

Method Summary

Modifier and Type	Method and Description
void	clearStats()
void	exit() Exits and unregisters the module.
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.util.List<java.lang.String>	getDomainList() Get available preferences domain
java.lang.Object	getMethodHelp(java.lang.String methodName) Retrieves a method's description.
java.util.List<java.lang.String>	getMethodList() Retrieves the module's method list.
java.lang.Object	getModuleHelp() Retrieves the module's description.
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.Object	getValue(java.lang.String domain, java.lang.String setting) Get specified preference
java.util.List<java.util.List<java.lang.Object>>	getValueList(java.lang.String domain) Get preferences names and values for a given domain
void	importPrefFile(java.lang.String domain, java.lang.String applicationName, java.lang.String filename, java.lang.Boolean override) Import a preferences XML file
java.lang.Boolean	isRunning(java.lang.Integer id) Returns true if the method is currently running.
java.lang.Boolean	isStatsEnabled()
java.lang.Boolean	isTraceEnabled()
java.lang.Boolean	ping() Just a ping.
void	removeDomainValues(java.lang.String domain) Remove an entire preference domain
void	removeValue(java.lang.String domain, java.lang.String setting) Remove specified preference
void	setValue(java.lang.String domain, java.lang.String setting, java.lang.Object value) Set specified preference
void	stop(java.lang.Integer id) returns true if the method is currently running
void	update() Synchronizes local preferences with preferences stored on a server.
java.lang.String	version() Returns the version of the module.
java.lang.Boolean	wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) Wait for the end of a long running method that was called using 'post'

Methods inherited from class com.aldebaran.qi.helper.ALProxy

call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ALPreferenceManager

public ALPreferenceManager(Session session)
                    throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

isStatsEnabled

public java.lang.Boolean isStatsEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

clearStats

public void clearStats()
                throws CallError,
                       java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

isTraceEnabled

public java.lang.Boolean isTraceEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

exit

public void exit()
          throws CallError,
                 java.lang.InterruptedException

Exits and unregisters the module.

Throws:

CallError

java.lang.InterruptedException

version

public java.lang.String version()
                         throws CallError,
                                java.lang.InterruptedException

Returns the version of the module.

Returns:

A string containing the version of the module.

Throws:

CallError

java.lang.InterruptedException

ping

public java.lang.Boolean ping()
                       throws CallError,
                              java.lang.InterruptedException

Just a ping. Always returns true

Returns:

returns true

Throws:

CallError

java.lang.InterruptedException

getMethodList

public java.util.List<java.lang.String> getMethodList()
                                               throws CallError,
                                                      java.lang.InterruptedException

Retrieves the module's method list.

Returns:

An array of method names.

Throws:

CallError

java.lang.InterruptedException

getMethodHelp

public java.lang.Object getMethodHelp(java.lang.String methodName)
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves a method's description.

Parameters:

methodName - The name of the method.

Returns:

A structure containing the method's description.

Throws:

CallError

java.lang.InterruptedException

getModuleHelp

public java.lang.Object getModuleHelp()
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves the module's description.

Returns:

A structure describing the module.

Throws:

CallError

java.lang.InterruptedException

wait

public java.lang.Boolean wait(java.lang.Integer id,
                              java.lang.Integer timeoutPeriod)
                       throws CallError,
                              java.lang.InterruptedException

Wait for the end of a long running method that was called using 'post'

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

timeoutPeriod - The timeout period in ms. To wait indefinately, use a timeoutPeriod of zero.

Returns:

True if the timeout period terminated. False if the method returned.

Throws:

CallError

java.lang.InterruptedException

isRunning

public java.lang.Boolean isRunning(java.lang.Integer id)
                            throws CallError,
                                   java.lang.InterruptedException

Returns true if the method is currently running.

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

Returns:

True if the method is currently running

Throws:

CallError

java.lang.InterruptedException

stop

public void stop(java.lang.Integer id)
          throws CallError,
                 java.lang.InterruptedException

returns true if the method is currently running

Parameters:

id - the ID of the method to wait for

Throws:

CallError

java.lang.InterruptedException

getBrokerName

public java.lang.String getBrokerName()
                               throws CallError,
                                      java.lang.InterruptedException

Gets the name of the parent broker.

Returns:

The name of the parent broker.

Throws:

CallError

java.lang.InterruptedException

getUsage

public java.lang.String getUsage(java.lang.String name)
                          throws CallError,
                                 java.lang.InterruptedException

Gets the method usage string. This summarises how to use the method.

Parameters:

name - The name of the method.

Returns:

A string that summarises the usage of the method.

Throws:

CallError

java.lang.InterruptedException

getValue

public java.lang.Object getValue(java.lang.String domain,
                                 java.lang.String setting)
                          throws CallError,
                                 java.lang.InterruptedException

Get specified preference

Parameters:

domain - Preference domain

setting - Preference setting

Returns:

corresponding preferences value

Throws:

CallError

java.lang.InterruptedException

setValue

public void setValue(java.lang.String domain,
                     java.lang.String setting,
                     java.lang.Object value)
              throws CallError,
                     java.lang.InterruptedException

Set specified preference

Parameters:

domain - Preference domain

setting - Preference setting

value - Preference value

Throws:

CallError

java.lang.InterruptedException

getValueList

public java.util.List<java.util.List<java.lang.Object>> getValueList(java.lang.String domain)
                                                              throws CallError,
                                                                     java.lang.InterruptedException

Get preferences names and values for a given domain

Parameters:

domain - Preference domain

Returns:

a list of preferences names and values associated to the domain

Throws:

CallError

java.lang.InterruptedException

getDomainList

public java.util.List<java.lang.String> getDomainList()
                                               throws CallError,
                                                      java.lang.InterruptedException

Get available preferences domain

Returns:

a list containing all the available domain names

Throws:

CallError

java.lang.InterruptedException

removeValue

public void removeValue(java.lang.String domain,
                        java.lang.String setting)
                 throws CallError,
                        java.lang.InterruptedException

Remove specified preference

Parameters:

domain - Preference domain

setting - Preference setting

Throws:

CallError

java.lang.InterruptedException

removeDomainValues

public void removeDomainValues(java.lang.String domain)
                        throws CallError,
                               java.lang.InterruptedException

Remove an entire preference domain

Parameters:

domain - Preference domain

Throws:

CallError

java.lang.InterruptedException

importPrefFile

public void importPrefFile(java.lang.String domain,
                           java.lang.String applicationName,
                           java.lang.String filename,
                           java.lang.Boolean override)
                    throws CallError,
                           java.lang.InterruptedException

Import a preferences XML file

Parameters:

domain - Preference domain: all preferences values found in XML file will be imported in that domain.

applicationName - Application name: will be used to search for preference file on disk (in location of type /applicationName/filename).

filename - Preference XML filename

override - Set this to true if you want to override preferences that already exist with preferences in imported XML file

Throws:

CallError

java.lang.InterruptedException

update

public void update()
            throws CallError,
                   java.lang.InterruptedException

Synchronizes local preferences with preferences stored on a server.

Throws:

CallError

java.lang.InterruptedException