oracle.security.jps.service.policystore.search.ras

Class RASAttributeCollectionSearchQuery

java.lang.Object

oracle.security.jps.search.SearchQuery

oracle.security.jps.service.policystore.search.BaseSearchQuery

oracle.security.jps.service.policystore.search.ras.RASAttributeCollectionSearchQuery

public class RASAttributeCollectionSearchQuery
extends BaseSearchQuery

A Class to build search criteria to query RAS AttributeCollections.

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

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

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

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

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

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RASAttributeCollectionSearchQuery.SEARCH_PROPERTY Properties to search a attribute collection by.

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

SearchQuery.MATCHER

Constructor Summary

Constructors

Constructor and Description
RASAttributeCollectionSearchQuery(java.util.List<RASAttributeCollectionSearchQuery> childQueries, boolean negation, boolean isORMatch) Constructor for a complex RAS Attribute Collection Search Query
RASAttributeCollectionSearchQuery(RASAttributeCollectionSearchQuery.SEARCH_PROPERTY property, boolean negation, ComparatorType operator, java.lang.Object objectValue, SearchQuery.MATCHER matcher) Constructor for a simple RAS Attribute Collection Search Query.
RASAttributeCollectionSearchQuery(RASAttributeCollectionSearchQuery.SEARCH_PROPERTY property, boolean negation, ComparatorType operator, java.lang.String value, SearchQuery.MATCHER matcher) Constructor for a simple RAS Attribute Collection Search Query.

Method Summary

Methods

Modifier and Type	Method and Description
RASAttributeCollectionSearchQuery.SEARCH_PROPERTY	getSearchByProperty() Get the search property to use in the search.
RASAttributeCollectionSearchQuery[]	getSearchQueryInOrder() Get all added queries in the order they were added.

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

getBaseSearchQueryInOrder, getComparator, getEntityType, getQueries, toString

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

addBaseQuery, getPageInfo, getPreparedQueryId, getSearchByPropertyString, getSearchByValue, getSearchByValueObject, getSearchComparator, getSearchQueries, getSearchValueMatch, hasPageInfo, isANDMatch, isComplexQuery, isNegativeMatch, isORMatch, setPageInfo, setPreparedQueryId, unsetPageInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

RASAttributeCollectionSearchQuery

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

Constructor for a simple RAS Attribute Collection Search Query.

Parameters:

property - search property, See RASAttributeCollectionSearchQuery.SEARCH_PROPERTY for list of valid values

negation - whether the query result must be negated.

operator - comparison operator, See ComparatorType for list of valid values.

value - value to be compared.

matcher - type of matcher, See MATCHER for list of valid values.

RASAttributeCollectionSearchQuery

public RASAttributeCollectionSearchQuery(RASAttributeCollectionSearchQuery.SEARCH_PROPERTY property,
                                 boolean negation,
                                 ComparatorType operator,
                                 java.lang.Object objectValue,
                                 SearchQuery.MATCHER matcher)

Constructor for a simple RAS Attribute Collection Search Query.

Parameters:

property - search property, See RASAttributeCollectionSearchQuery.SEARCH_PROPERTY for list of valid values

negation - whether the query result must be negated.

operator - comparison operator, See ComparatorType for list of valid values.

objectValue - value to be compared.

matcher - type of matcher, See MATCHER for list of valid values.

RASAttributeCollectionSearchQuery

public RASAttributeCollectionSearchQuery(java.util.List<RASAttributeCollectionSearchQuery> childQueries,
                                 boolean negation,
                                 boolean isORMatch)

Constructor for a complex RAS Attribute Collection Search Query

Parameters:

childQueries - child queries for the complex query.

negation - whether the query result must be negated.

isORMatch - whether the child queries are an OR match.

Method Detail

getSearchByProperty

public RASAttributeCollectionSearchQuery.SEARCH_PROPERTY getSearchByProperty()

Get the search property to use in the search.

Returns:

SEARCH_PROPERTY object if this query does not have any other queries added otherwise null.

getSearchQueryInOrder

public RASAttributeCollectionSearchQuery[] getSearchQueryInOrder()

Get all added queries in the order they were added.

Returns:

Array of RASAttributeCollectionSearchQuery objects