ActionAdapter (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.core.activity.ActionFactory
- - oracle.ifs.core.activity.ActionAdapter

All Implemented Interfaces:

Action

Direct Known Subclasses:

BinaryDeviceAction, CreateAction, DeleteAction, DocumentUpdateAction, FollowAction, GatewayAction, IncludeActorAction, InviteAction, JoinAction, LikeAction, MessageAction, PostAction, RecommendAction, RsvpAction, SmartHomeAction, StateChangeAction, UpdateAction
```
public abstract class ActionAdapter
extends ActionFactory
implements Action
```
An ActionAdapter is an abstract class that implements the Action Interface, and contains common utilities used by many of its subclasses.

Constructor Summary

Constructors
Constructor and Description
`ActionAdapter()` Constructs a ActionAdapter for an instance used as an ActionFactory.
`ActionAdapter(ActionFactory factory)` Constructs a ActionAdapter to be used to execute a new Action.
`ActionAdapter(ActionFactory factory, AuditEvent event)` Constructs a FollowAction reflecting a previously executed Action.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`calculateOperationType(Integer targetCode, Integer opCode)` Calculate a numeric Operation type from a target code and operation code.
`protected void`	`dispatchEvent(AuditEventTypeDefinition eventType, ActivityRecord ar, Actor actor)` Dispatch an activity event.
`protected void`	`dispatchEvent(AuditEventTypeDefinition eventType, ActivityRecord ar, Actor actor, LibraryObject auxObj2)` Dispatch an activity event.
`protected void`	`dispatchEvent(AuditEventTypeDefinition eventType, ActivityRecord ar, Actor actor, LibraryObject auxObj2, LibraryObject auxObj3)` Dispatch an activity event.
`protected void`	`dispatchEvent(AuditEventTypeDefinition eventType, ActivityRecord ar, Actor actor, LibraryObject auxObj2, LibraryObject auxObj3, String auxString, AttributeValue[] properties)` Dispatch an activity event.
`protected abstract void`	`execute()` Perform the Action execution.
`void`	`execute(ActivityRecord ar)` Execute the action described by this instance, on the target ActivityRecord.
`void`	`execute(PublicObject po)` Execute the action described by this instance, on the target PublicObject, using this PublicObject's existing ActivityRecord context.
`ActionSpecification`	`getActionSpecification()` Gets the ActionSpecification value associated with this instance.
`Long`	`getActionSpecificationId()` Gets the ActionSpecification ID associated with this instance.
`ActivityRecord`	`getActivityRecord()` Gets the target ActivityRecord upon which this Action was executed.
`Actor`	`getActor()` Gets the Actor who executed this Action.
`long`	`getAuditEventId()` Gets the ID of the AuditEvent that reflects the execution of this Action.
`int`	`getAuditOperationType()` Gets the numeric repesentation of the operation type of the AuditEvent that reflects the execution of this Action.
`String`	`getAuditOperationTypeKey()` Gets the String key repesentation of the operation type of the AuditEvent that reflects the execution of this Action.
`LibraryObject[]`	`getAuxiliaryObjects()` Gets the auxiliary objects associated with this Action, not counting the Actor.
`String`	`getAuxiliaryString()` Gets the auxiliary String associated with this Action.
`Long`	`getExecutingUserId()` Gets the ID of the effective DirectoryUser (not the Actor) when this Action was executed.
`Date`	`getExecutionDate()` Gets the Date this Action was executed.
`LibraryObject`	`getFirstAuxiliaryObject()` Gets the first auxiliary object associated with this Action, not counting the Actor.
`static Action`	`getInstance(LibrarySession session, AuditEvent event)` Constructs a previously executed Action, using the AuditEvent as the data source.
`static Action`	`getInstance(LibrarySession session, String specName)` Constructs a pending Action, properly constructed by the factory instance for the ActionSpecification (indicated by the specified name) associated with this type of Action.
`PerformedActivityRecord`	`getPerformedActivityRecord()` Gets the PerformedActivityRecord for the Actor who is executing this Action.
`AttributeValue[]`	`getProperties()` Gets the properties associated with this Action.
`AttributeValueTable`	`getPropertyTable()` Gets the AttributeValueTable representing the set of Properties defined for the ActionSpecification associated with this instance.
`LibraryObject`	`getSecondAuxiliaryObject()` Gets the second auxiliary object associated with this Action, not counting the Actor.
`LibrarySession`	`getSession()` Gets the session context associated with this instance.
`TrackedActivityRecord`	`getTrackedActivityRecord()` Gets the TrackedActivityRecord for the Actor who is executing this Action.
`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 previously executed Action.
`boolean`	`isActorFreed()` Returns indication as to whether or not the performing Actor has been freed.
`boolean`	`isActorUndiscoverable()` Returns indication as to whether or not the performing Actor is undiscoverable by the session selecting the previously executed Action.
`boolean`	`isFactory()` Returns true is instance has been initialized as a factory instance.
`boolean`	`isPendingExecution()` Returns indication as to whether or not this instance reflects an Action that can be used to execute an Action.
`boolean`	`isPreviouslyExecuted()` Returns indication as to whether or not this instance reflects a previously executed Action.
`protected void`	`postExecute()` Handle anything after executing the Action.
`protected void`	`preExecute()` Handle anything prior to executing the Action.
`protected void`	`setExecutingActionType(AuditEventTypeDefinition eventDef)` Sets the type of Action being executed.

Methods inherited from class oracle.ifs.core.activity.ActionFactory
constructActivityEventTypeDefinition, constructExecutedAction, constructPendingAction, getAuditEventTypeDefinitions, initialize, isInitialized

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

- Constructor Detail
  - ActionAdapter
```
public ActionAdapter()
```
    Constructs a ActionAdapter for an instance used as an ActionFactory.
    Called from ActionSpecification when initializing the ActionFactory to use for that specific ActionSpecification.
  - ActionAdapter
```
public ActionAdapter(ActionFactory factory)
              throws IfsException
```
    Constructs a ActionAdapter to be used to execute a new Action.
    
    Parameters:
    
    factory - the ActionFactory used to construct this instance
    
    Throws:
    
    IfsException - if operation fails
  - ActionAdapter
```
public ActionAdapter(ActionFactory factory,
                     AuditEvent event)
              throws IfsException
```
    Constructs a FollowAction reflecting a previously executed Action.
    
    Parameters:
    
    factory - the ActionFactory used to construct this instance
    
    event - The event that was posted as part of the previously executed Action.
    
    Throws:
    
    IfsException - if operation fails
- Method Detail
  - isPreviouslyExecuted
```
public boolean isPreviouslyExecuted()
```
    Returns indication as to whether or not this instance reflects a previously executed Action.
    
    Returns:
    
    true if instance reflects a previously executed Action; false otherwise
  - isPendingExecution
```
public boolean isPendingExecution()
```
    Returns indication as to whether or not this instance reflects an Action that can be used to execute an Action.
    
    Returns:
    
    true if instance can be used to execute an Action; false otherwise
  - isFactory
```
public boolean isFactory()
```
    Returns true is instance has been initialized as a factory instance.
    
    Returns:
    
    true if instance is an initialized ActionFactory; false otherwise
  - getSession
```
public LibrarySession getSession()
```
    Gets the session context associated with this instance.
    
    Overrides:
    
    getSession in class ActionFactory
    
    Returns:
    
    the session context
  - getActionSpecification
```
public ActionSpecification getActionSpecification()
```
    Gets the ActionSpecification value associated with this instance.
    
    Overrides:
    
    getActionSpecification in class ActionFactory
    
    Returns:
    
    the ActionSpecification value
  - getActionSpecificationId
```
public Long getActionSpecificationId()
```
    Gets the ActionSpecification ID associated with this instance.
    
    Overrides:
    
    getActionSpecificationId in class ActionFactory
    
    Returns:
    
    the ActionSpecification ID
  - getPropertyTable
```
public AttributeValueTable getPropertyTable()
```
    Gets the AttributeValueTable representing the set of Properties defined for the ActionSpecification associated with this instance.
    
    Overrides:
    
    getPropertyTable in class ActionFactory
    
    Returns:
    
    the ActionSpecification property table
  - getPerformedActivityRecord
```
public PerformedActivityRecord getPerformedActivityRecord()
```
    Gets the PerformedActivityRecord for the Actor who is executing this Action.
    Only available after preExecute is processed in this class.
    
    Returns:
    
    the Actor's PerformedActivityRecord
  - getTrackedActivityRecord
```
public TrackedActivityRecord getTrackedActivityRecord()
```
    Gets the TrackedActivityRecord for the Actor who is executing this Action.
    Only available after preExecute is processed in this class.
    
    Returns:
    
    the Actor's PerformedActivityRecord
  - getActivityRecord
```
public ActivityRecord getActivityRecord()
```
    Gets the target ActivityRecord upon which this Action was executed.
    Will be null if the target ActivityRecord was freed or is undiscoverable by the session selecting the previously executed Action.
    
    Returns:
    
    the target ActivityRecord
  - 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 previously executed Action.
    
    Returns:
    
    true if target ActivityRecord is undiscoverable
  - getActor
```
public Actor getActor()
```
    Gets the Actor who executed this Action.
    Will be null if the Actor was freed or is undiscoverable by the session selecting the previously executed Action.
    
    Returns:
    
    the Actor who executed this Action
  - isActorFreed
```
public boolean isActorFreed()
```
    Returns indication as to whether or not the performing Actor has been freed.
    
    Returns:
    
    true if performing Actor has been freed.
  - isActorUndiscoverable
```
public boolean isActorUndiscoverable()
```
    Returns indication as to whether or not the performing Actor is undiscoverable by the session selecting the previously executed Action.
    
    Returns:
    
    true if performing Actor is undiscoverable
  - getAuditEventId
```
public long getAuditEventId()
```
    Gets the ID of the AuditEvent that reflects the execution of this Action.
    
    Returns:
    
    the AuditEvent ID
  - getAuditOperationType
```
public int getAuditOperationType()
```
    Gets the numeric repesentation of the operation type of the AuditEvent that reflects the execution of this Action.
    
    Returns:
    
    the numeric operation type of the AuditEvent
  - getAuditOperationTypeKey
```
public String getAuditOperationTypeKey()
```
    Gets the String key repesentation of the operation type of the AuditEvent that reflects the execution of this Action.
    
    Returns:
    
    the numeric operation type of the AuditEvent
  - getExecutionDate
```
public Date getExecutionDate()
```
    Gets the Date this Action was executed.
    
    Returns:
    
    the Date this Action was executed
  - getExecutingUserId
```
public Long getExecutingUserId()
```
    Gets the ID of the effective DirectoryUser (not the Actor) when this Action was executed.
    
    Returns:
    
    the ID of the effective DirectoryUser who executed the Action
  - getAuxiliaryObjects
```
public LibraryObject[] getAuxiliaryObjects()
```
    Gets the auxiliary objects associated with this Action, not counting the Actor.
    
    Returns:
    
    the auxiliary objects
  - getFirstAuxiliaryObject
```
public LibraryObject getFirstAuxiliaryObject()
```
    Gets the first auxiliary object associated with this Action, not counting the Actor.
    
    Returns:
    
    the first auxiliary object
  - getSecondAuxiliaryObject
```
public LibraryObject getSecondAuxiliaryObject()
```
    Gets the second auxiliary object associated with this Action, not counting the Actor.
    
    Returns:
    
    the second auxiliary object
  - getAuxiliaryString
```
public String getAuxiliaryString()
```
    Gets the auxiliary String associated with this Action.
    
    Returns:
    
    the auxiliary String associated with this Action
  - getProperties
```
public AttributeValue[] getProperties()
```
    Gets the properties associated with this Action.
    
    Returns:
    
    the properties associated with this Action
  - getInstance
```
public static Action getInstance(LibrarySession session,
                                 String specName)
                          throws IfsException
```
    Constructs a pending Action, properly constructed by the factory instance for the ActionSpecification (indicated by the specified name) associated with this type of Action.
    
    Parameters:
    
    session - session context
    
    specName - the name of the ActionSpecification.
    
    Returns:
    
    a newly constructed instance of Action
    
    Throws:
    
    IfsException - if operation fails
  - getInstance
```
public static Action getInstance(LibrarySession session,
                                 AuditEvent event)
                          throws IfsException
```
    Constructs a previously executed Action, using the AuditEvent as the data source.
    
    Parameters:
    
    session - session context
    
    event - the event reflecting the previously executed action
    
    Returns:
    
    the Action, constructed from the specified AuditEvent
    
    Throws:
    
    IfsException - if operation fails.
  - setExecutingActionType
```
protected void setExecutingActionType(AuditEventTypeDefinition eventDef)
```
    Sets the type of Action being executed.
    Called by the subclasses when it is established as to the type of Action event being posted.
    
    Parameters:
    
    eventDef - The event definition that defines the action event that will be posted when the Action is executed.
  - dispatchEvent
```
protected void dispatchEvent(AuditEventTypeDefinition eventType,
                             ActivityRecord ar,
                             Actor actor)
                      throws IfsException
```
    Dispatch an activity event.
    
    Parameters:
    
    eventType - the event type to dispatch
    
    ar - the target ActivityRecord
    
    actor - actor performing the action, stored as 1st aux object
    
    Throws:
    
    IfsException - if operation fails
  - dispatchEvent
```
protected void dispatchEvent(AuditEventTypeDefinition eventType,
                             ActivityRecord ar,
                             Actor actor,
                             LibraryObject auxObj2)
                      throws IfsException
```
    Dispatch an activity event.
    
    Parameters:
    
    eventType - the event type to dispatch
    
    ar - the target ActivityRecord
    
    actor - actor performing the action, stored as 1st aux object
    
    auxObj2 - 2nd aux object (optional)
    
    Throws:
    
    IfsException - if operation fails
  - dispatchEvent
```
protected void dispatchEvent(AuditEventTypeDefinition eventType,
                             ActivityRecord ar,
                             Actor actor,
                             LibraryObject auxObj2,
                             LibraryObject auxObj3)
                      throws IfsException
```
    Dispatch an activity event.
    
    Parameters:
    
    eventType - the event type to dispatch
    
    ar - the target ActivityRecord
    
    actor - actor performing the action, stored as 1st aux object
    
    auxObj2 - 2nd aux object (optional)
    
    auxObj3 - 3rd aux object (optional)
    
    Throws:
    
    IfsException - if operation fails
  - dispatchEvent
```
protected void dispatchEvent(AuditEventTypeDefinition eventType,
                             ActivityRecord ar,
                             Actor actor,
                             LibraryObject auxObj2,
                             LibraryObject auxObj3,
                             String auxString,
                             AttributeValue[] properties)
                      throws IfsException
```
    Dispatch an activity event.
    
    Parameters:
    
    eventType - the event type to dispatch
    
    ar - the target ActivityRecord
    
    actor - actor performing the action, stored as 1st aux object
    
    auxObj2 - 2nd aux object (optional)
    
    auxObj3 - 3rd aux object (optional)
    
    auxString - the aux String (optional)
    
    properties - set of event properties (optional)
    
    Throws:
    
    IfsException - if operation fails
  - execute
```
public void execute(PublicObject po)
             throws IfsException
```
    Execute the action described by this instance, on the target PublicObject, using this PublicObject's existing ActivityRecord context.
    
    Specified by:
    
    execute in interface Action
    
    Parameters:
    
    po - The target PublicObject (use its ActivityRecord)
    
    Throws:
    
    IfsException - if the operation fails.
  - execute
```
public void execute(ActivityRecord ar)
             throws IfsException
```
    Execute the action described by this instance, on the target ActivityRecord.
    
    Specified by:
    
    execute in interface Action
    
    Parameters:
    
    ar - The target ActivityRecord
    
    Throws:
    
    IfsException - if the operation fails.
  - preExecute
```
protected void preExecute()
                   throws IfsException
```
    Handle anything prior to executing the Action.
    This is called prior to invoking execute.
    
    Throws:
    
    IfsException - if the operation fails.
  - execute
```
protected abstract void execute()
                         throws IfsException
```
    Perform the Action execution.
    This is called after first invoking preExecute and before invoking postExecute.
    
    Throws:
    
    IfsException - if the operation fails.
  - postExecute
```
protected void postExecute()
                    throws IfsException
```
    Handle anything after executing the Action.
    This is called after invoking execute.
    
    Throws:
    
    IfsException - if the operation fails.
  - calculateOperationType
```
public static int calculateOperationType(Integer targetCode,
                                         Integer opCode)
```
    Calculate a numeric Operation type from a target code and operation code.
    
    Parameters:
    
    targetCode - target code
    
    opCode - operation code
    
    Returns:
    
    the computed Operation type

Class ActionAdapter

Constructor Summary

Method Summary

Methods inherited from class oracle.ifs.core.activity.ActionFactory

Methods inherited from class java.lang.Object

Constructor Detail

ActionAdapter

ActionAdapter

ActionAdapter

Method Detail

isPreviouslyExecuted

isPendingExecution

isFactory

getSession

getActionSpecification

getActionSpecificationId

getPropertyTable

getPerformedActivityRecord

getTrackedActivityRecord

getActivityRecord

isActivityRecordFreed

isActivityRecordUndiscoverable

getActor

isActorFreed

isActorUndiscoverable

getAuditEventId

getAuditOperationType

getAuditOperationTypeKey

getExecutionDate

getExecutingUserId

getAuxiliaryObjects

getFirstAuxiliaryObject

getSecondAuxiliaryObject

getAuxiliaryString

getProperties

getInstance

getInstance

setExecutingActionType

dispatchEvent

dispatchEvent

dispatchEvent

dispatchEvent

execute

execute

preExecute

execute

postExecute

calculateOperationType