public class TrackedActivitySelector extends Object
Constructor and Description |
---|
TrackedActivitySelector(Actor actor)
Constructs a TrackedActivitySelector.
|
TrackedActivitySelector(TrackedActivitySpecification tas,
ActivityRecord ar)
Constructs a TrackedActivitySelector to select TARs for all Actors
that for the specified ActivityRecord.
|
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.
|
TrackedActivitySpecification |
getTrackedActivitySpecification()
Gets the target TrackedActivitySpecification when selecting
all TARs for a single ActivityRecord.
|
TrackedActivityRecord |
selectTrackedActivityRecord()
Returns the TrackedActivityRecord that matches the current
specifications in this instance.
|
TrackedActivityRecord |
selectTrackedActivityRecord(boolean lock)
Returns the TrackedActivityRecord that matches the current
specifications in this instance.
|
TrackedActivityRecord[] |
selectTrackedActivityRecords()
Returns the TrackedActivityRecords 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.
|
public TrackedActivitySelector(Actor actor) throws IfsException
actor
- the Actor who is tracking the activityIfsException
- if operation fails.public TrackedActivitySelector(TrackedActivitySpecification tas, ActivityRecord ar) throws IfsException
tas
- the TrackedActivitySpecification whose table
should be searchedar
- the ActivityRecordIfsException
- if operation fails.public void setActivityRecord(ActivityRecord ar) throws IfsException
ar
- the ActivityRecord to use as the select targetIfsException
- if the operation failspublic void clearAllSearchQualifications() throws IfsException
IfsException
- if the operation fails.public void addFreeFormQualification(String qual) throws IfsException
The qualification must be valid for selection against a TAR table. Use this variant when there are no bind value references in the specified qualification.
qual
- the free form search qualificationIfsException
- if the operation fails.public void addFreeFormQualification(String qual, AttributeValue[] bindValues) throws IfsException
The qualification must be valid for selection against a TAR table. The number of bindValues specified must match the number of bind value references in the specified qualification.
qual
- the free form search qualificationbindValues
- the bind values associated with this qualificationIfsException
- if the operation fails.public void addBindValue(AttributeValue bindValue) throws IfsException
bindValue
- the bind value, expressed as an AttributeValueIfsException
- if the operation fails.public void setExcludeNullActivityRecords(boolean ind) throws IfsException
ind
- the indicationIfsException
- if the operation fails.public void clearSortQualification() throws IfsException
IfsException
- if the operation fails.public void setSortQualification(String sortQual) throws IfsException
sortQual
- the sort qualificationIfsException
- if the operation fails.public void setMaximumSelectCount(int maxCount)
A value of zero indicates that there is no limit on the desired number of items.
maxCount
- maximum number of records that will be selectedIfsException
- if the operation fails.public LibrarySession getSession()
public Actor getActor()
public ActivityRecord getActivityRecord()
public String getSearchClause()
public String getSortClause()
public TrackedActivitySpecification getTrackedActivitySpecification()
public TrackedActivityRecord[] selectTrackedActivityRecords() throws IfsException
IfsException
- if operation fails.public TrackedActivityRecord selectTrackedActivityRecord() throws IfsException
It is only valid to call this variant when the ActivityRecord has been specified. The row will be selected without locking.
IfsException
- if operation fails.public TrackedActivityRecord selectTrackedActivityRecord(boolean lock) throws IfsException
It is only valid to call this variant when the ActivityRecord has been specified.
lock
- whether or not to lock the selected rowIfsException
- if operation fails.protected long getNextSequenceValue(IfsConnection conn, String seqName) throws SQLException
conn
- the connection contextseqName
- the sequence nameSQLException
- if the operation failsCopyright © 2023. All rights reserved.