Interface IMacroExtension
- All Known Implementing Classes:
BuildableJobMacro
,ContainedInViewMacro
,FolderMacro
,RoleMacroExtension
,StubMacro
public interface IMacroExtension
Interface for Role-based plug-in Macro extensions.
- Since:
- 2.1.0
- Author:
- Oleg Nenashev
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionReturns description of the macro (including parameters).getName()
Get name of the appropriate macro.boolean
hasPermission
(PermissionEntry sid, Permission p, RoleType type, AccessControlled item, Macro macro) Check if user belongs to specified Macro.default boolean
hasPermission
(String sid, Permission p, RoleType type, AccessControlled item, Macro macro) boolean
IsApplicable
(RoleType roleType) Check if the macro extension is applicable to specified role type.
-
Method Details
-
getName
String getName()Get name of the appropriate macro.- Returns:
- Name of the macro
-
IsApplicable
Check if the macro extension is applicable to specified role type.- Parameters:
roleType
- Type to be checked- Returns:
true
if the macro is applicable to the specified role type
-
getDescription
String getDescription()Returns description of the macro (including parameters).- Returns:
- Description of the macro
-
hasPermission
boolean hasPermission(PermissionEntry sid, Permission p, RoleType type, AccessControlled item, Macro macro) Check if user belongs to specified Macro.- Parameters:
sid
- SID to be checkedp
- Permissiontype
- Type of the role to be checkeditem
- Itemmacro
- Macro with parameters- Returns:
- True if user satisfies macro's requirements
-
hasPermission
default boolean hasPermission(String sid, Permission p, RoleType type, AccessControlled item, Macro macro)
-