com.atlassian.jira.jql.operand
Interface JqlFunctionHandlerRegistry

All Known Implementing Classes:
DefaultJqlFunctionHandlerRegistry

public interface JqlFunctionHandlerRegistry

Registry for JqlFunctions. Can resolve a OperandHandler of type FunctionOperand for a provided FunctionOperand. The handler returned wraps a registered JqlFunction.

Since:
v4.0

Method Summary
 List<String> getAllFunctionNames()
          Fetches all function names ordered alphabetically.
 FunctionOperandHandler getOperandHandler(FunctionOperand operand)
          Fetches the associated OperandHandler for the provided FunctionOperand.
 void registerFunctionHandler(JqlFunction jqlFunction)
          Registers a JqlFunction plugin once it has been enabled by the system.
 void unregisterFunctionHandler(JqlFunction function)
          Unregisters a JqlFunction plugin.
 

Method Detail

registerFunctionHandler

void registerFunctionHandler(JqlFunction jqlFunction)
Registers a JqlFunction plugin once it has been enabled by the system.

Parameters:
jqlFunction - the actual function to register.

unregisterFunctionHandler

void unregisterFunctionHandler(JqlFunction function)
Unregisters a JqlFunction plugin.

Parameters:
function - the actual function to unregister.

getOperandHandler

FunctionOperandHandler getOperandHandler(FunctionOperand operand)
Fetches the associated OperandHandler for the provided FunctionOperand. The returned handler is looked up by the name of the FunctionOperand (case insensitive).

Parameters:
operand - that defines the name for which we want to find the operand handler.
Returns:
the operand handler associated with this operand, null if there is none.

getAllFunctionNames

List<String> getAllFunctionNames()
Fetches all function names ordered alphabetically.

Returns:
all function names ordered alphabetically, an empty collection if there are none.


Copyright © 2002-2010 Atlassian. All Rights Reserved.