com.sap.caf.eu.gp.co.api

Interface IGPPhysicalCallableObject

public interface IGPPhysicalCallableObject

The physical callable object stores technical information about the object that should be invoked during action execution. The technical configuration properties store information about the development component and name of he object that should be invoked. The physical callable object stores information about the possible result states and process exceptions that could be result from the object execution. The physical callable object stores also information about some UI behavior of the callable object in the Guided Procedures design time, such as visibility of the different configuration screens.

Version:

1.0

Field Summary

static int	VIEW_VISIBILITY_PURPOSE_ALL The constant indicates that the respective view visibility has to be set for all purposes(create,edit and display).
static int	VIEW_VISIBILITY_PURPOSE_CHANGE The constant indicates that view which visiblity has to be determined is inteded for use for editing CO.
static int	VIEW_VISIBILITY_PURPOSE_CREATE The constant indicates that view which visiblity has to be determined is inteded for use for CO creation.
static int	VIEW_VISIBILITY_PURPOSE_DISPLAY The constant indicates that view which visiblity has to be determined is inteded for use for displaying CO(read only).

Method Summary

void	addProcessException(String exceptionName, String text) Adds a new exception name to the list of available exceptions.
void	addResultState(String resultStateName, String text) Adds a new result state to the list of available result states.
void	clearProcessExceptions() Clears the list of available process exceptions.
void	clearResultStates() Clears the list of available technical result states.
Iterator	configPropertyNames() Returns an enumeration of all config parameter keys.
String	getConfigProperty(String name) Returns the value of a configuration parameter or null if no value is available for the parameter.
int	getProcessExceptionCount() Returns the number of process exceptions.
Iterator	getProcessExceptions() Returns a list of the technical names of the process exceptions.
IGPResultStateInfo	getResultState(String name) Returns the result state with the specified name or null
int	getResultStateCount() Returns the number of available result states.
Iterator	getResultStates() Returns a list of the technical names of the result states of the callable object.
String	getTechnicalConfigProperty(String name) Returns the value of a technical configuration parameter (as exposed by the implementation's description).
Iterator	getTechnicalConfigPropertyNames() Returns an enumeration of all technical configuration parameter names.
boolean	isConfigViewVisible(int purpose, boolean defaultValue) Retruns whether the Config view has to be visible or not
boolean	isInputViewVisible(int purpose, boolean defaultValue) Retruns whether the Input parameters view has to be visible or not
boolean	isOutputViewVisible(int purpose, boolean defaultValue) Retruns whether the Output parameters view has to be visible or not
boolean	isSelectViewVisible(int purpose, boolean defaultValue) Retruns whether the Select view has to be visible or not
void	removeConfigProperty(String name) Removes a named config parameter.
void	removeProcessException(String exceptionName) Removes the exception with the specified technical name from the list of available exceptions.
void	removeResultState(String resultStateName) Removes the result state with the specified technical name from the list of available result states.
void	removeTechnicalConfigProperty(String name) Removes a named technical config parameter.
void	removeTextProperty(String propertyKey) Removes a property key.
String	resolveTextProperty(String propertyKey, Locale locale) Resolves a text for a property.
void	setConfigProperty(String name, String value) Sets a configuration parameter (and overrides any old occurance of the parameter).
void	setConfigViewVisible(boolean visible, int purpose) Setter for the Config view visiblity
void	setInputParameters(IGPStructureInfo inputStructure) Sets the input parameters of the physical object.
void	setInputViewVisible(boolean visible, int purpose) Setter for the Input parameters view visiblity
void	setOutputParameters(IGPStructureInfo outputStructure) Sets the input parameters of the physical object.
void	setOutputViewVisible(boolean visible, int purpose) Setter for the Output parameters view visiblity
void	setSelectViewVisible(boolean visible, int purpose) Setter for the Select view visiblity
void	setTechnicalConfigProperty(String name, String stringValue) Sets the value of a technical configuration parameter (as exposed by the implementation's description).
void	setTextProperty(String propertyKey, String text) Sets a translateable text under as a property.
Iterator	textPropertyNames() Returns an enumeration of all text property names.

Field Detail

VIEW_VISIBILITY_PURPOSE_CREATE

static final int VIEW_VISIBILITY_PURPOSE_CREATE

The constant indicates that view which visiblity has to be determined is inteded for use for CO creation.

See Also:

Constant Field Values

VIEW_VISIBILITY_PURPOSE_CHANGE

static final int VIEW_VISIBILITY_PURPOSE_CHANGE

The constant indicates that view which visiblity has to be determined is inteded for use for editing CO.

See Also:

Constant Field Values

VIEW_VISIBILITY_PURPOSE_DISPLAY

static final int VIEW_VISIBILITY_PURPOSE_DISPLAY

The constant indicates that view which visiblity has to be determined is inteded for use for displaying CO(read only).

See Also:

Constant Field Values

VIEW_VISIBILITY_PURPOSE_ALL

static final int VIEW_VISIBILITY_PURPOSE_ALL

The constant indicates that the respective view visibility has to be set for all purposes(create,edit and display). The constant cannot be used for getting view visibility.

See Also:

Constant Field Values

Method Detail

setConfigProperty

void setConfigProperty(String name,
                       String value)
                       throws GPInvocationException

Sets a configuration parameter (and overrides any old occurance of the parameter).

Parameters:

name - the parameter name.

value - the parameter value.

Throws:

GPInvocationException - if the entity is not locked or if any of the parameters is invalid.

getConfigProperty

String getConfigProperty(String name)

Returns the value of a configuration parameter or null if no value is available for the parameter.

Parameters:

name - the name of the parameter.

Returns:

the value of a configuration parameter.

configPropertyNames

Iterator configPropertyNames()

Returns an enumeration of all config parameter keys.

Returns:

an enumeration of all config parameter keys.

removeConfigProperty

void removeConfigProperty(String name)

Removes a named config parameter.

Parameters:

name -

setTechnicalConfigProperty

void setTechnicalConfigProperty(String name,
                                String stringValue)
                                throws GPInvocationException

Sets the value of a technical configuration parameter (as exposed by the implementation's description).

Parameters:

name - the name of the parameter

stringValue - the string value

Throws:

GPInvocationException - if the entity is not locked or if any of the parameters is invalid.

getTechnicalConfigProperty

String getTechnicalConfigProperty(String name)

Returns the value of a technical configuration parameter (as exposed by the implementation's description).

Parameters:

name - the name of the parameter

Returns:

the value of the technical configuration parameter.

getTechnicalConfigPropertyNames

Iterator getTechnicalConfigPropertyNames()

Returns an enumeration of all technical configuration parameter names.

Returns:

an enumeration of all technical configuration parameter names.

removeTechnicalConfigProperty

void removeTechnicalConfigProperty(String name)

Removes a named technical config parameter.

Parameters:

name -

setInputParameters

void setInputParameters(IGPStructureInfo inputStructure)
                        throws GPInvocationException,
                               GPEngineException

Sets the input parameters of the physical object.

Parameters:

inputStructure -

Throws:

GPInvocationException

GPEngineException

setOutputParameters

void setOutputParameters(IGPStructureInfo outputStructure)
                         throws GPInvocationException,
                                GPEngineException

Sets the input parameters of the physical object.

Parameters:

inputStructure -

Throws:

GPInvocationException

GPEngineException

getResultStates

Iterator getResultStates()

Returns a list of the technical names of the result states of the callable object.

Returns instances of IResultStateInfo.

Returns:

a list of the technical names.

getResultStateCount

int getResultStateCount()

Returns the number of available result states.

addResultState

void addResultState(String resultStateName,
                    String text)
                    throws GPInvocationException

Adds a new result state to the list of available result states.

Parameters:

resultStateName - the name of the result state.

text - the text of the result state.

Throws:

GPInvocationException - if the name is invalid or if the entity is not locked.

removeResultState

void removeResultState(String resultStateName)
                       throws GPInvocationException

Removes the result state with the specified technical name from the list of available result states.

Parameters:

resultStateName - the name of the result state.

Throws:

GPInvocationException - if the name is invalid or if the entity is not locked.

getResultState

IGPResultStateInfo getResultState(String name)

Returns the result state with the specified name or null

Parameters:

name -

Returns:

clearResultStates

void clearResultStates()
                       throws GPInvocationException

Clears the list of available technical result states.

Throws:

GPInvocationException - if the entity is not locked.

getProcessExceptions

Iterator getProcessExceptions()

Returns a list of the technical names of the process exceptions.

Returns instances of IGPProcessExceptionInfo.

Returns:

a list of the technical names.

addProcessException

void addProcessException(String exceptionName,
                         String text)
                         throws GPInvocationException

Adds a new exception name to the list of available exceptions.

Parameters:

exceptionName - the name of the exception.

text - the human-readable text.

Throws:

GPInvocationException - if the name is invalid or if the entity is not locked.

removeProcessException

void removeProcessException(String exceptionName)
                            throws GPInvocationException

Removes the exception with the specified technical name from the list of available exceptions.

Parameters:

exceptionName - the name of the exception.

Throws:

GPInvocationException - if the name is invalid or if the entity is not locked.

clearProcessExceptions

void clearProcessExceptions()
                            throws GPInvocationException

Clears the list of available process exceptions.

Throws:

GPInvocationException - if the entity is not locked.

getProcessExceptionCount

int getProcessExceptionCount()

Returns the number of process exceptions.

Returns:

isSelectViewVisible

boolean isSelectViewVisible(int purpose,
                            boolean defaultValue)

Retruns whether the Select view has to be visible or not

Parameters:

purpose - indicates what is the intended use(create, change, display) for the Select view (IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ constants). IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ALL cannot be used.

defaultValue - if the visibility has not been set this default value is returned

setSelectViewVisible

void setSelectViewVisible(boolean visible,
                          int purpose)
                          throws GPInvocationException

Setter for the Select view visiblity

Parameters:

visible - whether the view has to be visible or not

purpose - indicates what is the intended use(create, change, display) for the Select view (IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ constants).

Throws:

GPInvocationException

isInputViewVisible

boolean isInputViewVisible(int purpose,
                           boolean defaultValue)

Retruns whether the Input parameters view has to be visible or not

Parameters:

purpose - indicates what is the intended use(create, change, display) for the Input parameters view (IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ constants). IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ALL cannot be used.

defaultValue - if the visibility has not been set this default value is returned

setInputViewVisible

void setInputViewVisible(boolean visible,
                         int purpose)
                         throws GPInvocationException

Setter for the Input parameters view visiblity

Parameters:

visible - whether the view has to be visible or not

purpose - indicates what is the intended use(create, change, display) for the Input view (IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ constants).

Throws:

GPInvocationException

isOutputViewVisible

boolean isOutputViewVisible(int purpose,
                            boolean defaultValue)

Retruns whether the Output parameters view has to be visible or not

Parameters:

purpose - indicates what is the intended use(create, change, display) for the Output parameters view (IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ constants). IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ALL cannot be used.

defaultValue - if the visibility has not been set this default value is returned

setOutputViewVisible

void setOutputViewVisible(boolean visible,
                          int purpose)
                          throws GPInvocationException

Setter for the Output parameters view visiblity

Parameters:

visible - whether the view has to be visible or not

purpose - indicates what is the intended use(create, change, display) for the Output view (IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ constants).

Throws:

GPInvocationException

isConfigViewVisible

boolean isConfigViewVisible(int purpose,
                            boolean defaultValue)

Retruns whether the Config view has to be visible or not

Parameters:

purpose - indicates what is the intended use(create, change, display) for the Config view (IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ constants). IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ALL cannot be used.

defaultValue - if the visibility has not been set this default value is returned

setConfigViewVisible

void setConfigViewVisible(boolean visible,
                          int purpose)
                          throws GPInvocationException

Setter for the Config view visiblity

Parameters:

visible - whether the view has to be visible or not

purpose - indicates what is the intended use(create, change, display) for the Config view (IGPPhysicalCallableObject.VIEW_VISIBILITY_PURPOSE_ constants).

Throws:

GPInvocationException

setTextProperty

void setTextProperty(String propertyKey,
                     String text)
                     throws GPInvocationException

Sets a translateable text under as a property.

Parameters:

propertyKey -

text -

Throws:

GPInvocationException

removeTextProperty

void removeTextProperty(String propertyKey)

Removes a property key.

Parameters:

propertyKey -

resolveTextProperty

String resolveTextProperty(String propertyKey,
                           Locale locale)

Resolves a text for a property. Returns null if the property is not available.

Parameters:

propertyKey -

locale -

Returns:

textPropertyNames

Iterator textPropertyNames()

Returns an enumeration of all text property names.

Returns:

an enumeration of all text property names.