Interface ActionManager
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
ActionService
public interface ActionManager extends Serializable
- Author:
- Bogdan Stefanescu
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddAction(Action action)booleancheckFilter(String filterId, ActionContext context)Returns false if given filter evaluation is supposed to deny access when checking for this filter.booleancheckFilters(List<String> filterIds, ActionContext context)Returns false if given filters evaluation is supposed to deny access when checking for this filter.booleancheckFilters(Action action, ActionContext context)ActiongetAction(String actionId)ActiongetAction(String actionId, ActionContext context, boolean hideUnavailableActions)Returns action with given id, evaluating its filters in given context, and returning null if filters evaluation denies access or if action is not found.List<Action>getActions(String category, ActionContext context)Gets actions for a category (filters are evaluated).List<Action>getActions(String category, ActionContext context, boolean hideUnavailableActions)Gets actions for a category (filters are evaluated).List<Action>getAllActions(String category)Gets all actions in a category (filters are NOT evaluated).ActionFiltergetFilter(String filterId)ActionFilter[]getFilters(String actionId)booleanisEnabled(String actionId, ActionContext context)booleanisRegistered(String actionId)voidremove()Cleanup method.ActionremoveAction(String actionId)
-
-
-
Method Detail
-
isEnabled
boolean isEnabled(String actionId, ActionContext context)
-
isRegistered
boolean isRegistered(String actionId)
-
getActions
List<Action> getActions(String category, ActionContext context)
Gets actions for a category (filters are evaluated).Only actions available in the given context are returned
-
getActions
List<Action> getActions(String category, ActionContext context, boolean hideUnavailableActions)
Gets actions for a category (filters are evaluated).If hideUnavailableActions, all actions of the category are returned but actions are flagged with an available flag depending on filters evaluation.
-
getAction
Action getAction(String actionId, ActionContext context, boolean hideUnavailableActions)
Returns action with given id, evaluating its filters in given context, and returning null if filters evaluation denies access or if action is not found.If hideUnavailableActions is false, the action is always returned but it is flagged with an available flag depending on filters evaluation.
- Since:
- 5.6
-
getFilters
ActionFilter[] getFilters(String actionId)
-
getFilter
ActionFilter getFilter(String filterId)
- Since:
- 9.1
- See Also:
ActionFilterRegistry.getFilter(String)
-
checkFilter
boolean checkFilter(String filterId, ActionContext context)
Returns false if given filter evaluation is supposed to deny access when checking for this filter.- Since:
- 5.6
-
checkFilters
boolean checkFilters(List<String> filterIds, ActionContext context)
Returns false if given filters evaluation is supposed to deny access when checking for this filter.- Since:
- 7.1
-
checkFilters
boolean checkFilters(Action action, ActionContext context)
- Since:
- 8.2
-
getAllActions
List<Action> getAllActions(String category)
Gets all actions in a category (filters are NOT evaluated).
-
addAction
void addAction(Action action)
- Since:
- 9.1
- See Also:
ActionRegistry.addAction(Action)
-
removeAction
Action removeAction(String actionId)
- Since:
- 9.1
- See Also:
ActionRegistry.removeAction(String)
-
remove
void remove()
Cleanup method.
-
-