public class PrivateTrackedActivitySelector extends Object
Constructor and Description |
---|
PrivateTrackedActivitySelector(Actor actor)
Constructs a PrivateTrackedActivitySelector.
|
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.
|
String |
getSearchClause()
Gets the search clause.
|
LibrarySession |
getSession()
Returns the session being used by this Selector.
|
String |
getSortClause()
Gets the sort clause.
|
PrivateTrackedActivityRecord |
selectPrivateTrackedActivityRecord(long id)
Returns the PrivateTrackedActivityRecord for the ID specified,
for the tracking Actor specified during construction.
|
PrivateTrackedActivityRecord |
selectPrivateTrackedActivityRecord(long id,
boolean lock)
Returns the PrivateTrackedActivityRecord for the ID specified,
for the tracking Actor specified during construction, optionally
selecting with a row-level lock.
|
PrivateTrackedActivityRecord[] |
selectPrivateTrackedActivityRecords()
Returns the PrivateTrackedActivityRecords 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 |
setExcludeNullPerformingActors(boolean ind)
Sets indication as to whether to exclude records whose performing Actor
cannot be obtained, either because the performing Actor 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 PrivateTrackedActivitySelector(Actor actor) throws IfsException
actor
- the Actor who is tracking the private activityIfsException
- 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 PTAR 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 PTAR 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 setExcludeNullPerformingActors(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 PrivateTrackedActivityRecord[] selectPrivateTrackedActivityRecords() throws IfsException
IfsException
- if operation fails.public PrivateTrackedActivityRecord selectPrivateTrackedActivityRecord(long id) throws IfsException
The row will be selected without locking.
See additional note in the second variant of this method.
id
- the ID of the recordIfsException
- if operation fails.public PrivateTrackedActivityRecord selectPrivateTrackedActivityRecord(long id, boolean lock) throws IfsException
When using this variant, no additional free form qualifications should be specified - only the Actor that is required during construction should be used in the search qualification, along with the ID specified in this method. If other qualfications are present, it is possible that no rows will be found even if there exists a row with the Actor/ID combination specified.
id
- the ID of the recordlock
- whether or not to lock the selected rowIfsException
- if operation fails.Copyright © 2023. All rights reserved.