oracle.ifs.core.activity

Class ActivityProcessor

java.lang.Object

oracle.ifs.core.activity.ActivityProcessor

Direct Known Subclasses:

ConversationActivityProcessor, ExtendedActivityProcessor, SocialActivityProcessor

public abstract class ActivityProcessor
extends Object

An ActivityProcessor performs various processing of activity.

Field Summary

Fields

Modifier and Type	Field and Description
static int	SUMMARY_COUNT_POSITION_UPDATED The count position for number of "Update" actions.
static int	SUMMARY_INDICATION_POSITION_CREATED The indication position for "Created".
static int	SUMMARY_INDICATION_POSITION_DELETED The indication position for "Deleted".

Constructor Summary

Constructors

Constructor and Description
ActivityProcessor()

Method Summary

Modifier and Type	Method and Description
void	applyActionToActivitySummaryDelta(ActivitySummary deltaSumm, ActivitySummary parSumm, Action action) Apply an Action to an ActivitySummary delta.
protected void	calculateCompositeActivityLevel(TrackedActivityRecord tar, ActionAdapter action, TrackedActivityRecordLevels levels) Deprecated. 9.2.3: include calculation in other pre-Update overrides
protected void	calculateDeltaActivityLevel(TrackedActivityRecord tar, ActionAdapter action, ActivitySummary deltaSumm, TrackedActivityRecordLevels levels) Deprecated. 9.2.3: use preUpdateDeltaTrackedActivityRecord
protected void	calculateInclusionActivityLevel(TrackedActivityRecord tar, ActionAdapter action, TrackedActivityRecordLevels levels) Deprecated. 9.2.3: use preUpdateInclusionTrackedActivityRecord
protected void	calculateOverallActivityLevel(ActivityRecord ar, ActivitySummary asumm, ActionAdapter action, TrackedActivityRecordLevels levels) Calculate and apply the overall Activity Level to be used as one of the components of TrackedActivityRecords, and to be stored as part of the ActivityRecord, using Attribute ACTIVITYLEVEL.
protected void	calculatePerformedActivityLevel(PerformedActivityRecord par, TrackedActivityRecord tar, ActionAdapter action, TrackedActivityRecordLevels levels) Deprecated. 9.2.3: use preUpdatePerformingTrackedActivityRecord
void	deleteTrackedActivityRecord(TrackedActivityRecord tar) Delete the specified TrackedActivityRecord.
ActivitySpecification	getActivitySpecification() Gets the ActivitySpecification value associated with this instance.
protected void	getActivitySummaryCountPositions(List<Integer> countList) Gets the Count Positions in effect for this class, by adding them to the specified List.
protected void	getActivitySummaryIndicationPositions(List<Integer> indList) Gets the Indication Positions in effect for this class, by adding them to the specified List.
protected void	getActivitySummaryNumberPositions(List<Integer> numList) Gets the Number Positions in effect for this class, by adding them to the specified List.
protected void	getIncludedActors(Action action, LinkedHashMap map) For a previously-executed committed Action, get the set of Actors that have become included in the specified activity as a result of this Action, and add to the specified map.
protected void	getIncludedActors(PerformedActivityRecord par, Action action, LinkedHashMap map) During the execution of the specified Action, get the set of Actors that have become included in the specified activity as a result of this Action, and add to the specified map.
static ActivityProcessor	getInstance(LibrarySession session, String specName) Gets the ActivityProcessor for the specified ActivitySpecification (identified by name and session) associated with this type of ActivityProcessor.
AttributeValueTable	getPropertyTable() Gets the AttributeValueTable representing the set of Properties defined for the ActivitySpecification associated with this instance.
LibrarySession	getSession() Gets the session context associated with this instance.
int	getUpdateCount(ActivitySummary asumm) Returns the number of times an UpdateAction has been posted.
void	initialize(ActivitySpecification spec) Initialize this instance.
protected boolean	isCommittedActionProcessingRequired(ActivityRecord ar, ActionAdapter action) Returns indication as to whether the specified Action (which is in the process of being executed) requires additional processing after the Action is committed.
boolean	isCreated(ActivitySummary asumm) Returns indication as to whether a CreateAction has been posted.
boolean	isDeleted(ActivitySummary asumm) Returns indication as to whether a DeleteAction has been posted.
TrackedActivityRecord	markLastViewedActivitySummaryAsPartiallyRead(TrackedActivityRecord tar, ActionAdapter lastAction) Refresh the LastViewed delta ActivitySummary for the specified TrackedActivityRecord, marking it as partially viewed up to (and including) the specified Action.
TrackedActivityRecord	markLastViewedActivitySummaryAsRead(TrackedActivityRecord tar) Refresh the LastViewed delta ActivitySummary for the specified TrackedActivityRecord, marking it as completely viewed (matching the current state of the ActivityRecord).
protected void	postPrivateRecords(TrackedActivityRecord tar, ActionAdapter action) Deprecated. 9.2.3: include actions in other pre-Update overrides
protected void	preUpdateDeltaTrackedActivityRecord(TrackedActivityRecord tar, ActionAdapter lastAction, ActivitySummary deltaSumm, TrackedActivityRecordLevels levels) Perform any pre-update operations before a TAR update, that is triggered by an operation that marks activity as fully or partially read by the tracking Actor.
protected void	preUpdateInclusionTrackedActivityRecord(TrackedActivityRecord tar, ActionAdapter action, ActivitySummary lastDeltaSumm, boolean prevExecuted, TrackedActivityRecordLevels levels, Object inclActorPayload) Perform any pre-update operations before a TAR update, that is triggered by a newly executed action or a previously executed one.
protected void	preUpdatePerformedActivityRecord(PerformedActivityRecord par, ActionAdapter action, ActivitySummary parSumm) Perform any pre-update operations before a PAR update, that is triggered by a newly executed action.
protected void	preUpdatePerformingTrackedActivityRecord(PerformedActivityRecord par, TrackedActivityRecord tar, ActionAdapter action, ActivitySummary lastDeltaSumm, TrackedActivityRecordLevels levels) Perform any pre-update operations before a TAR update, that is triggered by a newly executed action.
protected void	processCommittedAction(ActivityRecord ar, ActionAdapter action) Perform additional processing of a committed previously-executed Action.
TrackedActivityRecord	refreshDeltaActivitySummary(TrackedActivityRecord tar) Refresh the LastViewed delta ActivitySummary for the specified TrackedActivityRecord.
void	synchronizeOverallActivityLevel(ActivityRecord ar, TrackedActivityRecord tar, TrackedActivityRecordLevels levels) Synchronize the overall activity setting in the ActivityRecord on the specified TrackedActivityRecord if the values are different.
void	updateActivityRecord(ActivityRecord ar, ActivitySummary arSumm, ActionAdapter action, TrackedActivityRecordLevels levels) Update the ActivityRecord to reflect updates that were made to its ActivitySummary.
void	updateInclusionTrackedActivityRecord(TrackedActivityRecord tar, ActionAdapter action, ActivitySummary arSumm, boolean prevExecuted, TrackedActivityRecordLevels levels, Object inclActorPayload) Update the TrackedActivityRecord specified, which represents an Actor that is included in the specified Action or activity.
void	updateInclusionTrackedActivityRecord(TrackedActivityRecord tar, ActionAdapter action, ActivitySummary arSumm, TrackedActivityRecordLevels levels, Object inclActorPayload) Update the TrackedActivityRecord specified, which represents an Actor that is included in the specified Action or activity.
void	updatePerformedActivityRecord(PerformedActivityRecord par, ActivitySummary asumm, ActionAdapter action) Update the PerformedActivityRecord to reflect updates that were made to its ActivitySummary as a result of executing an Action.
void	updatePerformingTrackedActivityRecord(PerformedActivityRecord par, TrackedActivityRecord tar, ActionAdapter action, ActivitySummary arSumm, TrackedActivityRecordLevels levels) Update the TrackedActivityRecord specified, which represents an Actor that is performing the action.
TrackedActivityRecord	updateSpecifiedCompositeLevel(TrackedActivityRecord tar, int compLevel, boolean clearLevel) Update the specified composite level for a TrackedActivityRecord.
void	updateTrackedActivityRecordLevels(TrackedActivityRecord tar, TrackedActivityRecordLevels levels) Update the TrackedActivityRecordLevels.
void	validate() Validate this instance.
void	verifyAllowableAction(ActionSpecification anSpec) Verify that the specified ActionSpecification is allowed for this Activity type.

