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

Field Summary

Fields

Modifier and Type	Field and Description
static String	DISCOVERY_PARAMETER_CLEAR_CACHE Hints the connector that a request for a fresh un-cached query had been initiated

Method Summary

Modifier and Type	Method and Description
IFunction	getFunction(String functionName) Returns an IFunction interface for a specific EIS function.
IFunction	getFunction(String functionName, Map<String,String> discoveryConfiguration) Returns an IFunction interface for a specific EIS function.
Set<IFunction>	getFunctions() Returns the EIS functions the current user can execute.
Set<IFunction>	getFunctions(Map<String,String> discoveryConfiguration) Returns the EIS functions the current user can execute.
Set<IFunction>	getFunctions(String functionNameRegularExpression, String functionGroupRegularExpression) Returns the EIS functions the current user can execute given a filter for function name and function group.
Set<IFunction>	getFunctions(String functionNameRegularExpression, String functionGroupRegularExpression, Map<String,String> discoveryConfiguration) Returns the EIS functions the current user can execute given a filter for function name and function group.
Set<String>	getGroupNames(String functionGroupRegularExpression) Returns a set of all the names of the function groups
Set<String>	getGroupNames(String functionGroupRegularExpression, Map<String,String> discoveryConfiguration) Returns a set of all the names of the function groups

Field Detail

DISCOVERY_PARAMETER_CLEAR_CACHE

static final String DISCOVERY_PARAMETER_CLEAR_CACHE

Hints the connector that a request for a fresh un-cached query had been initiated

See Also:

Constant Field Values

Method Detail

getFunctions

Set<IFunction> getFunctions(Map<String,String> discoveryConfiguration)
                     throws ConnectorException

Returns the EIS functions the current user can execute.

Parameters:

discoveryConfiguration - Map containing special consideration when discovering the function metadata

Returns:

a Set of IFunctions.

Throws:

ConnectorException - if connector is failed

See Also:

IFunction

getFunctions

Set<IFunction> getFunctions()
                     throws ConnectorException

Returns the EIS functions the current user can execute.

Returns:

a Set of IFunctions.

Throws:

ConnectorException - if connector is failed

See Also:

IFunction

getFunction

IFunction getFunction(String functionName)
               throws FunctionNotFoundException,
                      ConnectorException

Returns an IFunction interface for a specific EIS function.

Parameters:

functionName - the name of the function.

Returns:

IFunction interface.

Throws:

FunctionNotFoundException - if function not found

ConnectorException - if connector is failed

See Also:

IFunction

getFunction

IFunction getFunction(String functionName,
                      Map<String,String> discoveryConfiguration)
               throws FunctionNotFoundException,
                      ConnectorException

Returns an IFunction interface for a specific EIS function.

Parameters:

functionName - the name of the function.

discoveryConfiguration - Map containing special consideration when discovering the function metadata

Returns:

IFunction interface.

Throws:

FunctionNotFoundException - if function not found

ConnectorException - if connector is failed

See Also:

IFunction

getFunctions

Set<IFunction> getFunctions(String functionNameRegularExpression,
                            String functionGroupRegularExpression,
                            Map<String,String> discoveryConfiguration)
                     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.

discoveryConfiguration - Map containing special consideration when discovering the function metadata

Returns:

a Set of IFunctions.

Throws:

ConnectorException - if connector is failed

See Also:

IFunction

getFunctions

Set<IFunction> getFunctions(String functionNameRegularExpression,
                            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.

Throws:

ConnectorException - if connector is failed

See Also:

IFunction

getGroupNames

Set<String> getGroupNames(String functionGroupRegularExpression)

Returns a set of all the names of the function groups

Parameters:

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

Returns:

Set all the function groups names

getGroupNames

Set<String> getGroupNames(String functionGroupRegularExpression,
                          Map<String,String> discoveryConfiguration)

Returns a set of all the names of the function groups

Parameters:

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

discoveryConfiguration - Map containing special consideration when discovering the function metadata

Returns:

Set all the function groups names