Package dev.array21.espocrm.types

Class Params

  • public class Params
extends java.lang.Object
    Query parameters for a GET request to EspoCRM
    Refer to the EspoCRM documentation for more information
    Since:
    1.0.0

    • Constructor Detail

      • Params

        public Params()

    • Method Detail

      • setOffset

        public Params setOffset​(long offset)
        An offset for pagination.
        Parameters:
        offset - The offset
        Returns:
        Returns an instance of Params for easy chaining

      • getOffset

        public java.lang.Long getOffset()
        An offset for pagination.
        Returns:
        Returns the offset

      • setMaxSize

        public Params setMaxSize​(long maxSize)
        How much records to return.
        Parameters:
        maxSize - The maxSize
        Returns:
        Returns an instance of Params for easy chaining

      • getMaxSize

        public java.lang.Long getMaxSize()
        How much records to return.
        Returns:
        The maxSize

      • setSelect

        public Params setSelect​(java.lang.String select)
        What record attributes to return. Separated by comma. Whitespaces are not allowed. Specify only attributes that you need, it can improve performance.

        Example: 
        id,name,status,assignedUserId
        Parameters:
        select - The select parameters
        Returns:
        Returns an instance of Params for easy chaining

      • getSelect

        public java.lang.String getSelect()
        What record attributes to return. Separated by comma. Whitespaces are not allowed. Specify only attributes that you need, it can improve performance.

        Example: 
        id,name,status,assignedUserId
        Returns:
        Returns the select String

      • setPrimaryFilter

        public Params setPrimaryFilter​(java.lang.String primaryFilter)
        A primary filter. Primary filters are usualy defined in Select Manager class.
        Parameters:
        primaryFilter - The primaryFilter
        Returns:
        Returns an instance of Params for easy chaining

      • getPrimaryFilter

        public java.lang.String getPrimaryFilter()
        A primary filter. Primary filters are usualy defined in Select Manager class.
        Returns:
        Returns the primaryFilter

      • setOrderBy

        public Params setOrderBy​(java.lang.String orderBy)
        An attribute to order by.
        Parameters:
        orderBy - The orderBy
        Returns:
        Returns an instance of Params for easy chaining

      • getOrderBy

        public java.lang.String getOrderBy()
        An attribute to order by.
        Returns:
        Returns the orderBy

      • setBoolFilterList

        public Params setBoolFilterList​(java.lang.String[] boolFilterList)
        Bool filters. E.g. onlyMy, followed.
        Parameters:
        boolFilterList - The boolFilterList
        Returns:
        Returns an instance of Params for easy chaining

      • setBoolFilterList

        public Params setBoolFilterList​(java.util.List<java.lang.String> boolFilterList)
        Bool filters. E.g. onlyMy, followed.
        Parameters:
        boolFilterList - The boolFilterList
        Returns:
        Returns an instance of Params for easy chaining

      • getBoolFilterList

        public java.lang.String[] getBoolFilterList()
        Bool filters. E.g. onlyMy, followed.
        Returns:
        Returns the boolFilterList

      • setWhere

        public Params setWhere​(Where[] where)
        Search criteria. Can contain nested arrays and objects.
        Parameters:
        where - The where
        Returns:
        Returns an instance of Params for easy chaining
        See Also:
        Where

      • setWhere

        public Params setWhere​(java.util.List<Where> where)
        Search criteria. Can contain nested arrays and objects.
        Parameters:
        where - The where
        Returns:
        Returns an instance of Params for easy chaining
        See Also:
        Where

      • getWhere

        public Where[] getWhere()
        Search criteria. Can contain nested arrays and objects
        Returns:
        Returns the where

      • setOrder

        public Params setOrder​(Order order)
        A direction of order: 'desc' or 'asc'.
        Parameters:
        order - The order
        Returns:
        Returns an instance of Params for easy chaining

      • getOrder

        public Order getOrder()
        A direction of order: 'desc' or 'asc'.
        Returns:
        Returns the order