Methods inherited from class java.lang.Object

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

Field Detail

SUMMARY_INDICATION_POSITION_CREATED

public static final int SUMMARY_INDICATION_POSITION_CREATED

The indication position for "Created".

See Also:

Constant Field Values

SUMMARY_INDICATION_POSITION_DELETED

public static final int SUMMARY_INDICATION_POSITION_DELETED

The indication position for "Deleted".

See Also:

Constant Field Values

SUMMARY_COUNT_POSITION_UPDATED

public static final int SUMMARY_COUNT_POSITION_UPDATED

The count position for number of "Update" actions.

See Also:

Constant Field Values

Constructor Detail

ActivityProcessor

public ActivityProcessor()

Method Detail

initialize

public void initialize(ActivitySpecification spec)
                throws IfsException

Initialize this instance.

Called immediately after construction (via the default constructor) via reflection within ActivitySpecification.

Parameters:

spec - The ActivitySpecification for a given implementation.

Throws:

IfsException - if the operation fails.

getSession

public LibrarySession getSession()

Gets the session context associated with this instance.

Returns:

the session context

getActivitySpecification

public ActivitySpecification getActivitySpecification()

Gets the ActivitySpecification value associated with this instance.

Returns:

the ActivitySpecification value

getPropertyTable

public AttributeValueTable getPropertyTable()

