Package io.jans.scim.model.scim2

Class SearchRequest

  • public class SearchRequest
extends Object
    This class represents the components of a search request that is employed when doing searches via POST. See section 3.4.3 RFC 7644.
    Author:
    Val Pecaoco

    • Constructor Detail

      • SearchRequest

        public SearchRequest()
        Default no args constructor. It creates an instance of SearchRequest initializing schemas properly.

    • Method Detail

      • setSchemas

        public void setSchemas​(List<String> schemas)

      • getAttributes

        public List<String> getAttributes()

      • setAttributes

        public void setAttributes​(List<String> attributes)
        Specifies a list of strings indicating the names of the resource attributes to return in response to a search, overriding the set of attributes that would be returned by default.
        Parameters:
        attributes - A List of Strings

      • setAttributes

        public void setAttributes​(String commaSeparatedString)
        Specifies the names of the resource attributes to return in the response to a search, overriding the set of attributes that would be returned by default.
        Parameters:
        commaSeparatedString - The attribute names in a comma-separated String

      • getExcludedAttributes

        public List<String> getExcludedAttributes()

      • setExcludedAttributes

        public void setExcludedAttributes​(List<String> excludedAttributes)
        Specifies a list of strings indicating the names of the resource attributes to be removed from the default set of attributes to return.
        Parameters:
        excludedAttributes - A List of Strings

      • setExcludedAttributes

        public void setExcludedAttributes​(String commaSeparatedString)
        Specifies the names of the resource attributes to be removed from the default set of attributes to return.
        Parameters:
        commaSeparatedString - The attribute names in a comma-separated String

      • getFilter

        public String getFilter()

      • setFilter

        public void setFilter​(String filter)
        A filter expression so that the search will return only those resources matching the expression. To learn more about SCIM filter expressions and operators, see section 3.4.2.2 of RFC 7644.
        Parameters:
        filter - A valid filter

      • getSortBy

        public String getSortBy()

      • setSortBy

        public void setSortBy​(String sortBy)
        Specifies the attribute whose value will be used to order the returned responses.
        Parameters:
        sortBy - Attribute name path. Examples are: userName, name.givenName, emails.value.

      • getSortOrder

        public String getSortOrder()

      • setSortOrder

        public void setSortOrder​(String sortOrder)
        The order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending", being "ascending" the default if unspecified.
        Parameters:
        sortOrder - A string value

      • getStartIndex

        public Integer getStartIndex()

      • setStartIndex

        public void setStartIndex​(Integer startIndex)
        Sets the 1-based index of the first query result.
        Parameters:
        startIndex - Specifies "where" the result set will start when the search is performed

      • getCount

        public Integer getCount()

      • setCount

        public void setCount​(Integer count)
        Specifies the desired maximum number of query results per page the response must include.
        Parameters:
        count - An Integer object

      • getAttributesStr

        public String getAttributesStr()

      • getExcludedAttributesStr

        public String getExcludedAttributesStr()