com.sapportals.connector.metadata.functions
Interface IFunctionsMetaData

public interface IFunctionsMetaData

This interface exposes metadata for EIS functions. Use this interface in order to get the EIS functions list, get a specific function metadata, or get a list of functions using a regular expression in order to filter the list

Version:

1.0

Method Summary

IFunction	getFunction(java.lang.String functionName) Returns an IFunction interface for a specific EIS function.
java.util.Set	getFunctions() Returns the EIS functions the current user can execute.
java.util.Set	getFunctions(java.lang.String functionNameRegularExpression, java.lang.String functionGroupRegularExpression) Returns the EIS functions the current user can execute given a filter for function name and function group.
java.util.Set	getGroupNames(java.lang.String functionGroupRegularExpression) Returns a set of all the names of the function groups

Method Detail

getFunctions

public java.util.Set getFunctions()
                           throws ConnectorException

Returns the EIS functions the current user can execute.

Returns:

A Set of IFunctions.

See Also:

IFunction

getFunction

public IFunction getFunction(java.lang.String functionName)
                      throws FunctionNotFoundException,
                             ConnectorException

Returns an IFunction interface for a specific EIS function.

Parameters:

functionName - The name of the function.

Returns:

IFunction interface.

See Also:

IFunction

getFunctions

public java.util.Set getFunctions(java.lang.String functionNameRegularExpression,
                                  java.lang.String functionGroupRegularExpression)
                           throws ConnectorException

Returns the EIS functions the current user can execute given a filter for function name and function group.

Parameters:

functionNameRegularExpression - A regular expression for the name of the function.

functionGroupRegularExpression - A regular expression for the group of the function.

Returns:

A Set of IFunctions.

See Also:

IFunction

getGroupNames

public java.util.Set getGroupNames(java.lang.String functionGroupRegularExpression)

Returns a set of all the names of the function groups

Returns:

Set all the function groups names