Gets the AttributeValueTable representing the set of Properties defined for the ActivitySpecification associated with this instance.

Returns:

the ActivitySpecification property table

getInstance

public static ActivityProcessor getInstance(LibrarySession session,
                                            String specName)
                                     throws IfsException

Gets the ActivityProcessor for the specified ActivitySpecification (identified by name and session) associated with this type of ActivityProcessor.

Parameters:

session - session context

specName - the name of the ActivitySpecification.

Returns:

the ActivityProcessor cached by the indicated ActivitySpecification

Throws:

IfsException - if operation fails

verifyAllowableAction

public void verifyAllowableAction(ActionSpecification anSpec)
                           throws IfsException

Verify that the specified ActionSpecification is allowed for this Activity type.

Parameters:

anSpec - The ActionSpecification to check

Throws:

IfsException - if the ActionSpecification is not allowed

isCreated

public boolean isCreated(ActivitySummary asumm)

Returns indication as to whether a CreateAction has been posted.

When accessed with an ActivitySummary for a single Actor, the returned value indicates whether that Actor executed the CreateAction.

Parameters:

asumm - the ActivitySummary

Returns:

true if the CreateAction has been executed; false otherwise

isDeleted

public boolean isDeleted(ActivitySummary asumm)

Returns indication as to whether a DeleteAction has been posted.

When accessed with an ActivitySummary for a single Actor, the returned value indicates whether that Actor executed the DeleteAction.

Parameters:

asumm - the ActivitySummary

Returns:

true if the DeleteAction has been executed; false otherwise

getUpdateCount

public int getUpdateCount(ActivitySummary asumm)

Returns the number of times an UpdateAction has been posted.

Parameters:

asumm - the ActivitySummary

Returns:

the number of Updates performed

applyActionToActivitySummaryDelta

public void applyActionToActivitySummaryDelta(ActivitySummary deltaSumm,
                                              ActivitySummary parSumm,
                                              Action action)
                                       throws IfsException

Apply an Action to an ActivitySummary delta.

Parameters:

deltaSumm - the target ActivitySummary Delta

parSumm - the target ActivitySummary

action - Action to add to the summary

Throws:

IfsException - if the operation fails.

updatePerformedActivityRecord

public void updatePerformedActivityRecord(PerformedActivityRecord par,
                                          ActivitySummary asumm,
                                          ActionAdapter action)
                                   throws IfsException

Update the PerformedActivityRecord to reflect updates that were made to its ActivitySummary as a result of executing an Action.

Also update the specified PerformedActivityRecord so that it reflects the LastAction and LastActionDate.

Parameters:

par - the target PerformedActivityRecord to update

asumm - the new ActivitySummary

action - the Action being executed

Throws:

IfsException - if the operation fails.

