oracle.ifs.core.activity

Class PerformedActivitySelector

java.lang.Object

oracle.ifs.core.activity.PerformedActivitySelector

public class PerformedActivitySelector
extends Object

A PerformedActivitySelector is used to perform simple selects of PerformedActivityRecords for a specific Actor.

Author:

Dave Long

(Published)

Constructor Summary

Constructors

Constructor and Description
PerformedActivitySelector(Actor actor) Constructs a PerformedActivitySelector.

Method Summary

Modifier and Type	Method and Description
void	addBindValue(AttributeValue bindValue) Add a bind value.
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.
ActivityRecord	getActivityRecord() Gets the target ActivityRecord.
Actor	getActor() Gets the target Actor.
protected long	getNextSequenceValue(IfsConnection conn, String seqName) Get the next value from a sequence.
String	getSearchClause() Gets the search clause.
LibrarySession	getSession() Returns the session being used by this Selector.
String	getSortClause() Gets the sort clause.
PerformedActivityRecord	selectPerformedActivityRecord() Returns the PerformedActivityRecord that matches the current specifications in this instance.
PerformedActivityRecord	selectPerformedActivityRecord(boolean lock) Returns the PerformedActivityRecord that matches the current specifications in this instance.
PerformedActivityRecord[]	selectPerformedActivityRecords() Returns the PerformedActivityRecords that match the current specifications in this instance.
void	setActivityRecord(ActivityRecord ar) Sets the target ActivityRecord.
void	setExcludeNullActivityRecords(boolean ind) Sets indication as to whether to exclude records whose ActivityRecord cannot be obtained, either because the ActivityRecord is freed or because it cannot be discovered by the selecting session.
void	setMaximumSelectCount(int maxCount) Sets the maximum number of records 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

PerformedActivitySelector

public PerformedActivitySelector(Actor actor)
                          throws IfsException

Constructs a PerformedActivitySelector.

Parameters:

actor - the Actor who has performed the activity

Throws:

IfsException - if operation fails.

Method Detail

setActivityRecord

public void setActivityRecord(ActivityRecord ar)
                       throws IfsException

Sets the target ActivityRecord.

Parameters:

ar - the ActivityRecord to use as the select target

Throws:

IfsException - if the operation fails

clearAllSearchQualifications

public void clearAllSearchQualifications()
                                  throws IfsException

Clears all search qualifications.

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 a PAR table. Use this variant when there are no bind value references in the specified qualification.

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 a PAR table. The number of bindValues specified must match the number of bind value references in the specified qualification.

Parameters:

qual - the free form search qualification

bindValues - the bind values associated with this qualification

Throws:

IfsException - if the operation fails.

addBindValue

public void addBindValue(AttributeValue bindValue)
                  throws IfsException

Add a bind value.

Parameters:

bindValue - the bind value, expressed as an AttributeValue

Throws:

IfsException - if the operation fails.

setExcludeNullActivityRecords

public void setExcludeNullActivityRecords(boolean ind)
                                   throws IfsException

Sets indication as to whether to exclude records whose ActivityRecord cannot be obtained, either because the ActivityRecord is freed or because it cannot be discovered by the selecting session.

Parameters:

ind - the indication

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 records 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 records 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

getActor

public Actor getActor()

Gets the target Actor.

Returns:

the Actor 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

selectPerformedActivityRecords

public PerformedActivityRecord[] selectPerformedActivityRecords()
                                                         throws IfsException

Returns the PerformedActivityRecords that match the current specifications in this instance.

Returns:

the array of PerformedActivityRecords that match the settings

Throws:

IfsException - if operation fails.

selectPerformedActivityRecord

public PerformedActivityRecord selectPerformedActivityRecord()
                                                      throws IfsException

Returns the PerformedActivityRecord that matches the current specifications in this instance.

It is only valid to call this variant when the ActivityRecord has been specified. The row will be selected without locking.

Returns:

the PerformedActivityRecord that matches the settings

Throws:

IfsException - if operation fails.

selectPerformedActivityRecord

public PerformedActivityRecord selectPerformedActivityRecord(boolean lock)
                                                      throws IfsException

Returns the PerformedActivityRecord that matches the current specifications in this instance.

It is only valid to call this variant when the ActivityRecord has been specified.

Parameters:

lock - whether or not to lock the selected row

Returns:

the PerformedActivityRecord that matches the settings

Throws:

IfsException - if operation fails.

getNextSequenceValue

protected long getNextSequenceValue(IfsConnection conn,
                                    String seqName)
                             throws SQLException

Get the next value from a sequence.

Parameters:

conn - the connection context

seqName - the sequence name

Returns:

the next sequence value

Throws:

SQLException - if the operation fails