Skip navigation links

oracle.security.jps.service.policystore.search
Class AdminRoleSearchQuery

java.lang.Object
oracle.security.jps.search.SearchQuery
oracle.security.jps.service.policystore.search.BaseSearchQuery
oracle.security.jps.service.policystore.search.AdminRoleSearchQuery

public class AdminRoleSearchQuery

extends BaseSearchQuery

A Class to build search criteria to query AdminRoles.

Following code snippet illustrates how to build a search criteria to search by the DisplayName

  AdminRoleSearchQuery query = new AdminRoleSearchQuery( AdminRoleSearchQuery.SEARCH_PROPERTY.DISPLAY_NAME,
    false, ComparatorType.EQUALITY, "DisplayName Value to searchBy", BaseSearchQuery.MATCHER.EXACT);
  getAdminRoles ( query );
 

To build more complex search criterias, use the Constructor for complex search query.

Consider the following example to search AdminRoles by a specific description and display name. Obviously, the two criteria (below) have to be AND-ed.

  List<AdminRoleSearchQuery> list = new ArrayList<AdminRoleSearchQuery>();
  list.add(new AdminRoleSearchQuery( AdminRoleSearchQuery.SEARCH_PROPERTY.DISPLAY_NAME,
    false, ComparatorType.EQUALITY, "The Display Name", BaseSearchQuery.MATCHER.EXACT));
  
  list.add(new AdminRoleSearchQuery( AdminRoleSearchQuery.SEARCH_PROPERTY.DESCRIPTION,
    false, ComparatorType.EQUALITY, "The Description", BaseSearchQuery.MATCHER.EXACT));
 
  AdminRoleSearchQuery query = new AdminRoleSearchQuery(list, false, false);
 

Similarly, we can have two criteria OR-ed as below.

  List<AdminRoleSearchQuery> list = new ArrayList<AdminRoleSearchQuery>();
  list.add(new AdminRoleSearchQuery( AdminRoleSearchQuery.SEARCH_PROPERTY.DISPLAY_NAME,
    false, ComparatorType.EQUALITY, "The Display Name", BaseSearchQuery.MATCHER.EXACT));
  
  list.add(new AdminRoleSearchQuery( AdminRoleSearchQuery.SEARCH_PROPERTY.DESCRIPTION,
    false, ComparatorType.EQUALITY, "The Description", BaseSearchQuery.MATCHER.EXACT));
 
  AdminRoleSearchQuery query = new AdminRoleSearchQuery(list, false, true);
 

Nested Class Summary

static class

AdminRoleSearchQuery.SEARCH_PROPERTY Criterias to search AdminRoles By

Nested classes/interfaces inherited from class oracle.security.jps.search.SearchQuery

SearchQuery.MATCHER

Constructor Summary

AdminRoleSearchQuery(AdminRoleSearchQuery.SEARCH_PROPERTY property, boolean negation, ComparatorType operator, java.lang.Object valueObject, SearchQuery.MATCHER match)
Constructor

AdminRoleSearchQuery(AdminRoleSearchQuery.SEARCH_PROPERTY property, boolean negation, ComparatorType operator, java.lang.String value, SearchQuery.MATCHER match)
Constructor

AdminRoleSearchQuery(java.util.List<AdminRoleSearchQuery> queries, boolean negation, boolean isORMatch)
Constructor

Method Summary

AdminRoleSearchQuery.SEARCH_PROPERTY	getSearchByProperty() Gets the search by property in this search query
AdminRoleSearchQuery[]	getSearchQueryInOrder() Gets the child search query in this search query.

Methods inherited from class oracle.security.jps.service.policystore.search.BaseSearchQuery

getComparator, getQueries, toString

Methods inherited from class oracle.security.jps.search.SearchQuery

addBaseQuery, getBaseSearchQueryInOrder, getSearchByPropertyString, getSearchByValue, getSearchByValueObject, getSearchComparator, getSearchQueries, getSearchValueMatch, isANDMatch, isComplexQuery, isNegativeMatch, isORMatch

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminRoleSearchQuery

public AdminRoleSearchQuery(AdminRoleSearchQuery.SEARCH_PROPERTY property,
                            boolean negation,
                            ComparatorType operator,
                            java.lang.String value,
                            SearchQuery.MATCHER match)

Constructor

Parameters:

property - the property to search by, See AdminRoleSearchQuery.SEARCH_PROPERTY for list of valid values

negation - if true, then the NOT operator is applied

operator - the operator to apply

value - the value to search for

If value is null, the match must be ANY

If value is non-null, this value is matched against the values to search for. The match algorithm is applied to values to sarch against.

match - how the value should match-ed with the values to search against. If match is null, an EXACT match is assumed. value should be non-null.

AdminRoleSearchQuery

public AdminRoleSearchQuery(AdminRoleSearchQuery.SEARCH_PROPERTY property,
                            boolean negation,
                            ComparatorType operator,
                            java.lang.Object valueObject,
                            SearchQuery.MATCHER match)

Constructor

Parameters:

property - the property to search by, See AdminRoleSearchQuery.SEARCH_PROPERTY for list of valid values

negation - if true, then the NOT operator is applied

operator - the operator to apply

valueObject - the value to search for

If value is null, the match must be ANY

If value is non-null, this value is matched against the values to search for. The match algorithm is applied to values to sarch against.

match - how the value should match-ed with the values to search against. If match is null, an EXACT match is assumed. value should be non-null.

AdminRoleSearchQuery

public AdminRoleSearchQuery(java.util.List<AdminRoleSearchQuery> queries,
                            boolean negation,
                            boolean isORMatch)

Constructor

Parameters:

queries - child queries of this query

negation - if true, then the NOT operator is applied.

isORMatch - if true the syntax among the child queries is 'OR', if false, the syntax among child queries is 'AND'

Method Detail

getSearchByProperty

public AdminRoleSearchQuery.SEARCH_PROPERTY getSearchByProperty()

Gets the search by property in this search query

Returns:

getSearchQueryInOrder

public AdminRoleSearchQuery[] getSearchQueryInOrder()

Gets the child search query in this search query. Return child queries for a complex query, return empty arry for a simple query

Returns:

Skip navigation links