Skip navigation links

oracle.idm.provisioning.approval
Class RequestSearchCriteria

java.lang.Object
oracle.idm.provisioning.approval.RequestSearchCriteria

public class RequestSearchCriteria

extends java.lang.Object

This class facilitates specification of complex search criteria for searching requests, so that callers don't have to build actual LDAP filters. This class currently supports request searches based on following fields: 1. Request ID 2. Target application. 3. Request creator. 4. Processing status. 5. Status. 6. Creation date. 7. Modification date. The class doesn't support arbitrary boolean logic, but does support "Match Any" or "Match All" functionality.

Field Summary

static java.lang.String	CRITERIA_AND
static java.lang.String	CRITERIA_EQUAL_TO
static java.lang.String	CRITERIA_GREATER_THAN
static java.lang.String	CRITERIA_LESS_THAN
static java.lang.String	CRITERIA_MATCH_ALL
static java.lang.String	CRITERIA_MATCH_ANY
static java.lang.String	CRITERIA_NOT_EQUAL_TO
static java.lang.String	CRITERIA_NOT_GREATER_THAN
static java.lang.String	CRITERIA_NOT_LESS_THAN
static java.lang.String	CRITERIA_OR

Constructor Summary

RequestSearchCriteria()

Method Summary

void	addApp(java.lang.String app, java.lang.String match) Adds a search criteria based on target app of the request.
void	addCreationDate(java.lang.String date, java.lang.String match) Adds a search criteria based on creation date of the request.
void	addCreator(java.lang.String creator, java.lang.String match) Adds a search criteria based on creator of the request.
void	addLastModDate(java.lang.String date, java.lang.String match) Adds a search criteria based on last modification date of the request.
void	addProcStatus(java.lang.String procstatus, java.lang.String match) Adds a search criteria based on processing status of the request.
void	addProvOp(java.lang.String provop, java.lang.String match) Adds a search criteria based on operation info of the request.
void	addRequestID(java.lang.String id, java.lang.String match) Adds a search criteria based on id of the request.
void	addStatus(java.lang.String status, java.lang.String match) Adds a search criteria based on status of the request.
java.util.Hashtable	getAppsMap() Returns search criteria for list of applications and type of match ("equal" or "not equal") in a hash table.
java.util.Hashtable	getCreationDateMap() Returns search criteria for list of creation date and type of match ("less than" or "greater than") in a hash table.
java.util.Hashtable	getCreatorsMap() Returns list of creators and type of match ("equal" or "not equal") in a hash table.
java.util.Hashtable	getIDsMap() Returns search criteria for list of request IDs and type of match ("equal" or "not equal") in a hash table.
java.util.Hashtable	getLastModDateMap() Returns search criteria for list of modification date and type of match ("less than" or "greater than") in a hash table.
java.lang.String	getMatch() Specifies whether the search criteria is "match all parameters" or "match any parameters".
java.util.Hashtable	getProcStatusMap() Returns search criteria for list of current procStatuses and type of match ("equal" or "not equal") in a hash table.
java.util.Hashtable	getProvOpsMap() Returns search criteria for list of applications and type of match ("equal" or "not equal") in a hash table.
java.util.Hashtable	getStatusesMap() Returns search criteria for list of statuses and type of match ("less than" or "greater than") in a hash table.
boolean	isEmpty() Checks if the object contains any search criteria.
void	setMatchAll() Sets the match type for this request search criteria as "match all parameters."
void	setMatchAny() Sets the match type for this request search criteria as "match any parameters."

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CRITERIA_MATCH_ALL

public static java.lang.String CRITERIA_MATCH_ALL

CRITERIA_MATCH_ANY

public static java.lang.String CRITERIA_MATCH_ANY

CRITERIA_AND

public static java.lang.String CRITERIA_AND

CRITERIA_OR

public static java.lang.String CRITERIA_OR

CRITERIA_EQUAL_TO

public static java.lang.String CRITERIA_EQUAL_TO

CRITERIA_NOT_EQUAL_TO

public static java.lang.String CRITERIA_NOT_EQUAL_TO

CRITERIA_LESS_THAN

public static java.lang.String CRITERIA_LESS_THAN

CRITERIA_GREATER_THAN

public static java.lang.String CRITERIA_GREATER_THAN

CRITERIA_NOT_GREATER_THAN

public static java.lang.String CRITERIA_NOT_GREATER_THAN

CRITERIA_NOT_LESS_THAN

public static java.lang.String CRITERIA_NOT_LESS_THAN

Constructor Detail

RequestSearchCriteria

public RequestSearchCriteria()

Method Detail

getMatch

public java.lang.String getMatch()

Specifies whether the search criteria is "match all parameters" or "match any parameters".

Returns:

Either CRITERIA_MATCH_ANY or CRITERIA_MATCH_ALL

isEmpty

public boolean isEmpty()

Checks if the object contains any search criteria.

Returns:

True if there is at least one search criteria, false otherwise.

getCreatorsMap

public java.util.Hashtable getCreatorsMap()

