Class WorkspaceRequestParams

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

public class WorkspaceRequestParams extends PagingRequestParams
Defines the workspace query parameters exposed in the REST API documentation. The values are not read from this object at runtime. WorkspaceQueryHandler 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 WorkspaceQueryHandler constructor. This representation makes it easier for the handler to process the query parameters than using a WorkspaceRequestParams 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

    • WorkspaceRequestParams

      public WorkspaceRequestParams()
  • Method Details

    • getText

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

      @QueryParam("belongsToWorkspace") public Boolean getBelongsToWorkspace()
    • getWorker

      @QueryParam("worker") public Boolean getWorker()
    • getWithPortal

      @QueryParam("withPortal") public Boolean getWithPortal()
    • getWsType

      @QueryParam("wsType") public String getWsType()
    • getWsModel

      @QueryParam("wsModel") public String getWsModel()
    • getWsState

      @QueryParam("wsState") public String getWsState()
    • getMember

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

      @QueryParam("lang") public String getLang()