Package org.ametys.core.ui
Annotation Interface Callable
Mark the annotated method as callable by a client-side component.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumIndicate how to check multiple rights -
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionbooleanDetermines if the method can be accessed by a anonymous userThe context to check the right.intThe index of method's argument holding the context value to be converted byRightAssignmentContextThe id of a type of theRightAssignmentContextto use to convert JS object into into a Java objectThe mode to use to check multiple rights -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringConstant to use to ask explicitly the system to not check rights, as they will be checked by the method itselfstatic final StringConstant to use to explicitly indicate that this method could be called by anyone (anonymous users included or not depending onallowAnonymous())static final StringConstant to check read access
-
Field Details
-
CHECKED_BY_IMPLEMENTATION
Constant to use to ask explicitly the system to not check rights, as they will be checked by the method itself- See Also:
-
NO_CHECK_REQUIRED
Constant to use to explicitly indicate that this method could be called by anyone (anonymous users included or not depending onallowAnonymous())- See Also:
-
READ_ACCESS
Constant to check read access- See Also:
-
-
Element Details
-
rights
The ids of rights to be checked- Returns:
- The ids or empty if there is no right protection
-
rightMode
The mode to use to check multiple rights- Returns:
- The mode to use
- Default:
OR
-
allowAnonymous
boolean allowAnonymousDetermines if the method can be accessed by a anonymous user- Returns:
- true if anonymous user is allowed
- Default:
false
-
context
The context to check the right. Defaults to '/${WorkspaceName}'- Returns:
- The context
- Default:
"/${WorkspaceName}"
-
rightContext
The id of a type of theRightAssignmentContextto use to convert JS object into into a Java object- Returns:
- The id of the
RightAssignmentContext
- Default:
""
-
paramIndex
int paramIndexThe index of method's argument holding the context value to be converted byRightAssignmentContext- Returns:
- The parameter's index
- Default:
-1
-