Returns list of creators and type of match ("equal" or "not equal") in a hash table. Note that the hash table is not an unmodifiable interface as the unmodifiable interface will not pass hashcode and equals operations.

getAppsMap

public java.util.Hashtable getAppsMap()

Returns search criteria for list of applications and type of match ("equal" or "not equal") in a hash table. Note that the hash table is not an unmodifiable interface as the unmodifiable interface will not pass hashcode and equals operations.

getProvOpsMap

public java.util.Hashtable getProvOpsMap()

Returns search criteria for list of applications and type of match ("equal" or "not equal") in a hash table. Note that the hash table is not an unmodifiable interface as the unmodifiable interface will not pass hashcode and equals operations.

getIDsMap

public java.util.Hashtable getIDsMap()

Returns search criteria for list of request IDs and type of match ("equal" or "not equal") in a hash table. Note that the hash table is not an unmodifiable interface as the unmodifiable interface will not pass hashcode and equals operations.

getProcStatusMap

public java.util.Hashtable getProcStatusMap()

Returns search criteria for list of current procStatuses and type of match ("equal" or "not equal") in a hash table. Note that the hash table is not an unmodifiable interface as the unmodifiable interface will not pass hashcode and equals operations.

getCreationDateMap

public java.util.Hashtable getCreationDateMap()

Returns search criteria for list of creation date and type of match ("less than" or "greater than") in a hash table. Note that the hash table is not an unmodifiable interface as the unmodifiable interface will not pass hashcode and equals operations.

getLastModDateMap

public java.util.Hashtable getLastModDateMap()

Returns search criteria for list of modification date and type of match ("less than" or "greater than") in a hash table. Note that the hash table is not an unmodifiable interface as the unmodifiable interface will not pass hashcode and equals operations.

getStatusesMap

public java.util.Hashtable getStatusesMap()

Returns search criteria for list of statuses and type of match ("less than" or "greater than") in a hash table. Note that the hash table is not an unmodifiable interface as the unmodifiable interface will not pass hashcode and equals operations.

setMatchAll

public void setMatchAll()

Sets the match type for this request search criteria as "match all parameters."

setMatchAny

public void setMatchAny()

Sets the match type for this request search criteria as "match any parameters."

addStatus

public void addStatus(java.lang.String status,
                      java.lang.String match)
               throws java.lang.IllegalArgumentException

Adds a search criteria based on status of the request. Only "equal to" and "not equal to" type matches are supported for status.

Parameters:

status - Status of the request.

match - Match type for the given status.

Throws:

java.lang.IllegalArgumentException

addCreator

public void addCreator(java.lang.String creator,
                       java.lang.String match)
                throws java.lang.IllegalArgumentException

Adds a search criteria based on creator of the request. Only "equal to" and "not equal to" type matches are supported for creator.

Parameters:

creator - Creator of the request.

match - Match type for the given status.

Throws:

java.lang.IllegalArgumentException

addApp

public void addApp(java.lang.String app,
                   java.lang.String match)
            throws java.lang.IllegalArgumentException

Adds a search criteria based on target app of the request. Only "equal to" and "not equal to" type matches are supported for app.

Parameters:

app - Target of the request.

match - Match type for the given status.

Throws:

java.lang.IllegalArgumentException

addProvOp

public void addProvOp(java.lang.String provop,
                      java.lang.String match)
               throws java.lang.IllegalArgumentException

Adds a search criteria based on operation info of the request. Only "equal to" and "not equal to" type matches are supported for app. Note that this method expects a properly formatted prov operation value as per IOperationInfo.

Parameters:

opval - Prov operation info value.

match - Match type for the given status.

Throws:

java.lang.IllegalArgumentException

addRequestID

public void addRequestID(java.lang.String id,
                         java.lang.String match)
                  throws java.lang.IllegalArgumentException

Adds a search criteria based on id of the request. Only "equal to" and "not equal to" type matches are supported for status.

Parameters:

id - Id of the request.

match - Match type for the given status.

Throws:

java.lang.IllegalArgumentException

addProcStatus

public void addProcStatus(java.lang.String procstatus,
                          java.lang.String match)
                   throws java.lang.IllegalArgumentException

Adds a search criteria based on processing status of the request. Only "equal to" and "not equal to" type matches are supported.

Parameters:

procstatus - Processing status of the request.

match - Match type for the given status.

Throws:

java.lang.IllegalArgumentException

addCreationDate

public void addCreationDate(java.lang.String date,
                            java.lang.String match)
                     throws java.lang.IllegalArgumentException

Adds a search criteria based on creation date of the request. Only "less than" and "greater than" type matches are supported for creation date

Parameters:

date - Date of creation of the request.

match - Match type for the given status.

Throws:

java.lang.IllegalArgumentException

addLastModDate

public void addLastModDate(java.lang.String date,
                           java.lang.String match)
                    throws java.lang.IllegalArgumentException

Adds a search criteria based on last modification date of the request. Only "less than" and "greater than" type matches are supported for modification date.

Parameters:

date - Last modifiction date of the request.

match - Match type for the given status.

Throws:

java.lang.IllegalArgumentException

Skip navigation links