Class DataRequestParams

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

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

    • DataRequestParams

      public DataRequestParams()
  • Method Details

    • getText

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

      @QueryParam("mode") public String getMode()
    • getCatName

      @QueryParam("catName") public Boolean getCatName()
    • getExactCat

      @QueryParam("exactCat") public Boolean getExactCat()
    • getSearchInPub

      @QueryParam("searchInPub") public Boolean getSearchInPub()
    • getSearchInFiles

      @QueryParam("searchInFiles") public Boolean getSearchInFiles()
    • getSearchInDB

      @QueryParam("searchInDB") public Boolean getSearchInDB()
    • getSearchInMembers

      @QueryParam("searchInMembers") public Boolean getSearchInMembers()
    • getSearchInSubWorkspaces

      @QueryParam("searchInSubWorkspaces") public Boolean getSearchInSubWorkspaces()
    • getSearchInTrash

      @QueryParam("searchInTrash") public Boolean getSearchInTrash()
    • getCatMode

      @QueryParam("catMode") public String getCatMode()
    • getCids

      @QueryParam("cids") public String[] getCids()
    • getCidsOff

      @QueryParam("cidsOff") public String[] getCidsOff()
    • getMids

      @QueryParam("mids") public String[] getMids()
    • getMidsOpAuthor

      @QueryParam("midsOpAuthor") public String[] getMidsOpAuthor()
    • getMidsOff

      @QueryParam("midsOff") public String[] getMidsOff()
    • getGids

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

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

      @QueryParam("portalIds") public String[] getPortalIds()
    • getDateType

      @QueryParam("dateType") public String getDateType()
    • getDateSince

      @QueryParam("dateSince") public Integer getDateSince()
    • getBeginDay

      @QueryParam("beginDay") public Integer getBeginDay()
    • getBeginMonth

      @QueryParam("beginMonth") public Integer getBeginMonth()
    • getBeginYear

      @QueryParam("beginYear") public Integer getBeginYear()
    • getBeginDateW3c

      @QueryParam("beginDateW3c") public String getBeginDateW3c()
    • getBeginDateStr

      @QueryParam("beginDateStr") public String getBeginDateStr()
    • getEndDay

      @QueryParam("endDay") public Integer getEndDay()
    • getEndMonth

      @QueryParam("endMonth") public Integer getEndMonth()
    • getEndYear

      @QueryParam("endYear") public Integer getEndYear()
    • getEndDateW3c

      @QueryParam("endDateW3c") public String getEndDateW3c()
    • getEndDateStr

      @QueryParam("endDateStr") public String getEndDateStr()
    • getHist

      @QueryParam("hist") public String getHist()
    • getTypes

      @QueryParam("types") public String[] getTypes()
    • getTypesOff

      @QueryParam("typesOff") public String[] getTypesOff()
    • getExactType

      @QueryParam("exactType") public Boolean getExactType()
    • getPstatus

      @QueryParam("pstatus") public String[] getPstatus()
    • getWfId

      @QueryParam("wfId") public String getWfId()
    • getLangs

      @QueryParam("langs") public String[] getLangs()
    • getContentLangs

      @QueryParam("contentLangs") public String[] getContentLangs()
    • getWsId

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

      @QueryParam("searchedFields") public String[] getSearchedFields()
    • getAbility

      @QueryParam("ability") public String getAbility()
    • getDocumentKinds

      @QueryParam("documentKinds") public String[] getDocumentKinds()