|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 2 (11.1.2) E27155-01 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.security.jps.service.policystore.info.BuiltInFunctionsHandler
public final class BuiltInFunctionsHandler
This class provides a wrapper for various definitions for all built in functions supported by OES. The functions themselves are separated in multiple enums and this class provides a common interface over all of them. Note, this class does not support a method to get all functions of a given category. This should be obtained using a FunctionSearchQuery and running a search.
Constructor Summary | |
---|---|
BuiltInFunctionsHandler() |
Method Summary | |
---|---|
static boolean |
functionHasVariableArgs(java.lang.String name) Returns true if the given function has variable number of arguments. |
static java.lang.String[] |
getAllBuiltInFunctions() Returns all supported built-in functions. |
static DataType.TYPE |
getDataTypeOfArg(BuiltInFunctionsHandler.SupportedArgTypes spt) Get DataType.TYPE for given SupportedArgType. |
static java.lang.String |
getDescriptionInEnglish(java.lang.String functionName) Returns english language description for a funtion given simple name |
static java.lang.String |
getDisplayNameInEnglish(java.lang.String functionName) Returns english language display name for a funtion given simple name |
static java.lang.String |
getFullyQualifiedName(java.lang.String name) Return fully qualified name of this function. |
static RuleExpressionEntry.FunctionCategory |
getFunctionCategory(java.lang.String name) Returns category of a funtion given simple name |
static java.lang.String |
getFunctionFullyQualifiedName(java.lang.String name) Returns fully qualified name for a funtion given simple name |
static BuiltInFunctionsHandler.SupportedArgTypes[] |
getFunctionInputParameters(java.lang.String name) Returns list of function input parameters given name. |
static java.util.List<FunctionEntry.ARG_TYPE> |
getFunctionParameterValueTypes(java.lang.String name) Returns parameter value types of input parameters for a function (whether input parameter is a single object/ bag/ set of objects). |
static java.lang.Class<? extends DataType> |
getFunctionReturnType(java.lang.String name) Returns return type of a funtion given simple name |
static FunctionEntry.ARG_TYPE |
getFunctionReturnValueType(java.lang.String name) Returns type of value returned by a funtion given simple name |
static VarArgsInfo |
getFunctionVarArgsInfo(java.lang.String name) Returns variable argument information for a funtion given simple name |
static java.util.List<java.lang.Class<? extends ExpressionComponent>> |
getList(BuiltInFunctionsHandler.SupportedArgTypes... a) |
static java.lang.String |
getOperator(java.lang.String funcName) REturns the operand for a function if the function is an operator. |
static java.lang.String |
getSimpleName(java.lang.String qualifiedName) Returns simple name of this function given fully qualified name. |
static boolean |
isBuiltInFunction(java.lang.String name) Returns true if the given function is supported out of the box. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public BuiltInFunctionsHandler()
Method Detail |
---|
public static DataType.TYPE getDataTypeOfArg(BuiltInFunctionsHandler.SupportedArgTypes spt)
public static java.lang.String getFullyQualifiedName(java.lang.String name) throws InvalidArgumentException
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DOUBLE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static java.lang.String getSimpleName(java.lang.String qualifiedName)
name
- Expected to be in form of a complete name For example, urn:oasis:names:tc:xacml:1.0:function:boolean-equalInvalidArgumentException
- if function name is not one of the supported built-in functionspublic static RuleExpressionEntry.FunctionCategory getFunctionCategory(java.lang.String name) throws InvalidArgumentException
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static boolean isBuiltInFunction(java.lang.String name)
name
- Name of the function, expected to be a simple name; not fully qualified one.public static java.lang.String[] getAllBuiltInFunctions()
public static java.lang.String getOperator(java.lang.String funcName)
funcName
-public static java.lang.Class<? extends DataType> getFunctionReturnType(java.lang.String name) throws InvalidArgumentException
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static FunctionEntry.ARG_TYPE getFunctionReturnValueType(java.lang.String name) throws InvalidArgumentException
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static BuiltInFunctionsHandler.SupportedArgTypes[] getFunctionInputParameters(java.lang.String name) throws InvalidArgumentException
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static java.util.List<FunctionEntry.ARG_TYPE> getFunctionParameterValueTypes(java.lang.String name) throws InvalidArgumentException
InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static boolean functionHasVariableArgs(java.lang.String name) throws InvalidArgumentException
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static VarArgsInfo getFunctionVarArgsInfo(java.lang.String name) throws InvalidArgumentException
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static java.lang.String getFunctionFullyQualifiedName(java.lang.String name) throws InvalidArgumentException
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name()InvalidArgumentException
- if function name is not one of the supported built-in functionspublic static java.util.List<java.lang.Class<? extends ExpressionComponent>> getList(BuiltInFunctionsHandler.SupportedArgTypes... a)
public static java.lang.String getDisplayNameInEnglish(java.lang.String functionName)
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name() Returns null, if the function is not supported.public static java.lang.String getDescriptionInEnglish(java.lang.String functionName)
name
- Expected to be in form of <some enum constant>.name() For example, EqualiyFunctions.DATE_EQUAL.name() You can also use RuleExpressionEntry.BuiltInFunctions.DATE_EQUAL.name() Returns null, if the function is not supported.
|
Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server 11g Release 2 (11.1.2) E27155-01 ESAPI |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |