com.phoenix_int.aserver
Interface IPHXSelfManager

All Known Subinterfaces:

IPHXSelfManager2, IPHXSelfManager3

All Known Implementing Classes:

PHXSimpleSelfManager, PHXSimpleSelfManager2, PHXSimpleSelfManager3

public interface IPHXSelfManager

This interface is for components that determine their properties at runtime. These types of components do not know what variables they have until they are started. Examples include wrappers that communicate with external programs - once the wrapper starts up, it loads a file into the external program. The external program then can be queried for it's variables, which are then relayed through the analysis object. To handle this type of situation, a component should implement the functions provided by this interface. When present, the Analysis Server will call these functions. If an object does not implement this interface, the Analysis Server will use the default Bean mechanisms for interacting with the object.

See Also:

IPHXComponent, IPHXAnalysis, IPHXDriver

Method Summary

PHXMethodDescriptor[]	getMethodDescriptors() function for retrieving the methods of an object
PHXPropertyDescriptor[]	getPropertyDescriptors(java.lang.String name) function for retrieving the properties of an object
java.lang.String	getValue(java.lang.String name) function for retrieving a specified value
java.lang.String	invoke(java.lang.String methodName) invokes the named method
void	setValue(java.lang.String name, java.lang.String value) function for setting a specified value

Method Detail

getValue

java.lang.String getValue(java.lang.String name)
                          throws PHXNoSuchObjectException,
                                 java.lang.Exception

function for retrieving a specified value

Parameters:

name - the value to retrieve

Returns:

a String reprentation of the value

Throws:

PHXNoSuchObjectException - thrown if the specified name does not exist

java.lang.Exception - an exception that may occur

setValue

void setValue(java.lang.String name,
              java.lang.String value)
              throws PHXNoSuchObjectException,
                     PHXNoSuchWriteableObjectException,
                     java.lang.Exception

function for setting a specified value

Parameters:

name - the value to retrieve

value - the String representation of the value to set

Throws:

PHXNoSuchObjectException - thrown if the specified name does not exist

PHXNoSuchWriteableObjectException - thrown if the specified name cannot be modified

java.lang.Exception - an exception that may occur

getPropertyDescriptors

PHXPropertyDescriptor[] getPropertyDescriptors(java.lang.String name)
                                               throws PHXNoSuchObjectException,
                                                      java.lang.Exception

function for retrieving the properties of an object

Parameters:

name - the object to retrieve descriptors for.

Returns:

an array of PHXPropertyDescriptors

Throws:

PHXNoSuchObjectException - thrown if the specified name does not exist

java.lang.Exception - an exception that may occur

getMethodDescriptors

PHXMethodDescriptor[] getMethodDescriptors()
                                           throws java.lang.Exception

function for retrieving the methods of an object

Returns:

an array of MethodDescriptors

Throws:

java.lang.Exception - an exception that may occur

invoke

java.lang.String invoke(java.lang.String methodName)
                        throws java.lang.Exception

invokes the named method

Parameters:

methodName - the name of the method to invoke on obj

Returns:

the return value from the invocation

Throws:

java.lang.Exception - an exception that may occur