Skip navigation links

Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server
11g Release 1 (11.1.1)

E22649-02 ESAPI


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

java.lang.Object
  extended by oracle.security.jps.search.SearchQuery
      extended by oracle.security.jps.service.policystore.search.BaseSearchQuery
          extended by oracle.security.jps.service.policystore.search.ResourceSearchQuery


public class ResourceSearchQuery
extends BaseSearchQuery

A Class to build search criterias to query Resources.

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

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

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

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

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

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

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


Please note that you must specify a resource type query if you want to use oracle.security.jps.service.policystore.entitymanager.ResourceManager.getResources(oracle.security.jps.service.policystore.search.ResourceSearchQuery)


Nested Class Summary
static class ResourceSearchQuery.SEARCH_PROPERTY
          Criterias to search a Resource By

 

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

 

Constructor Summary
ResourceSearchQuery(java.util.List<ResourceSearchQuery> childQueries, boolean negation, boolean isORMatch)
          Constructor for a complex Resource Search Query
ResourceSearchQuery(ResourceSearchQuery.SEARCH_PROPERTY property, boolean negation, ComparatorType operator, java.lang.String value, SearchQuery.MATCHER m)
          Protected constructor (off limits to clients).

 

Method Summary
 ResourceSearchQuery.SEARCH_PROPERTY getSearchByProperty()
          Get the search property to use in the search.
 ResourceSearchQuery[] getSearchQueryInOrder()
          Get all added queries in the order they were added.

 

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

ResourceSearchQuery

public ResourceSearchQuery(java.util.List<ResourceSearchQuery> childQueries,
                           boolean negation,
                           boolean isORMatch)
Constructor for a complex Resource Search Query
Parameters:
childQueries -
negation -
isORMatch -

ResourceSearchQuery

public ResourceSearchQuery(ResourceSearchQuery.SEARCH_PROPERTY property,
                           boolean negation,
                           ComparatorType operator,
                           java.lang.String value,
                           SearchQuery.MATCHER m)
Protected constructor (off limits to clients).
Parameters:
property - -- search property, See ResourceSearchQuery.SEARCH_PROPERTY for list of valid values
negation - -- negate the search?
operator - -- Type of comparison
value - -- value to search for
m - -- matching to be performed.

Method Detail

getSearchByProperty

public ResourceSearchQuery.SEARCH_PROPERTY getSearchByProperty()
Get the search property to use in the search.
Returns:
SEARCH_PROPERTY ojbect if this query does not have any other queries added otherwise null.

getSearchQueryInOrder

public ResourceSearchQuery[] getSearchQueryInOrder()
Get all added queries in the order they were added.
Returns:
Array of ResourceSearchQuery objects

Skip navigation links

Oracle Fusion Middleware Management Java API Reference for Oracle Entitlements Server
11g Release 1 (11.1.1)

E22649-02 ESAPI


Copyright © 2011, Oracle. All rights reserved.