updateActivityRecord

public void updateActivityRecord(ActivityRecord ar,
                                 ActivitySummary arSumm,
                                 ActionAdapter action,
                                 TrackedActivityRecordLevels levels)
                          throws IfsException

Update the ActivityRecord to reflect updates that were made to its ActivitySummary.

Parameters:

ar - the target ActivityRecord to update

arSumm - the new ActivitySummary

action - the Action being executed

levels - the TrackedActivityRecord Levels, which holds the overall activity setting (if set)

Throws:

IfsException - if the operation fails.

updatePerformingTrackedActivityRecord

public void updatePerformingTrackedActivityRecord(PerformedActivityRecord par,
                                                  TrackedActivityRecord tar,
                                                  ActionAdapter action,
                                                  ActivitySummary arSumm,
                                                  TrackedActivityRecordLevels levels)
                                           throws IfsException

Update the TrackedActivityRecord specified, which represents an Actor that is performing the action.

Parameters:

par - the PerformedActivityRecord for the Actor who is executing the Action

tar - the TrackedActivityRecord being updated

action - the Action being executed

arSumm - the new ActivitySummary reflecting the ActivityRecord

levels - the TrackedActivityRecord Levels

Throws:

IfsException - if the operation fails.

updateInclusionTrackedActivityRecord

public void updateInclusionTrackedActivityRecord(TrackedActivityRecord tar,
                                                 ActionAdapter action,
                                                 ActivitySummary arSumm,
                                                 TrackedActivityRecordLevels levels,
                                                 Object inclActorPayload)
                                          throws IfsException

Update the TrackedActivityRecord specified, which represents an Actor that is included in the specified Action or activity.

Implies that the specified Action was previously executed; use the other variant to imply that the Action is in the process of being executed.

Parameters:

tar - the TrackedActivityRecord being updated

action - the Action being executed

arSumm - the new ActivitySummary reflecting the ActivityRecord

levels - the TrackedActivityRecord Levels

inclActorPayload - the Payload specified inthe included Actor map for the included Actor being processed now

Throws:

IfsException - if the operation fails.

updateInclusionTrackedActivityRecord

public void updateInclusionTrackedActivityRecord(TrackedActivityRecord tar,
                                                 ActionAdapter action,
                                                 ActivitySummary arSumm,
                                                 boolean prevExecuted,
                                                 TrackedActivityRecordLevels levels,
                                                 Object inclActorPayload)
                                          throws IfsException

Update the TrackedActivityRecord specified, which represents an Actor that is included in the specified Action or activity.

Parameters:

tar - the TrackedActivityRecord being updated

action - the Action being executed

arSumm - the new ActivitySummary reflecting the ActivityRecord

prevExecuted - whether the action was previously executed, and being processed from the RetainedEvent

levels - the TrackedActivityRecord Levels

inclActorPayload - the Payload specified inthe included Actor map for the included Actor being processed now

Throws:

IfsException - if the operation fails.

refreshDeltaActivitySummary

public TrackedActivityRecord refreshDeltaActivitySummary(TrackedActivityRecord tar)
                                                  throws IfsException

Refresh the LastViewed delta ActivitySummary for the specified TrackedActivityRecord.

Parameters:

tar - the TrackedActivityRecord whose delta ActivitySummary will be refreshed

Returns:

the updated TrackedActivityRecord

Throws:

IfsException - if the operation fails.

markLastViewedActivitySummaryAsRead

public TrackedActivityRecord markLastViewedActivitySummaryAsRead(TrackedActivityRecord tar)
                                                          throws IfsException

Refresh the LastViewed delta ActivitySummary for the specified TrackedActivityRecord, marking it as completely viewed (matching the current state of the ActivityRecord).

Parameters:

tar - the TrackedActivityRecord whose delta ActivitySummary will be refreshed

Returns:

the updated TrackedActivityRecord

Throws:

IfsException - if the operation fails.

markLastViewedActivitySummaryAsPartiallyRead

public TrackedActivityRecord markLastViewedActivitySummaryAsPartiallyRead(TrackedActivityRecord tar,
                                                                          ActionAdapter lastAction)
                                                                   throws IfsException

Refresh the LastViewed delta ActivitySummary for the specified TrackedActivityRecord, marking it as partially viewed up to (and including) the specified Action.

