org.gluu.oxtrust.model.scim2.SearchRequest クラス

org.gluu.oxtrust.model.scim2.SearchRequest 連携図

公開メンバ関数
	SearchRequest ()
List< String >	getSchemas ()
void	setSchemas (List< String > schemas)
List< String >	getAttributes ()
void	setAttributes (List< String > attributes)
void	setAttributes (String commaSeparatedString)
List< String >	getExcludedAttributes ()
void	setExcludedAttributes (List< String > excludedAttributes)
void	setExcludedAttributes (String commaSeparatedString)
String	getFilter ()
void	setFilter (String filter)
String	getSortBy ()
void	setSortBy (String sortBy)
String	getSortOrder ()
void	setSortOrder (String sortOrder)
Integer	getStartIndex ()
void	setStartIndex (Integer startIndex)
Integer	getCount ()
void	setCount (Integer count)
String	getAttributesStr ()
String	getExcludedAttributesStr ()

非公開変数類
List< String >	schemas
List< String >	attributes
List< String >	excludedAttributes
String	filter
String	sortBy
String	sortOrder
Integer	startIndex
Integer	count
String	attributesStr
String	excludedAttributesStr

詳解

This class represents the components of a search request that is employed when doing searches via POST. See section 3.4.3 RFC 7644.

著者

Val Pecaoco

構築子と解体子

SearchRequest()

org.gluu.oxtrust.model.scim2.SearchRequest.SearchRequest ( )

inline

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

                          {
        schemas=Collections.singletonList(SEARCH_REQUEST_SCHEMA_ID);
    }

関数詳解

getAttributes()

List<String> org.gluu.oxtrust.model.scim2.SearchRequest.getAttributes ( )

inline

                                        {
        return attributes;
    }

getAttributesStr()

String org.gluu.oxtrust.model.scim2.SearchRequest.getAttributesStr ( )

inline

                                     {
        return attributes==null ? null : Joiner.on(",").join(attributes.toArray());
    }

getCount()

Integer org.gluu.oxtrust.model.scim2.SearchRequest.getCount ( )

inline

                              {
        return count;
    }

getExcludedAttributes()

List<String> org.gluu.oxtrust.model.scim2.SearchRequest.getExcludedAttributes ( )

inline

                                                {
        return excludedAttributes;
    }

getExcludedAttributesStr()

String org.gluu.oxtrust.model.scim2.SearchRequest.getExcludedAttributesStr ( )

inline

                                             {
        return excludedAttributes==null ? null : Joiner.on(",").join(excludedAttributes.toArray());
    }

getFilter()

String org.gluu.oxtrust.model.scim2.SearchRequest.getFilter ( )

inline

                              {
        return filter;
    }

getSchemas()

List<String> org.gluu.oxtrust.model.scim2.SearchRequest.getSchemas ( )

inline

                                     {
        return schemas;
    }

getSortBy()

String org.gluu.oxtrust.model.scim2.SearchRequest.getSortBy ( )

inline

                              {
        return sortBy;
    }

getSortOrder()

String org.gluu.oxtrust.model.scim2.SearchRequest.getSortOrder ( )

inline

                                 {
        return sortOrder;
    }

getStartIndex()

Integer org.gluu.oxtrust.model.scim2.SearchRequest.getStartIndex ( )

inline

                                   {
        return startIndex;
    }

setAttributes() [1/2]

void org.gluu.oxtrust.model.scim2.SearchRequest.setAttributes ( List< String >  attributes )

inline

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.

引数

attributes

A List of Strings

                                                       {
        this.attributes = attributes;
    }

setAttributes() [2/2]

void org.gluu.oxtrust.model.scim2.SearchRequest.setAttributes ( String  commaSeparatedString )

inline

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.

引数

commaSeparatedString

The attribute names in a comma-separated String

                                                          {
        setAttributes(commaSeparatedString==null ? null : Arrays.asList(commaSeparatedString.split(",")));
    }

