ActivitySummary (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.core.activity.ActivitySummary

```
public class ActivitySummary
extends Object
```
An ActivitySummary holds the raw data to represent the Activity summary for a single ActivityRecord, either for all Actors or for a single Actor.

Author:

Dave Long

(Published)

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MAX_BOOLEAN_POSITIONS` The Max size for summary boolean indicators (which are less common).
`static int`	`MAX_COUNT_POSITIONS` The Max size for summary counts.
`static int`	`MAX_NUMBER_POSITIONS` The Max size for summary number values (which are less common).
`static String[]`	`PERFORMEDACTIVITYRECORD_COUNT_COLUMNS` The column names in PerformedActivityRecord tables that correspond to the count array.
`static String[]`	`PERFORMEDACTIVITYRECORD_INDICATION_COLUMNS` The column names in PerformedActivityRecord tables that correspond to the indication array.
`static String[]`	`PERFORMEDACTIVITYRECORD_NUMBER_COLUMNS` The column names in PerformedActivityRecord tables that correspond to the number array.

Constructor Summary

Constructors
Constructor and Description
`ActivitySummary(ActivityProcessor proc)` Constructs a ActivitySummary.
`ActivitySummary(ActivityProcessor proc, String tableName, long summId)` Constructs a ActivitySummary that is (or will be) persistent in a summary table.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addActivitySummaryDelta(ActivitySummary deltaSumm)` Add a summary delta to this ActivitySummary.
`static ActivitySummary`	`calculateActivitySummaryDelta(ActivitySummary leftSumm, ActivitySummary rightSumm)` Calculate a summary delta from two ActivitySummary objects.
`void`	`clearIndication(int pos)` Clears (assign false value) the boolean indicator at the specified position.
`void`	`decrementCount(int pos)` Decrement the count at the specified position.
`static ActivitySummary`	`derivePreviousActivitySummary(ActivityRecord ar, ActionAdapter lastAction)` Derive a previous ActivitySummary state for the specified ActivityRecord for Actions up to and including the specified Action.
`int`	`getActionCount()` Gets the total count of Actions performed.
`ActivityProcessor`	`getActivityProcessor()` Returns the ActivityProcessor context.
`int`	`getCount(int pos)` Gets the count at the specified position.
`Boolean`	`getIndication(int pos)` Gets the boolean indication value at the specified position.
`Long`	`getNumber(int pos)` Gets the number value at the specified position.
`String`	`getPerformedActivityRecordUpdateClause()` Get the update clause to use in updating the PerformedActivityRecord.
`String`	`getPerformedActivityRecordUpdateClause(boolean resetAfterAccess)` Get the update clause to use in updating the PerformedActivityRecord.
`LibrarySession`	`getSession()` Returns the session context, if the instance is constructed with a non-null ActivityProcessor.
`long`	`getSummaryId()` Returns the Summary ID value in the summary table name that is holding this record (if any).
`String`	`getSummaryTableName()` Returns the name of the summary table name that is holding this summary (if any).
`void`	`incrementActionCount()` Increment the total Action count by 1.
`void`	`incrementActionCount(int incAmount)` Increment the total Action count by the specified amount.
`void`	`incrementCount(int pos)` Increment the count at the specified position by 1.
`void`	`incrementCount(int pos, int incAmount)` Increment the count at the specified position by the specified amount.
`protected void`	`insert(IfsConnection conn)` Inserts a summary record into the summary table specified at construction time, using the summary ID value specified at construction time.
`void`	`overwriteActivitySummary(ActivitySummary sourceSumm)` Overwrite the target with values from the specified ActivitySummary.
`void`	`setActionCount(int count)` Sets the total count of Actions performed..
`void`	`setCount(int pos, int count)` Set the count at the specified position.
`void`	`setIndication(int pos)` Sets the boolean indicator at the specified position.
`void`	`setIndication(int pos, boolean val)` Sets the boolean indicator at the specified position to the value specified.
`void`	`setIndication(int pos, Boolean val)` Sets the boolean indicator at the specified position to the value specified.
`void`	`setNumber(int pos, long val)` Sets the number at the specified position to the value specified.
`void`	`setNumber(int pos, Long val)` Sets the number at the specified position to the value specified.
`void`	`setSummaryTableInfo(String tableName, long summId)` Sets the ID and table information to be used for persisting the ActivitySummary.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MAX_COUNT_POSITIONS
```
public static final int MAX_COUNT_POSITIONS
```
    The Max size for summary counts.
    
    See Also:
    
    Constant Field Values
  - MAX_BOOLEAN_POSITIONS
```
public static final int MAX_BOOLEAN_POSITIONS
```
    The Max size for summary boolean indicators (which are less common).
    
    See Also:
    
    Constant Field Values
  - MAX_NUMBER_POSITIONS
```
public static final int MAX_NUMBER_POSITIONS
```
    The Max size for summary number values (which are less common).
    
    See Also:
    
    Constant Field Values
  - PERFORMEDACTIVITYRECORD_COUNT_COLUMNS
```
public static final String[] PERFORMEDACTIVITYRECORD_COUNT_COLUMNS
```
    The column names in PerformedActivityRecord tables that correspond to the count array.
  - PERFORMEDACTIVITYRECORD_INDICATION_COLUMNS
```
public static final String[] PERFORMEDACTIVITYRECORD_INDICATION_COLUMNS
```
    The column names in PerformedActivityRecord tables that correspond to the indication array.
  - PERFORMEDACTIVITYRECORD_NUMBER_COLUMNS
```
public static final String[] PERFORMEDACTIVITYRECORD_NUMBER_COLUMNS
```
    The column names in PerformedActivityRecord tables that correspond to the number array.
- Constructor Detail
  - ActivitySummary
```
public ActivitySummary(ActivityProcessor proc)
```
    Constructs a ActivitySummary.
    
    Parameters:
    
    proc - the ActivityProcessor that will produce and interpret this instance
  - ActivitySummary
```
public ActivitySummary(ActivityProcessor proc,
                       String tableName,
                       long summId)
```
    Constructs a ActivitySummary that is (or will be) persistent in a summary table.
    
    Parameters:
    
    proc - the ActivityProcessor that will produce and interpret this instance; can be null
    
    tableName - the table that will hold the summary record
    
    summId - the summary ID (obtained from a sequence)
- Method Detail
  - setSummaryTableInfo
```
public void setSummaryTableInfo(String tableName,
                                long summId)
```
    Sets the ID and table information to be used for persisting the ActivitySummary.
    
    Parameters:
    
    tableName - the table that will hold the summary record
    
    summId - the summary ID (obtained from a sequence)
  - insert
```
protected void insert(IfsConnection conn)
               throws IfsException,
                      SQLException
```
    Inserts a summary record into the summary table specified at construction time, using the summary ID value specified at construction time.
    
    Parameters:
    
    conn - the connection context
    
    Throws:
    
    IfsException - if the operation fails
    
    SQLException - if the operation fails
  - getActivityProcessor
```
public ActivityProcessor getActivityProcessor()
```
    Returns the ActivityProcessor context.
    
    Returns:
    
    the ActivityProcessor context.
  - getSession
```
public LibrarySession getSession()
```
    Returns the session context, if the instance is constructed with a non-null ActivityProcessor.
    
    Returns:
    
    the session context, or null if this instance was not constructed with a non-null ActivityProcessor
  - getSummaryTableName
```
public String getSummaryTableName()
```
    Returns the name of the summary table name that is holding this summary (if any).
    
    Returns:
    
    the summary table name.
  - getSummaryId
```
public long getSummaryId()
```
    Returns the Summary ID value in the summary table name that is holding this record (if any).
    
    Returns:
    
    the summary ID value
  - getActionCount
```
public int getActionCount()
```
    Gets the total count of Actions performed.
    
    Returns:
    
    the total count of Actions
  - setActionCount
```
public void setActionCount(int count)
```
    Sets the total count of Actions performed..
    
    Parameters:
    
    count - the value to set
  - incrementActionCount
```
public void incrementActionCount()
```
    Increment the total Action count by 1.
  - incrementActionCount
```
public void incrementActionCount(int incAmount)
```
    Increment the total Action count by the specified amount.
    
    Parameters:
    
    incAmount - the amount to increment; a negative number implies a decrement
  - getCount
```
public int getCount(int pos)
```
    Gets the count at the specified position.
    
    Parameters:
    
    pos - the position in the count array
    
    Returns:
    
    the count value at that position
  - getIndication
```
public Boolean getIndication(int pos)
```
    Gets the boolean indication value at the specified position.
    
    Parameters:
    
    pos - the position in the boolean indication array
    
    Returns:
    
    the boolean indication value at that position; a null value indicates no setting
  - getNumber
```
public Long getNumber(int pos)
```
    Gets the number value at the specified position.
    
    Parameters:
    
    pos - the position in the number array
    
    Returns:
    
    the number value at that position; a null value indicates no setting
  - setCount
```
public void setCount(int pos,
                     int count)
```
    Set the count at the specified position.
    
    Parameters:
    
    pos - the position in the count array to set
    
    count - the value to set
  - incrementCount
```
public void incrementCount(int pos)
```
    Increment the count at the specified position by 1.
    
    Parameters:
    
    pos - the position in the count array to increment
  - incrementCount
```
public void incrementCount(int pos,
                           int incAmount)
```
    Increment the count at the specified position by the specified amount.
    The amount can be a negative number.
    
    Parameters:
    
    pos - the position in the count array to increment
    
    incAmount - the amount to increment; a negative number implies a decrement
  - decrementCount
```
public void decrementCount(int pos)
```
    Decrement the count at the specified position.
    
    Parameters:
    
    pos - the position in the count array to decrement
  - setIndication
```
public void setIndication(int pos,
                          Boolean val)
```
    Sets the boolean indicator at the specified position to the value specified.
    
    Parameters:
    
    pos - the position in the boolean array to set
    
    val - the value to set; a null value indicates no setting
  - setIndication
```
public void setIndication(int pos,
                          boolean val)
```
    Sets the boolean indicator at the specified position to the value specified.
    
    Parameters:
    
    pos - the position in the boolean array to set
    
    val - the value to set
  - setIndication
```
public void setIndication(int pos)
```
    Sets the boolean indicator at the specified position.
    
    Parameters:
    
    pos - the position in the boolean array to set
  - clearIndication
```
public void clearIndication(int pos)
```
    Clears (assign false value) the boolean indicator at the specified position.
    
    Parameters:
    
    pos - the position in the boolean array to clear
  - setNumber
```
public void setNumber(int pos,
                      Long val)
```
    Sets the number at the specified position to the value specified.
    
    Parameters:
    
    pos - the position in the number array to set
    
    val - the value to set; a null value indicates no setting
  - setNumber
```
public void setNumber(int pos,
                      long val)
```
    Sets the number at the specified position to the value specified.
    
    Parameters:
    
    pos - the position in the number array to set
    
    val - the value to set
  - calculateActivitySummaryDelta
```
public static ActivitySummary calculateActivitySummaryDelta(ActivitySummary leftSumm,
                                                            ActivitySummary rightSumm)
                                                     throws IfsException
```
    Calculate a summary delta from two ActivitySummary objects.
    The delta is calculated as leftSumm - rightSumm.
    
    Parameters:
    
    leftSumm - the "left" ActivitySummary in the equation
    
    rightSumm - the "right" ActivitySummary in the equation
    
    Returns:
    
    the ActivitySummary representing the difference between the two specified ActivitySummary objects
    
    Throws:
    
    IfsException - if the operation fails.
  - addActivitySummaryDelta
```
public void addActivitySummaryDelta(ActivitySummary deltaSumm)
                             throws IfsException
```
    Add a summary delta to this ActivitySummary.
    
    Parameters:
    
    deltaSumm - ActivitySummary delta to add to the summary
    
    Throws:
    
    IfsException - if the operation fails.
  - overwriteActivitySummary
```
public void overwriteActivitySummary(ActivitySummary sourceSumm)
                              throws IfsException
```
    Overwrite the target with values from the specified ActivitySummary.
    
    Parameters:
    
    sourceSumm - ActivitySummary that contains the values to overwrite
    
    Throws:
    
    IfsException - if the operation fails.
  - getPerformedActivityRecordUpdateClause
```
public String getPerformedActivityRecordUpdateClause()
```
    Get the update clause to use in updating the PerformedActivityRecord.
    
    Returns:
    
    the update clause to use in updating the PerformedActivityRecord
  - getPerformedActivityRecordUpdateClause
```
public String getPerformedActivityRecordUpdateClause(boolean resetAfterAccess)
```
    Get the update clause to use in updating the PerformedActivityRecord.
    
    Parameters:
    
    resetAfterAccess - if true, resets the clause before returning
    
    Returns:
    
    the update clause to use in updating the PerformedActivityRecord
  - derivePreviousActivitySummary
```
public static ActivitySummary derivePreviousActivitySummary(ActivityRecord ar,
                                                            ActionAdapter lastAction)
                                                     throws IfsException
```
    Derive a previous ActivitySummary state for the specified ActivityRecord for Actions up to and including the specified Action.
    
    Parameters:
    
    ar - the ActivityRecord whose previous state is to be derived
    
    lastAction - the last action to be included in the derived ActivitySummary
    
    Returns:
    
    the derived ActivitySummary
    
    Throws:
    
    IfsException - if the operation fails.

Class ActivitySummary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_COUNT_POSITIONS

MAX_BOOLEAN_POSITIONS

MAX_NUMBER_POSITIONS

PERFORMEDACTIVITYRECORD_COUNT_COLUMNS

PERFORMEDACTIVITYRECORD_INDICATION_COLUMNS

PERFORMEDACTIVITYRECORD_NUMBER_COLUMNS

Constructor Detail

ActivitySummary

ActivitySummary

Method Detail

setSummaryTableInfo

insert

getActivityProcessor

getSession

getSummaryTableName

getSummaryId

getActionCount

setActionCount

incrementActionCount

incrementActionCount

getCount

getIndication

getNumber

setCount

incrementCount

incrementCount

decrementCount

setIndication

setIndication

setIndication

clearIndication

setNumber

setNumber

calculateActivitySummaryDelta

addActivitySummaryDelta

overwriteActivitySummary

getPerformedActivityRecordUpdateClause

getPerformedActivityRecordUpdateClause

derivePreviousActivitySummary