Class MemberRequestParams

java.lang.Object
com.jalios.jcms.restv2.requestparams.PagingRequestParams
com.jalios.jcms.restv2.requestparams.MemberRequestParams

public class MemberRequestParams extends PagingRequestParams
Defines the member query parameters exposed in the REST API documentation. The values are not read from this object at runtime. AllMemberQueryHandler retrieves the query parameters from the UriInfo context through uriInfo.getQueryParameters(), which provides a MultivaluedMap<String, String>. This map is converted into a query string by AbstractQueryResource.constructQueryString(MultivaluedMap) and the resulting query string is provided to the AllMemberQueryHandler constructor. This representation makes it easier for the handler to process the query parameters than using a MemberRequestParams object. Consequently, instances of this class are expected to contain only their default values. The QueryParam annotations are used here so that these query parameters are exposed in the Swagger documentation.
  • Constructor Details

    • MemberRequestParams

      public MemberRequestParams()
  • Method Details

    • isAdmin

      @QueryParam("admin") public boolean isAdmin()
    • isWorker

      @QueryParam("worker") public boolean isWorker()
    • getText

      @QueryParam("text") public String getText()
    • getEmail

      @QueryParam("email") public String getEmail()
    • getGids

      @QueryParam("gids") public String[] getGids()
    • getGidsOff

      @QueryParam("gidsOff") public String[] getGidsOff()
    • getUsage

      @QueryParam("usage") public int getUsage()
    • getEnabled

      @QueryParam("enabled") public boolean getEnabled()
    • getWsId

      @QueryParam("wsId") public String getWsId()
    • getMember

      @QueryParam("member") public String getMember()
    • getSearchedFields

      @QueryParam("searchedFields") public String getSearchedFields()