oracle.ifs.core.activity

Class ActionSelector

java.lang.Object

oracle.ifs.core.activity.ActionSelector

public class ActionSelector
extends Object

A ActionSelector class is used to perform a simple search for previously executed Actions, selecting either for a specific ActivityRecord or for activity generated by a single Actor.

Author:

Dave Long

(Published)

Constructor Summary

Constructors

Constructor and Description
ActionSelector(ActivityRecord ar) Constructs a ActionSelector.

Method Summary

Modifier and Type	Method and Description
void	addActorQualification(Actor actor) Adds a search qualification for the Actor, so that the results are to be filtered to only include Actions performed by that Actor.
void	addAuditEventTypeQualification(AuditEventTypeDefinition eventDef) Adds a search qualification for an event type.
void	addAuditEventTypeQualifications(AuditEventTypeDefinition[] eventDefs) Adds a search qualification for a set of event types.
void	addEventIdQualification(long eventId, String operator) Adds a search qualification for an event ID along with a logical operator (e.g. "="), so that the results are to be filtered to include the Action whose IDs meet the qualification.
void	addFreeFormQualification(String qual) Adds a free form search qualification.
void	addFreeFormQualification(String qual, AttributeValue[] bindValues) Adds a free form search qualification.
void	clearAllSearchQualifications() Clears all search qualifications.
void	clearSortQualification() Clears the sort qualification, forcing it to assume the default value.
Long	getActionId(int pos) Deprecated. 9.2.4: use getActionIdAfterPosition
Long	getActionIdAfterPosition(int pos) Returns Action ID on the specified "slider" position.
ActivityRecord	getActivityRecord() Gets the target ActivityRecord.
String	getSearchClause() Gets the search clause.
LibrarySession	getSession() Returns the session being used by this Selector.
String	getSortClause() Gets the sort clause.
Action[]	selectActions() Returns the entire search results as an array of Actions.
Action[]	selectAllActionsAfterPosition(int pos) Returns all Actions that were posted after the specified "slider" position.
AuditEvent[]	selectAuditEvents() Returns the entire search results as an array of the AuditEvents that reflect each previously executed Action.
void	setMaximumSelectCount(int maxCount) Sets the maximum number of actions that will be selected.
void	setSortQualification(String sortQual) Set the sort qualification.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionSelector

public ActionSelector(ActivityRecord ar)
               throws IfsException

Constructs a ActionSelector.

Parameters:

ar - the ActivityRecord to use as the select target

Throws:

IfsException - if the operation fails.

Method Detail

clearAllSearchQualifications

public void clearAllSearchQualifications()
                                  throws IfsException

Clears all search qualifications.

Throws:

IfsException - if the operation fails.

addActorQualification

public void addActorQualification(Actor actor)
                           throws IfsException

Adds a search qualification for the Actor, so that the results are to be filtered to only include Actions performed by that Actor.

Parameters:

actor - the Actor in the search qualification

Throws:

IfsException - if the operation fails.

addAuditEventTypeQualification

public void addAuditEventTypeQualification(AuditEventTypeDefinition eventDef)
                                    throws IfsException

Adds a search qualification for an event type.

Parameters:

eventDef - the event type definition to include in the search qualification

Throws:

IfsException - if the operation fails.

addAuditEventTypeQualifications

public void addAuditEventTypeQualifications(AuditEventTypeDefinition[] eventDefs)
                                     throws IfsException

Adds a search qualification for a set of event types.

For an Action to qualify in the search, its event operation type must match one of the event types specified. The types will be OR'd together in the search clause.

Parameters:

eventDefs - the event type definitions to include in the search qualification

Throws:

IfsException - if the operation fails.

addEventIdQualification

public void addEventIdQualification(long eventId,
                                    String operator)
                             throws IfsException

Adds a search qualification for an event ID along with a logical operator (e.g. "="), so that the results are to be filtered to include the Action whose IDs meet the qualification.

Parameters:

eventId - the event ID to use in the search qualification

operator - the operator to use in the search qualification; one of "=", "!=", ">", ">=", "<", or "<="

Throws:

IfsException - if the operation fails.

addFreeFormQualification

public void addFreeFormQualification(String qual)
                              throws IfsException

Adds a free form search qualification.

The qualification must be valid for selection against an event table.

Parameters:

qual - the free form search qualification

Throws:

IfsException - if the operation fails.

addFreeFormQualification

public void addFreeFormQualification(String qual,
                                     AttributeValue[] bindValues)
                              throws IfsException

Adds a free form search qualification.

The qualification must be valid for selection against an event table.

Parameters:

qual - the free form search qualification

bindValues - the bind values associated with this qualification

Throws:

IfsException - if the operation fails.

clearSortQualification

public void clearSortQualification()
                            throws IfsException

Clears the sort qualification, forcing it to assume the default value.

Throws:

IfsException - if the operation fails.

setSortQualification

public void setSortQualification(String sortQual)
                          throws IfsException

Set the sort qualification.

Parameters:

sortQual - the sort qualification

Throws:

IfsException - if the operation fails.

setMaximumSelectCount

public void setMaximumSelectCount(int maxCount)

Sets the maximum number of actions that will be selected.

A value of zero indicates that there is no limit on the desired number of items.

Parameters:

maxCount - maximum number of actions that will be selected

Throws:

IfsException - if the operation fails.

getSession

public LibrarySession getSession()

Returns the session being used by this Selector.

Returns:

the current session

getActivityRecord

public ActivityRecord getActivityRecord()

Gets the target ActivityRecord.

Returns:

the ActivityRecord to use as the select target

getSearchClause

public String getSearchClause()

Gets the search clause.

Returns:

the search clause to use when selecting Actions

getSortClause

public String getSortClause()

Gets the sort clause.

Returns:

the sort clause to use when selecting Actions

selectAuditEvents

public AuditEvent[] selectAuditEvents()
                               throws IfsException

Returns the entire search results as an array of the AuditEvents that reflect each previously executed Action.

Returns:

the array of AuditEvents that match the settings

Throws:

IfsException - if operation fails.

selectActions

public Action[] selectActions()
                       throws IfsException

Returns the entire search results as an array of Actions.

Returns:

the array of Actions that match the settings

Throws:

IfsException - if operation fails.

selectAllActionsAfterPosition

public Action[] selectAllActionsAfterPosition(int pos)
                                       throws IfsException

Returns all Actions that were posted after the specified "slider" position.

This method ignores (and clears) any previous settings made to the search clause or sort clause.

Parameters:

pos - the slider position

Returns:

the array of Actions that were posted after the specified position

Throws:

IfsException - if operation fails.

getActionId

public Long getActionId(int pos)
                 throws IfsException

Deprecated. 9.2.4: use getActionIdAfterPosition

Returns Action ID on the specified "slider" position.

This method ignores (and clears) any previous settings made to the search clause or sort clause.

Parameters:

pos - the slider position

Returns:

the action ID after the specified position

Throws:

IfsException - if operation fails.

getActionIdAfterPosition

public Long getActionIdAfterPosition(int pos)
                              throws IfsException

Returns Action ID on the specified "slider" position.

This method ignores (and clears) any previous settings made to the search clause or sort clause.

Parameters:

pos - the slider position

Returns:

the action ID after the specified position

Throws:

IfsException - if operation fails.