Interface Parameters

All Known Implementing Classes:
Params

public interface Parameters
Parameters passed into a request.
Author:
Gethin James
  • Method Details

    • getEntityId

      String getEntityId()
    • getRelationshipId

      String getRelationshipId()
    • getRelationship2Id

      String getRelationship2Id()
    • isCollectionResource

      boolean isCollectionResource()
    • getParameter

      String getParameter(String parameterName)
      Gets a single request query parameter passed in by the user. Currently doesn't support multiple values.
      Parameters:
      parameterName - String
      Returns:
      String The Parameter value
    • getParameter

      org.apache.poi.ss.formula.functions.T getParameter(String parameterName, Class<org.apache.poi.ss.formula.functions.T> clazz) throws InvalidArgumentException
      Gets a single request parameter passed in by the user. Attempts to convert the parameter to the specified type. If unable to convert the parameter to the specified type then throws an InvalidArgumentException. Currently doesn't support multiple values.
      Parameters:
      parameterName - String
      clazz - - type to use for conversion.
      Returns:
      The Parameter value
      Throws:
      InvalidArgumentException
    • getPaging

      Paging getPaging()
      Returns a representation of the Paging of collections of resources, with skip count and max items. See Paging Specified by the "skipCount" and "maxItems" request parameters.
      Returns:
      Paging Paging information
    • getSorting

      List<SortColumn> getSorting()
      Returns a List of SortColumn for sorting properties. Specified by the "orderBy" request parameter.
      Returns:
      List of SortColumn
    • getFilter

      Returns a BeanPropertiesFilter for filtering out properties. Specified by the "properties" request parameter.
      Returns:
      BeanPropertiesFilter BeanPropertiesFilter
    • hasBinaryProperty

      boolean hasBinaryProperty(String propertyName)
      Indicates if the specified property was requested.
      Parameters:
      propertyName - the property Specified as part of the url request.
      Returns:
      true if the propertyName was specified as part of the url request
    • getBinaryProperty

      String getBinaryProperty()
      Gets the name of the property that was requested.
      Returns:
      String the propertyName
    • includeSource

      boolean includeSource()
      Indicates if the source entity should be includes in the request. This will normally be done by the framework but implentations may prefer to do it themselves.
      Returns:
      true if the source should be included.
    • getQuery

      Query getQuery()
      Represents a Query specified by the client. Specified by the "WHERE" request parameter.
      Returns:
      Query Query
    • getSelectedProperties

      @Deprecated List<String> getSelectedProperties()
      Deprecated.
      A list of property names passed in the request using the json pointer syntax Specified by the "SELECT" request parameter.
    • getInclude

      List<String> getInclude()
      A list of property names passed in the request using the json pointer syntax Specified by the "INCLUDE" request parameter.
      Returns:
      the propertyNames
    • getContentInfo

      BasicContentInfo getContentInfo()
      Gets the basic information about content, typically taken from a HTTPServletRequest.
      Returns:
      BasicContentInfo the content info
    • getRequest

      org.springframework.extensions.webscripts.WebScriptRequest getRequest()
      Gets access to the entire webscript request.
      Returns:
      WebScriptRequest