oracle.ifs.core.activity

Class PrivatePerformedActivityRecord

java.lang.Object

oracle.ifs.core.activity.PrivatePerformedActivityRecord

public class PrivatePerformedActivityRecord
extends Object

A PrivatePerformedActivityRecord holds information about the private activity performed by a single Actor on a single ActivityRecord.

Author:

Dave Long

(Published)

Constructor Summary

Constructors

Constructor and Description
PrivatePerformedActivityRecord(Actor trckActor, ActivityRecord ar, ActionAdapter action) Construct a PrivatePerformedActivityRecord from an executing Action, in preparation for an initial insert.
PrivatePerformedActivityRecord(Actor trckActor, ActivityRecord ar, ActionAdapter action, String comment) Construct a PrivatePerformedActivityRecord from an executing Action, in preparation for an initial insert.
PrivatePerformedActivityRecord(Actor trckActor, ActivityRecord ar, ActionAdapter action, String comment, int reasonType) Construct a PrivatePerformedActivityRecord from an executing Action, in preparation for an initial insert.
PrivatePerformedActivityRecord(Actor perfActor, ActivityRecord ar, Actor trckActor) Construct a PrivatePerformedActivityRecord, in preparation for an initial insert - without a triggering Action.
PrivatePerformedActivityRecord(Actor perfActor, ActivityRecord ar, Actor trckActor, Date recDate, int opType, String comment, int reasonType) Construct a PrivatePerformedActivityRecord, in preparation for an initial insert - without a triggering Action.
PrivatePerformedActivityRecord(Actor perfActor, ActivityRecord ar, Actor trckActor, ResultSet rset) Construct a PrivatePerformedActivityRecord that has been selected.

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the PrivatePerformedActivityRecord 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 PrivatePerformedActivityRecord, if any.
ActionAdapter	getExecutedAction() Gets the previously-executed Action reflecting the AuditEvent corresponding to this PrivatePerformedActivityRecord, if any.
int	getOperationType() Gets the operation type of the AuditEvent record corresponding to this PrivatePerformedActivityRecord, if any.
PerformedActivityRecord	getPerformedActivityRecord() Gets the PerformedActivityRecord for which this PrivatePerformedActivityRecord is associated.
Actor	getPerformingActor() Gets the performing Actor.
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 PrivatePerformedActivityRecord was posted.
LibrarySession	getSession() Returns the session being used by this Selector.
Actor	getTrackingActor() Gets the Actor tracking this private Activity.
void	insert() Inserts the PrivatePerformedActivityRecord 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	isTrackingActorFreed() Returns indication as to whether or not the tracking Actor has been freed.
boolean	isTrackingActorUndiscoverable() Returns indication as to whether or not the tracking Actor is undiscoverable by the session selecting the record.
PrivatePerformedActivityRecord	lock() Establishes a row-level lock on the target PrivatePerformedActivityRecord, in preparation to update or delete it.
void	update(String comment, Integer reasonType) Updates the PrivatePerformedActivityRecord represented in this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrivatePerformedActivityRecord

public PrivatePerformedActivityRecord(Actor trckActor,
                                      ActivityRecord ar,
                                      ActionAdapter action)
                               throws IfsException

Construct a PrivatePerformedActivityRecord from an executing Action, in preparation for an initial insert.

No comment will be specified for this record.

Parameters:

trckActor - the tracking Actor

ar - the ActivityRecord on which activity was performed

action - the Action being executed

Throws:

IfsException - if operation fails.

(Published)

PrivatePerformedActivityRecord

public PrivatePerformedActivityRecord(Actor trckActor,
                                      ActivityRecord ar,
                                      ActionAdapter action,
                                      String comment)
                               throws IfsException

Construct a PrivatePerformedActivityRecord from an executing Action, in preparation for an initial insert.

Parameters:

trckActor - the tracking Actor

ar - the ActivityRecord on which activity was performed

action - the Action being executed

comment - a comment that helps to describe this private action

Throws:

IfsException - if operation fails.

(Published)

PrivatePerformedActivityRecord

public PrivatePerformedActivityRecord(Actor trckActor,
                                      ActivityRecord ar,
                                      ActionAdapter action,
                                      String comment,
                                      int reasonType)
                               throws IfsException

Construct a PrivatePerformedActivityRecord from an executing Action, in preparation for an initial insert.

Parameters:

trckActor - the tracking Actor

ar - the ActivityRecord on which activity was performed

action - the Action being executed

comment - a comment that helps to describe this private action

reasonType - the reason type describing why this record exists

Throws:

IfsException - if operation fails.

(Published)

PrivatePerformedActivityRecord

public PrivatePerformedActivityRecord(Actor perfActor,
                                      ActivityRecord ar,
                                      Actor trckActor)
                               throws IfsException

Construct a PrivatePerformedActivityRecord, in preparation for an initial insert - without a triggering Action.

Parameters:

perfActor - the performing Actor

ar - the ActivityRecord on which activity was performed

trckActor - the tracking Actor

Throws:

IfsException - if operation fails.

(Published)

PrivatePerformedActivityRecord

public PrivatePerformedActivityRecord(Actor perfActor,
                                      ActivityRecord ar,
                                      Actor trckActor,
                                      Date recDate,
                                      int opType,
                                      String comment,
                                      int reasonType)
                               throws IfsException

Construct a PrivatePerformedActivityRecord, in preparation for an initial insert - without a triggering Action.

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.

Parameters:

perfActor - the performing Actor