Parameters:

tar - the TrackedActivityRecord whose delta ActivitySummary will be refreshed

lastAction - the last action viewed; if null, mark as fully read

Returns:

the updated TrackedActivityRecord

Throws:

IfsException - if the operation fails.

updateSpecifiedCompositeLevel

public TrackedActivityRecord updateSpecifiedCompositeLevel(TrackedActivityRecord tar,
                                                           int compLevel,
                                                           boolean clearLevel)
                                                    throws IfsException

Update the specified composite level for a TrackedActivityRecord.

Parameters:

tar - the TrackedActivityRecord to be updated

compLevel - the specified composite level

clearLevel - whether the composite value should be marked as not set

Returns:

the updated TrackedActivityRecord

Throws:

IfsException - if the operation fails.

updateTrackedActivityRecordLevels

public void updateTrackedActivityRecordLevels(TrackedActivityRecord tar,
                                              TrackedActivityRecordLevels levels)
                                       throws IfsException

Update the TrackedActivityRecordLevels.

The TrackedActivityRecord specified must have been selected with locking for update specified for this method to work properly - using selectTrackedActivityRecord(true) or equivalent.

Parameters:

tar - the TrackedActivityRecord being updated

levels - the TrackedActivityRecord Levels

Throws:

IfsException - if the operation fails.

(Published)

deleteTrackedActivityRecord

public void deleteTrackedActivityRecord(TrackedActivityRecord tar)
                                 throws IfsException

Delete the specified TrackedActivityRecord.

Parameters:

tar - the TrackedActivityRecord to be deleted

Throws:

IfsException - if the operation fails.

processCommittedAction

protected void processCommittedAction(ActivityRecord ar,
                                      ActionAdapter action)
                               throws IfsException

Perform additional processing of a committed previously-executed Action.

Parameters:

ar - the target ActivityRecord

action - the previously-executed Action

Throws:

IfsException - if the operation fails

getIncludedActors

protected void getIncludedActors(PerformedActivityRecord par,
                                 Action action,
                                 LinkedHashMap map)
                          throws IfsException

During the execution of the specified Action, get the set of Actors that have become included in the specified activity as a result of this Action, and add to the specified map.

Parameters:

par - the PerformedActivityRecord being updated

action - the Action being executed

map - the included Actor map, to be added to

Throws:

IfsException - if the operation fails.

getIncludedActors

protected void getIncludedActors(Action action,
                                 LinkedHashMap map)
                          throws IfsException

For a previously-executed committed Action, get the set of Actors that have become included in the specified activity as a result of this Action, and add to the specified map.

Parameters:

action - the committed Action that was previously-executed

map - the included Actor map, to be added to

Throws:

IfsException - if the operation fails.

calculateOverallActivityLevel

protected void calculateOverallActivityLevel(ActivityRecord ar,
                                             ActivitySummary asumm,
                                             ActionAdapter action,
                                             TrackedActivityRecordLevels levels)
                                      throws IfsException

Calculate and apply the overall Activity Level to be used as one of the components of TrackedActivityRecords, and to be stored as part of the ActivityRecord, using Attribute ACTIVITYLEVEL.

Parameters:

ar - the target ActivityRecord to update

asumm - the new ActivitySummary (which includes the newly executed Action)

action - the Action being executed, or null if no Action is being executed (perform the calculation based upon current activity only)

levels - the TrackedActivityRecordLevels to apply the setting

Throws:

IfsException - if the operation fails

calculatePerformedActivityLevel

protected void calculatePerformedActivityLevel(PerformedActivityRecord par,
                                               TrackedActivityRecord tar,
                                               ActionAdapter action,
                                               TrackedActivityRecordLevels levels)
                                        throws IfsException

Deprecated. 9.2.3: use preUpdatePerformingTrackedActivityRecord

Calculate and apply the Performed Activity Level to be used when updating the Performed Activity component of a TrackedActivityRecord for the performing Actor of an Action.

Parameters:

par - the PerformedActivityRecord being updated

tar - the TrackedActivityRecord for the performing Actor

action - the Action being executed, or null if no Action is being executed (perform the calculation based upon current activity only)

