Interface Parameters

  • All Known Implementing Classes:
    Params

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

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String getBinaryProperty()
      Gets the name of the property that was requested.
      BasicContentInfo getContentInfo()
      Gets the basic information about content, typically taken from a HTTPServletRequest.
      BeanPropertiesFilter getFilter()
      Returns a BeanPropertiesFilter for filtering out properties.
      java.util.List<java.lang.String> getInclude()
      A list of property names passed in the request using the json pointer syntax Specified by the "INCLUDE" request parameter.
      Paging getPaging()
      Returns a representation of the Paging of collections of resources, with skip count and max items.
      java.lang.String getParameter​(java.lang.String parameterName)
      Gets a single request query parameter passed in by the user.
      org.apache.poi.ss.formula.functions.T getParameter​(java.lang.String parameterName, java.lang.Class<org.apache.poi.ss.formula.functions.T> clazz)
      Gets a single request parameter passed in by the user.
      Query getQuery()
      Represents a Query specified by the client.
      org.springframework.extensions.webscripts.WebScriptRequest getRequest()
      Gets access to the entire webscript request.
      java.util.List<java.lang.String> getSelectedProperties()
      Deprecated.
      java.util.List<SortColumn> getSorting()
      Returns a List of SortColumn for sorting properties.
      boolean hasBinaryProperty​(java.lang.String propertyName)
      Indicates if the specified property was requested.
      boolean includeSource()
      Indicates if the source entity should be includes in the request.
    • Method Detail

      • getParameter

        java.lang.String getParameter​(java.lang.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​(java.lang.String parameterName,
                                                           java.lang.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

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

        boolean hasBinaryProperty​(java.lang.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

        java.lang.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
        java.util.List<java.lang.String> getSelectedProperties()
        Deprecated.
        A list of property names passed in the request using the json pointer syntax Specified by the "SELECT" request parameter.
      • getInclude

        java.util.List<java.lang.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