setCount()

void org.gluu.oxtrust.model.scim2.SearchRequest.setCount ( Integer  count )

inline

Specifies the desired maximum number of query results per page the response must include.

引数

count

An Integer object

                                        {
        this.count = count;
    }

setExcludedAttributes() [1/2]

void org.gluu.oxtrust.model.scim2.SearchRequest.setExcludedAttributes ( List< String >  excludedAttributes )

inline

Specifies a list of strings indicating the names of the resource attributes to be removed from the default set of attributes to return.

引数

excludedAttributes

A List of Strings

                                                                       {
        this.excludedAttributes = excludedAttributes;
    }

setExcludedAttributes() [2/2]

void org.gluu.oxtrust.model.scim2.SearchRequest.setExcludedAttributes ( String  commaSeparatedString )

inline

Specifies the names of the resource attributes to be removed from the default set of attributes to return.

引数

commaSeparatedString

The attribute names in a comma-separated String

                                                                  {
        setExcludedAttributes(commaSeparatedString==null ? null : Arrays.asList(commaSeparatedString.split(",")));
    }

setFilter()

void org.gluu.oxtrust.model.scim2.SearchRequest.setFilter ( String  filter )

inline

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.

引数

filter

A valid filter

                                         {
        this.filter = filter;
    }

setSchemas()

void org.gluu.oxtrust.model.scim2.SearchRequest.setSchemas ( List< String >  schemas )

inline

                                                 {
        //TODO: Delete this IF lines in the future - added for backwards compatibility with SCIM-Client <= 3.1.2.
        if (schemas.remove("urn:ietf:params:scim:schemas:core:2.0:SearchRequest"))
            schemas.add(SEARCH_REQUEST_SCHEMA_ID);

        this.schemas = schemas;
    }

setSortBy()

void org.gluu.oxtrust.model.scim2.SearchRequest.setSortBy ( String  sortBy )

inline

Specifies the attribute whose value will be used to order the returned responses.

引数

sortBy

Attribute name path. Examples are: userName, name.givenName, emails.value.

                                         {
        this.sortBy = sortBy;
    }

setSortOrder()

void org.gluu.oxtrust.model.scim2.SearchRequest.setSortOrder ( String  sortOrder )

inline

The order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending", being "ascending" the default if unspecified.

引数

sortOrder

A string value

                                               {
        this.sortOrder = sortOrder;
    }

setStartIndex()

void org.gluu.oxtrust.model.scim2.SearchRequest.setStartIndex ( Integer  startIndex )

inline

Sets the 1-based index of the first query result.

引数

startIndex

Specifies "where" the result set will start when the search is performed

                                                  {
        this.startIndex = startIndex;
    }

メンバ詳解

attributes

List<String> org.gluu.oxtrust.model.scim2.SearchRequest.attributes

private

attributesStr

String org.gluu.oxtrust.model.scim2.SearchRequest.attributesStr

private

count

Integer org.gluu.oxtrust.model.scim2.SearchRequest.count

private

excludedAttributes

List<String> org.gluu.oxtrust.model.scim2.SearchRequest.excludedAttributes

private

excludedAttributesStr

String org.gluu.oxtrust.model.scim2.SearchRequest.excludedAttributesStr

private

filter

String org.gluu.oxtrust.model.scim2.SearchRequest.filter

private

schemas

List<String> org.gluu.oxtrust.model.scim2.SearchRequest.schemas

private

sortBy

String org.gluu.oxtrust.model.scim2.SearchRequest.sortBy

private

sortOrder

String org.gluu.oxtrust.model.scim2.SearchRequest.sortOrder

private

startIndex

Integer org.gluu.oxtrust.model.scim2.SearchRequest.startIndex

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/oxTrust/scim/src/main/java/org/gluu/oxtrust/model/scim2/SearchRequest.java