ar - the ActivityRecord on which activity was performed

trckActor - the tracking Actor

recDate - the date the record was posted

opType - the operation type of the event associated with the action posted

comment - a comment that helps to describe this private action

reasonType - the reason type describing why this record exists

Throws:

IfsException - if operation fails.

(Published)

PrivatePerformedActivityRecord

public PrivatePerformedActivityRecord(Actor perfActor,
                                      ActivityRecord ar,
                                      Actor trckActor,
                                      ResultSet rset)
                               throws SQLException,
                                      IfsException

Construct a PrivatePerformedActivityRecord that has been selected.

Parameters:

perfActor - the performing Actor

ar - the ActivityRecord; if null, get the value from the ResultSet

trckActor - the tracking Actor; if null, get the value from the ResultSet

rset - the resultSet selected from within PrivatePerformedActivitySelector

Throws:

IfsException - if operation fails.

SQLException - if operation fails.

(Published)

Method Detail

getSession

public LibrarySession getSession()

Returns the session being used by this Selector.

Returns:

the current session

getPerformingActor

public Actor getPerformingActor()

Gets the performing Actor.

Returns:

the Actor who is performing the private activity

getActivityRecord

public ActivityRecord getActivityRecord()

Gets the target ActivityRecord.

Will be null if the target ActivityRecord was freed or is undiscoverable by the session selecting the record.

Returns:

the ActivityRecord to use as the select target

isActivityRecordFreed

public boolean isActivityRecordFreed()

Returns indication as to whether or not the target ActivityRecord has been freed.

Returns:

true if target ActivityRecord has been freed

isActivityRecordUndiscoverable

public boolean isActivityRecordUndiscoverable()

Returns indication as to whether or not the target ActivityRecord is undiscoverable by the session selecting the record.

Returns:

true if target ActivityRecord is undiscoverable

getTrackingActor

public Actor getTrackingActor()

Gets the Actor tracking this private Activity.

Will be null if the tracking Actor was freed or is undiscoverable by the session selecting the previously executed Action.

Returns:

the Actor tracking this private Activity

isTrackingActorFreed

public boolean isTrackingActorFreed()

Returns indication as to whether or not the tracking Actor has been freed.

Returns:

true if tracking Actor has been freed.

isTrackingActorUndiscoverable

public boolean isTrackingActorUndiscoverable()

Returns indication as to whether or not the tracking Actor is undiscoverable by the session selecting the record.

Returns:

true if tracking Actor is undiscoverable

getRecordDate

public Date getRecordDate()

Gets the Date this PrivatePerformedActivityRecord was posted.

Can have the actual value of the corresponding Action that was performed, which triggered this PrivatePerformedActivityRecord, if there is such an Action.

Returns:

the Date of this record

getEventId

public long getEventId()

Gets the ID of the AuditEvent record corresponding to the Action that was performed, which triggered this PrivatePerformedActivityRecord, if any.

Has the value of 0L if there is no corresponding AuditEvent.

Returns:

ID of the corresponding AuditEvent record

getOperationType

public int getOperationType()

Gets the operation type of the AuditEvent record corresponding to this PrivatePerformedActivityRecord, if any.

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 PrivatePerformedActivityRecord.

Returns:

operation type of corresponding AuditEvent record, or an application-specific constant in the range 0 - 999999.

getRecordComment

public String getRecordComment()

Gets the comment String that helps to describe this record.

Applications can supply any String value as long as it can be stored in a VARCHAR2(4000) column.

Returns:

the comment String

getReasonType

public int getReasonType()

Gets the reason type for this record, if any.

Applications can define enumerated values to describe applicable reason types. A value of 0 implies no special reason, and can be used for generic PPARs (and is the value assigned for PPARs created using older releases).

Returns:

reason type of this PTAR record

getExecutedAction

public ActionAdapter getExecutedAction()
                                throws IfsException

Gets the previously-executed Action reflecting the AuditEvent corresponding to this PrivatePerformedActivityRecord, if any.

This will return null if there is no corresponding AuditEvent.

Returns:

previously-executed Action reflecting the AuditEvent, or null if there is no corresponding AuditEvent.

Throws:

IfsException - if operation fails.

getPerformedActivityRecord

public PerformedActivityRecord getPerformedActivityRecord()
                                                   throws IfsException

Gets the PerformedActivityRecord for which this PrivatePerformedActivityRecord is associated.

Returns:

the parent PerformedActivityRecord

Throws:

IfsException - if operation fails.

insert

public void insert()
            throws IfsException

Inserts the PrivatePerformedActivityRecord defined in this instance.

Throws:

IfsException - if operation fails.

lock

public PrivatePerformedActivityRecord lock()
                                    throws IfsException

Establishes a row-level lock on the target PrivatePerformedActivityRecord, in preparation to update or delete it.

Returns:

the locked PrivatePerformedActivityRecord (usually a different instance than the target of the method call

Throws:

IfsException - if operation fails.

update

public void update(String comment,
                   Integer reasonType)
            throws IfsException

Updates the PrivatePerformedActivityRecord represented in this instance.

This must represent a PrivatePerformedActivityRecord 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.

Parameters:

comment - the new comment value (null if no update is desired)

reasonType - the new reason type (null if no update is desired)

Throws:

IfsException - if operation fails.

delete

public void delete()
            throws IfsException

Deletes the PrivatePerformedActivityRecord represented in this instance.

This must represent a PrivatePerformedActivityRecord 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.

Throws:

IfsException - if operation fails.