levels - the TrackedActivityRecordLevels to apply the setting

Throws:

IfsException - if the operation fails

calculateDeltaActivityLevel

protected void calculateDeltaActivityLevel(TrackedActivityRecord tar,
                                           ActionAdapter action,
                                           ActivitySummary deltaSumm,
                                           TrackedActivityRecordLevels levels)
                                    throws IfsException

Deprecated. 9.2.3: use preUpdateDeltaTrackedActivityRecord

Calculate and apply the Delta Activity Level to be used when updating the Delta Activity component of a TrackedActivityRecord.

Parameters:

tar - the TrackedActivityRecord being updated

action - the Action being executed, or null if no Action is being executed (perform the calculation based upon current activity only)

deltaSumm - the new delta Summary

levels - the TrackedActivityRecordLevels to apply the setting

Throws:

IfsException - if the operation fails

calculateInclusionActivityLevel

protected void calculateInclusionActivityLevel(TrackedActivityRecord tar,
                                               ActionAdapter action,
                                               TrackedActivityRecordLevels levels)
                                        throws IfsException

Deprecated. 9.2.3: use preUpdateInclusionTrackedActivityRecord

Calculate and apply the Inclusion Activity Level to be used when updating the Inclusion Activity component of a TrackedActivityRecord for an Actor that is included in an executing Action.

Parameters:

tar - the TrackedActivityRecord for the included Actor

action - the Action being executed, or null if no Action is being executed (perform the calculation based upon current activity only)

levels - the TrackedActivityRecordLevels to apply the setting

Throws:

IfsException - if the operation fails

calculateCompositeActivityLevel

protected void calculateCompositeActivityLevel(TrackedActivityRecord tar,
                                               ActionAdapter action,
                                               TrackedActivityRecordLevels levels)
                                        throws IfsException

Deprecated. 9.2.3: include calculation in other pre-Update overrides

Calculate and apply the Composite Activity Level to be used when updating a TrackedActivityRecord.

Parameters:

tar - the TrackedActivityRecord being updated

action - the Action being executed, or null if no Action is being executed (perform the calculation based upon current activity only)

levels - the TrackedActivityRecordLevels to apply the setting

Throws:

IfsException - if the operation fails

postPrivateRecords

protected void postPrivateRecords(TrackedActivityRecord tar,
                                  ActionAdapter action)
                           throws IfsException

Deprecated. 9.2.3: include actions in other pre-Update overrides

Post any private records for the TrackedActivityRecord specified, which represents an Actor that is included in the specified Action.

Parameters:

tar - the TrackedActivityRecord being updated

action - the Action (executiung or committed)

Throws:

IfsException - if the operation fails.

preUpdatePerformedActivityRecord

protected void preUpdatePerformedActivityRecord(PerformedActivityRecord par,
                                                ActionAdapter action,
                                                ActivitySummary parSumm)
                                         throws IfsException

Perform any pre-update operations before a PAR update, that is triggered by a newly executed action.

Typically this is overridden to add PrivatePerformedActivityRecords.

Parameters:

par - the PerformedActivityRecord being updated

action - the Action being executed

parSumm - the new PAR Summary

Throws:

IfsException - if the operation fails

preUpdatePerformingTrackedActivityRecord

protected void preUpdatePerformingTrackedActivityRecord(PerformedActivityRecord par,
                                                        TrackedActivityRecord tar,
                                                        ActionAdapter action,
                                                        ActivitySummary lastDeltaSumm,
                                                        TrackedActivityRecordLevels levels)
                                                 throws IfsException

Perform any pre-update operations before a TAR update, that is triggered by a newly executed action.

Typically this is overridden to calculate a new Performed Activity Level that is set into the specified TrackedActivityRecordLevels. This entry point is called during the postExecution phase of executing the Action, and prior to it being committed.

Parameters:

par - the PerformedActivityRecord being updated

tar - the TrackedActivityRecord for the performing Actor

action - the Action being executed

deltaSumm - the new delta Summary

levels - the TrackedActivityRecordLevels to apply the setting

Throws:

IfsException - if the operation fails

preUpdateInclusionTrackedActivityRecord

