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

Interface IGPTechnicalDescription

public interface IGPTechnicalDescription

Returns meta information about technical callable object implementation. The description includes:

• Attributes that provide additional information about the callable object.
• The (technical) application input parameters expected by the callable object.
• The (technical) configuration parameters expected by the callable object.
• The (technical) application output paramters expected by the callable object.
• A list of possible result states for the callable object.
• A list of possible exceptions for the callable object.

  Method Summary

  IGPConfigAttributeInfo	addConfigurationAttribute(String name) Adds a new configuration attribute with specified name with type string
  IGPConfigAttributeInfo	addConfigurationAttribute(String name, int type) Adds a new configuration attribute with specified name and type
  IGPExceptionInfo	addProcessException(String exceptionName) Adds a process exception for the callable object
  IGPCOResultStateInfo	addResultState(String resultStateName) Add a results state for the callable object
  Collection	getConfigurationAttributes() Returns all configuration attribute definitions
  Collection	getExceptions() Rturns all the process exception definitions
  IGPStructureInfo	getInputStructureInfo() Returns mutable input parameters definition.
  IGPStructureInfo	getOutputStructureInfo() Returns mutable output paramters definition.
  Collection	getResultStates() Returns all result state definitions
  boolean	isAdditionalInputParamAllowed() Determines whether or not the implementation accepts additional input parameters.
  boolean	isAdditionalOutputParamAllowed() Determines whether or not the implementation accepts additional output parameters.
  void	setAdditionalInputParamAllowed(boolean isAllowed) Speciefies whether or not the implementation accepts additional input parameters.
  void	setAdditionalOutputParamAllowed(boolean isAllowed) Speciefies whether or not the implementation accepts additional output parameters.
  void	setDescriptionKey(String descriptionKey) Sets the key for the localized description of the callable object
  void	setNameKey(String nameKey) Set the key for the localized name of the callable object
  void	setResourceAccessor(IGPResourceAccessor resourceAccessor) Sets the resource accessor for the callable object

  Method Detail

  getInputStructureInfo

  public IGPStructureInfo getInputStructureInfo()

  Returns mutable input parameters definition. By default there is an empty root structure for the input

  Returns:

  the root structure for the input paramters

  getOutputStructureInfo

  public IGPStructureInfo getOutputStructureInfo()

  Returns mutable output paramters definition. By default there is an empty root structure for the output

  Returns:

  the root strucure for the output parameters

  addConfigurationAttribute

  public IGPConfigAttributeInfo addConfigurationAttribute(String name)

  Adds a new configuration attribute with specified name with type string

  Parameters:

  name - the name of the attribute

  Returns:

  the configuration attribute definition

  addConfigurationAttribute

  public IGPConfigAttributeInfo addConfigurationAttribute(String name,
                                                          int type)

  Adds a new configuration attribute with specified name and type

  Parameters:

  name - the name of the configuration attribute

  type - the type of the configuration attribute

  Returns:

  the configuration attribute definition

  getConfigurationAttributes

  public Collection getConfigurationAttributes()

  Returns all configuration attribute definitions

  Returns:

  collection of IGPConfigAttributeInfo

  addResultState

  public IGPCOResultStateInfo addResultState(String resultStateName)

  Add a results state for the callable object

  Parameters:

  resultStateName - the name of the result state

  Returns:

  the result state definition

  getResultStates

  public Collection getResultStates()

  Returns all result state definitions

  Returns:

  collection of IResultStateInfo

  addProcessException

  public IGPExceptionInfo addProcessException(String exceptionName)

  Adds a process exception for the callable object

  Parameters:

  exceptionName - the name of the process exception

  Returns:

  the process exception definition

  getExceptions

  public Collection getExceptions()

  Rturns all the process exception definitions

  Returns:

  collection of IGPExceptionInfo

  setResourceAccessor

  public void setResourceAccessor(IGPResourceAccessor resourceAccessor)

  Sets the resource accessor for the callable object

  Parameters:

  resourceAccessor -

  setNameKey

  public void setNameKey(String nameKey)

  Set the key for the localized name of the callable object

  Parameters:

  nameKey -

  setDescriptionKey

  public void setDescriptionKey(String descriptionKey)

  Sets the key for the localized description of the callable object

  Parameters:

  descriptionKey -

  isAdditionalInputParamAllowed

  public boolean isAdditionalInputParamAllowed()

  Determines whether or not the implementation accepts additional input parameters.

  Returns:

  whether or not additional input parameters are allowed

  setAdditionalInputParamAllowed

  public void setAdditionalInputParamAllowed(boolean isAllowed)

  Speciefies whether or not the implementation accepts additional input parameters.

  Parameters:

  isAllowed - whether or not additional input parameters are allowed

  isAdditionalOutputParamAllowed

  public boolean isAdditionalOutputParamAllowed()

  Determines whether or not the implementation accepts additional output parameters.

  Returns:

  whether or not additional output parameters are allowed

  setAdditionalOutputParamAllowed

  public void setAdditionalOutputParamAllowed(boolean isAllowed)

  Speciefies whether or not the implementation accepts additional output parameters.

  Parameters:

  isAllowed - whether or not additional output parameters are allowed