public class PrivateTrackedActivityRecord extends Object
Constructor and Description |
---|
PrivateTrackedActivityRecord(Actor trckActor,
ActivityRecord ar,
ActionAdapter action)
Construct a PrivateTrackedActivityRecord from an executing Action,
in preparation for an initial insert.
|
PrivateTrackedActivityRecord(Actor trckActor,
ActivityRecord ar,
ActionAdapter action,
String comment)
Construct a PrivateTrackedActivityRecord from an executing Action,
in preparation for an initial insert.
|
PrivateTrackedActivityRecord(Actor trckActor,
ActivityRecord ar,
ActionAdapter action,
String comment,
int reasonType,
int readInd)
Construct a PrivateTrackedActivityRecord from an executing Action,
in preparation for an initial insert.
|
PrivateTrackedActivityRecord(Actor trckActor,
ActivityRecord ar,
Actor perfActor)
Construct a PrivateTrackedActivityRecord,
in preparation for an initial insert - without a triggering Action.
|
PrivateTrackedActivityRecord(Actor trckActor,
ActivityRecord ar,
Actor perfActor,
Date recDate,
int opType,
String comment,
int reasonType,
int readInd)
Construct a PrivateTrackedActivityRecord,
in preparation for an initial insert - without a triggering Action.
|
PrivateTrackedActivityRecord(Actor trckActor,
ActivityRecord ar,
Actor perfActor,
ResultSet rset)
Construct a PrivateTrackedActivityRecord that has been selected.
|
Modifier and Type | Method and Description |
---|---|
void |
delete()
Deletes the PrivateTrackedActivityRecord represented in this instance.
|
ActivityRecord |
getActivityRecord()
Gets the target ActivityRecord.
|
long |
getEventId()
Gets the ID of the AuditEvent record corresponding to the Action
that was performed, which triggered this
PrivateTrackedActivityRecord, if any.
|
ActionAdapter |
getExecutedAction()
Gets the previously-executed Action reflecting the AuditEvent
corresponding to this PrivateTrackedActivityRecord, if any.
|
int |
getOperationType()
Gets the operation type of the AuditEvent record corresponding to this
PrivateTrackedActivityRecord, if any.
|
Actor |
getPerformingActor()
Gets the Actor performing this private Activity.
|
int |
getReadIndication()
Gets the code describing how the tracking actor has read/viewed
this record, if any.
|
int |
getReasonType()
Gets the reason type for this record, if any.
|
String |
getRecordComment()
Gets the comment String that helps to describe this record.
|
Date |
getRecordDate()
Gets the Date this PrivateTrackedActivityRecord was posted.
|
LibrarySession |
getSession()
Returns the session being used by this Selector.
|
TrackedActivityRecord |
getTrackedActivityRecord()
Gets the TrackedActivityRecord for which this PrivateTrackedActivityRecord
is associated.
|
Actor |
getTrackingActor()
Gets the tracking Actor.
|
void |
insert()
Inserts the PrivateTrackedActivityRecord defined in this instance.
|
boolean |
isActivityRecordFreed()
Returns indication as to whether or not the
target ActivityRecord has been freed.
|
boolean |
isActivityRecordUndiscoverable()
Returns indication as to whether or not the target
ActivityRecord is undiscoverable by the session selecting the record.
|
boolean |
isPerformingActorFreed()
Returns indication as to whether or not the performing Actor
has been freed.
|
boolean |
isPerformingActorUndiscoverable()
Returns indication as to whether or not the performing Actor is
undiscoverable by the session selecting the record.
|
PrivateTrackedActivityRecord |
lock()
Establishes a row-level lock on the target PrivateTrackedActivityRecord,
in preparation to update or delete it.
|
void |
update(String comment,
Integer reasonType,
Integer readInd)
Updates the PrivateTrackedActivityRecord represented in this instance.
|
public PrivateTrackedActivityRecord(Actor trckActor, ActivityRecord ar, ActionAdapter action) throws IfsException
No comment will be specified for this record.
trckActor
- the tracking Actorar
- the ActivityRecord on which activity was performedaction
- the Action being executedIfsException
- if operation fails.public PrivateTrackedActivityRecord(Actor trckActor, ActivityRecord ar, ActionAdapter action, String comment) throws IfsException
trckActor
- the tracking Actorar
- the ActivityRecord on which activity was performedaction
- the Action being executedcomment
- a comment that helps to describe this private actionIfsException
- if operation fails.public PrivateTrackedActivityRecord(Actor trckActor, ActivityRecord ar, ActionAdapter action, String comment, int reasonType, int readInd) throws IfsException
trckActor
- the tracking Actorar
- the ActivityRecord on which activity was performedaction
- the Action being executedcomment
- a comment that helps to describe this private actionreasonType
- the reason type describing why this record existsreadInd
- the read/view indication of this record from the
tracking Actor's pperspectiveIfsException
- if operation fails.public PrivateTrackedActivityRecord(Actor trckActor, ActivityRecord ar, Actor perfActor) throws IfsException
trckActor
- the tracking Actorar
- the ActivityRecord on which activity was performedperfActor
- the performing ActorIfsException
- if operation fails.public PrivateTrackedActivityRecord(Actor trckActor, ActivityRecord ar, Actor perfActor, Date recDate, int opType, String comment, int reasonType, int readInd) throws IfsException
In this variant, the specified opType does not reflect a triggering Action - it can be used as freeform field understood by the application. The only restriction is that the opType specified must be in the range 1 - 999999.
trckActor
- the tracking Actorar
- the ActivityRecord on which activity was performedperfActor
- the performing ActorrecDate
- the date the private record was postedopType
- the custom value describing the operation type;
must be in the range 0 - 999999.comment
- a comment that helps to describe this private actionreasonType
- the reason type describing why this record existsreadInd
- the read/view indication of this record from the
tracking Actor's pperspectiveIfsException
- if operation fails.public PrivateTrackedActivityRecord(Actor trckActor, ActivityRecord ar, Actor perfActor, ResultSet rset) throws SQLException, IfsException
trckActor
- the tracking Actorar
- the ActivityRecord;
if null, get the value from the ResultSetperfActor
- the performing Actor;
if null, get the value from the ResultSetrset
- the resultSet selected from
within PrivateTrackedActivitySelectorIfsException
- if operation fails.SQLException
- if operation fails.public LibrarySession getSession()
public Actor getTrackingActor()
public ActivityRecord getActivityRecord()
Will be null if the target ActivityRecord was freed or is undiscoverable by the session selecting the record.
public boolean isActivityRecordFreed()
public boolean isActivityRecordUndiscoverable()
public Actor getPerformingActor()
Will be null if the performing Actor was freed or is undiscoverable by the session selecting the previously executed Action.
public boolean isPerformingActorFreed()
public boolean isPerformingActorUndiscoverable()
public Date getRecordDate()
Can have the actual value of the corresponding Action that was performed, which triggered this PrivateTrackedActivityRecord, if there is such an Action.
public long getEventId()
Has the value of 0L if there is no corresponding AuditEvent.
public int getOperationType()
Applications can use codes that do not correspond to AuditEvent operations codes, as long as the values are in the range 0 - 999999. Typically a value of 0 indicates that an operation type has no meaning in the context of this PrivateTrackedActivityRecord.
public String getRecordComment()
Applications can supply any String value as long as it can be stored in a VARCHAR2(4000) column.
public int getReasonType()
Applications can define enumerated values to describe applicable reason types. A value of 0 implies no special reason, and can be used for generic PTARs (and is the value assigned for PTARs created using older releases).
public int getReadIndication()
Applications can define enumerated values to describe applicable read indication states. A value of 0 implies that the record has not been viewed by the tracking Actor, or that tracking this state is not relevant for this record (and is the value assigned for PTARs created using older releases).
public ActionAdapter getExecutedAction() throws IfsException
This will return null if there is no corresponding AuditEvent.
IfsException
- if operation fails.public TrackedActivityRecord getTrackedActivityRecord() throws IfsException
IfsException
- if operation fails.public void insert() throws IfsException
IfsException
- if operation fails.public PrivateTrackedActivityRecord lock() throws IfsException
IfsException
- if operation fails.public void update(String comment, Integer reasonType, Integer readInd) throws IfsException
This must represent a PrivateTrackedActivityRecord that was selected
from the repository, as indicated by its ID being set to a non-zero value.
It is strongly recommended that lock
be called prior
to attempting to update the record, to avoid race conditions with other
concurrent update attempts.
Only the values specified as non-null will be updated.
comment
- the new comment value (null if no update is desired)reasonType
- the new reason type (null if no update is desired)readInd
- the new read indication (null if no update is desired)IfsException
- if operation fails.public void delete() throws IfsException
This must represent a PrivateTrackedActivityRecord that was selected
from the repository, as indicated by its ID being set to a non-zero
value.
It is recommended that lock
be called prior
to attempting to delete the record, to avoid race conditions with
concurrent update attempts.
IfsException
- if operation fails.Copyright © 2023. All rights reserved.