Interface RolesResource


  • public interface RolesResource
    Author:
    rodrigo.sasaki@icarros.com.br
    • Method Detail

      • list

        @GET
        @Produces("application/json")
        List<RoleRepresentation> list​(@QueryParam("briefRepresentation") @DefaultValue("true")
                                      boolean briefRepresentation)
        Parameters:
        briefRepresentation - if false, return roles with their attributes
        Returns:
        A list containing all roles.
      • list

        @GET
        @Produces("application/json")
        List<RoleRepresentation> list​(@QueryParam("first")
                                      Integer firstResult,
                                      @QueryParam("max")
                                      Integer maxResults)
        Get roles by pagination params.
        Parameters:
        search - max number of occurrences
        first - index of the first element
        max - max number of occurrences
        Returns:
        A list containing the slice of all roles.
      • list

        @GET
        @Produces("application/json")
        List<RoleRepresentation> list​(@QueryParam("first")
                                      Integer firstResult,
                                      @QueryParam("max")
                                      Integer maxResults,
                                      @QueryParam("briefRepresentation") @DefaultValue("true")
                                      boolean briefRepresentation)
        Get roles by pagination params.
        Parameters:
        first - index of the first element
        max - max number of occurrences
        briefRepresentation - if false, return roles with their attributes
        Returns:
        A list containing the slice of all roles.
      • list

        @GET
        @Produces("application/json")
        List<RoleRepresentation> list​(@QueryParam("search") @DefaultValue("")
                                      String search,
                                      @QueryParam("briefRepresentation") @DefaultValue("true")
                                      boolean briefRepresentation)
        Get roles by pagination params.
        Parameters:
        search - max number of occurrences
        briefRepresentation - if false, return roles with their attributes
        Returns:
        A list containing the slice of all roles.
      • list

        @GET
        @Produces("application/json")
        List<RoleRepresentation> list​(@QueryParam("search") @DefaultValue("")
                                      String search,
                                      @QueryParam("first")
                                      Integer firstResult,
                                      @QueryParam("max")
                                      Integer maxResults)
        Get roles by pagination params.
        Parameters:
        search - max number of occurrences
        first - index of the first element
        max - max number of occurrences
        Returns:
        A list containing the slice of all roles.
      • list

        @GET
        @Produces("application/json")
        List<RoleRepresentation> list​(@QueryParam("search") @DefaultValue("")
                                      String search,
                                      @QueryParam("first")
                                      Integer firstResult,
                                      @QueryParam("max")
                                      Integer maxResults,
                                      @QueryParam("briefRepresentation") @DefaultValue("true")
                                      boolean briefRepresentation)
        Get roles by pagination params.
        Parameters:
        search - max number of occurrences
        first - index of the first element
        max - max number of occurrences
        briefRepresentation - if false, return roles with their attributes
        Returns:
        A list containing the slice of all roles.
      • create

        @POST
        @Consumes("application/json")
        void create​(RoleRepresentation roleRepresentation)
      • deleteRole

        @Path("{role-name}")
        @DELETE
        void deleteRole​(@PathParam("role-name")
                        String roleName)