protected void preUpdateInclusionTrackedActivityRecord(TrackedActivityRecord tar,
                                                       ActionAdapter action,
                                                       ActivitySummary lastDeltaSumm,
                                                       boolean prevExecuted,
                                                       TrackedActivityRecordLevels levels,
                                                       Object inclActorPayload)
                                                throws IfsException

Perform any pre-update operations before a TAR update, that is triggered by a newly executed action or a previously executed one.

Typically this is overridden to calculate a new Inclusion Activity Level that is set into the specified TrackedActivityRecordLevels. This entry point is called in two spots:

• During the postExecution phase of executing the Action, and prior to it being committed, or Actors that are deemed to be "included" during the postExecution phase of the Action.
• During the processCommittedAction phase, where an Action had been previously committed, and ExecutedActionRetainedEvent processing has determined additional Actors that are included.

Parameters:

tar - the TrackedActivityRecord for the included Actor

action - the Action being executed, or null if no Action is being executed (perform the calculation based upon current activity only)

deltaSumm - the new delta Summary

prevExecuted - whether the action was previously executed, and being processed from the RetainedEvent

levels - the TrackedActivityRecordLevels to apply the setting

inclActorPayload - the Payload specified inthe included Actor map for the included Actor being processed now

Throws:

IfsException - if the operation fails

preUpdateDeltaTrackedActivityRecord

protected void preUpdateDeltaTrackedActivityRecord(TrackedActivityRecord tar,
                                                   ActionAdapter lastAction,
                                                   ActivitySummary deltaSumm,
                                                   TrackedActivityRecordLevels levels)
                                            throws IfsException

Perform any pre-update operations before a TAR update, that is triggered by an operation that marks activity as fully or partially read by the tracking Actor.

Typically this is overridden to calculate a new Delta Activity Level that is set into the specified TrackedActivityRecordLevels. This entry point is called when a tracking Actor indicates he has fully or partially read the activity represented in the TAR. If fully read, the specified lastAction will be null; otherwise it is a partial read up to and including the specified lastAction.

Parameters:

tar - the TrackedActivityRecord being updated

lastAction - the last action viewed; set if being marked partially read, null otherwise

deltaSumm - the new delta Summary

levels - the TrackedActivityRecordLevels to apply the setting

Throws:

IfsException - if the operation fails

synchronizeOverallActivityLevel

public final void synchronizeOverallActivityLevel(ActivityRecord ar,
                                                  TrackedActivityRecord tar,
                                                  TrackedActivityRecordLevels levels)
                                           throws IfsException

Synchronize the overall activity setting in the ActivityRecord on the specified TrackedActivityRecord if the values are different.

Parameters:

ar - the target ActivityRecord that may have changed

tar - the TrackedActivityRecord being updated

levels - the TrackedActivityRecordLevels to apply the setting

Throws:

IfsException - if the operation fails

isCommittedActionProcessingRequired

protected boolean isCommittedActionProcessingRequired(ActivityRecord ar,
                                                      ActionAdapter action)
                                               throws IfsException

Returns indication as to whether the specified Action (which is in the process of being executed) requires additional processing after the Action is committed.

If this method returns true, a RetainedEvent will be created which will later be processed by the ExecutedActionRetainedEventAgent. This agent will process the committed Action, using a set of extensibility points within the ActivityProcessor designated for committed action processing.

Parameters:

ar - the target ActivityRecord

action - the Action being executed

Returns:

true if this Action should be further processed after its execution is committed

Throws:

IfsException - if the operation fails

validate

public final void validate()
                    throws IfsException

Validate this instance.

Throws:

IfsException - if the Processor is not defined legally

getActivitySummaryCountPositions

protected void getActivitySummaryCountPositions(List<Integer> countList)

Gets the Count Positions in effect for this class, by adding them to the specified List.

Parameters:

countList - the list that holds the set of Count Positions

getActivitySummaryIndicationPositions

protected void getActivitySummaryIndicationPositions(List<Integer> indList)

Gets the Indication Positions in effect for this class, by adding them to the specified List.

Parameters:

indList - the list that holds the set of Indication Positions

getActivitySummaryNumberPositions

protected void getActivitySummaryNumberPositions(List<Integer> numList)

Gets the Number Positions in effect for this class, by adding them to the specified List.

Parameters:

numList - the list that holds the set of Number Positions