Event (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.fdk.Event

All Implemented Interfaces:

Serializable
```
public class Event
extends Object
implements Serializable
```
Models an event that occurred; events can be audited and then retrieved by querying an audit history.

Author:

Luis Saenz

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Event()` Constructs an Event.
`Event(long id, long sessId, long appSessId, String opType, Date createDate, long creatorId, long sessionUserId, long domainId, boolean success, long targetId, long[] auxTargetIds, long[] auxTargetTypeIds, String appUser, String appContext, String auxString, Long auxNumber, NamedValue[] properties)` Constructs an Event.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getApplicationContext()` Returns the Application Context identifier in effect on the session that performed the operation that resulted in creating this Event.
`long`	`getApplicationSessionId()` Returns the ID of the application session context (if any) used to perform the operation that resulted in creating this Event.
`String`	`getApplicationUser()` Returns the Application User identifier in effect on the session that performed the operation that resulted in creating this Event.
`Long`	`getAuxiliaryNumber()` Returns the auxiliary number associated with this Event.
`String`	`getAuxiliaryString()` Returns the auxiliary string associated with this Event.
`long[]`	`getAuxTargetIds()` Returns the IDs of the auxiliary Items associated with this Event.
`long[]`	`getAuxTargetTypeIds()` Returns the internal IDs used to identify the types of the auxiliary Items associated with this Event.
`Date`	`getCreateDate()` Returns the Date this Event was created.
`long`	`getCreatorId()` Returns the ID of the User Item that performed the operation that resulted in creating this Event.
`long`	`getDomainId()` Returns the ID of the Domain Item with which this Event is associated.
`long`	`getId()` Returns this Event's ID.
`String`	`getOperationType()` Returns this Event's operation type key.
`NamedValue[]`	`getProperties()` Returns the auxiliary properties associated with this Event.
`long`	`getSessionId()` Returns the ID of the server session used to perform the operation that resulted in creating this Event.
`long`	`getSessionUserId()` Returns the ID of the User Item that performed the operation that resulted in creating this Event.
`long`	`getTargetId()` Returns the ID of the target Item with which this Event is associated.
`boolean`	`isOperationSuccessful()` Returns an indication as to whether the operation sttempted which resulted in the creation of this Event actually succeeded.
`void`	`setApplicationContext(String applicationContext)` Always throws a RuntimeException.
`void`	`setApplicationSessionId(long appSessionId)` Always throws a RuntimeException.
`void`	`setApplicationUser(String applicationUser)` Always throws a RuntimeException.
`void`	`setAuxiliaryNumber(Long auxNumber)` Always throws a RuntimeException.
`void`	`setAuxiliaryString(String auxString)` Always throws a RuntimeException.
`void`	`setAuxTargetIds(long[] auxTargetIds)` Always throws a RuntimeException.
`void`	`setAuxTargetTypeIds(long[] auxTargetTypeIds)` Always throws a RuntimeException.
`void`	`setCreateDate(Date createDate)` Always throws a RuntimeException.
`void`	`setCreatorId(long creatorId)` Always throws a RuntimeException.
`void`	`setDomainId(long domainId)` Always throws a RuntimeException.
`void`	`setId(long id)` Always throws a RuntimeException.
`void`	`setOperationSuccessful(boolean opSuccessful)` Always throws a RuntimeException.
`void`	`setOperationType(String operationType)` Always throws a RuntimeException.
`void`	`setProperties(NamedValue[] properties)` Always throws a RuntimeException.
`void`	`setSessionId(long sessionId)` Always throws a RuntimeException.
`void`	`setSessionUserId(long sessionUserId)` Always throws a RuntimeException.
`void`	`setTargetId(long targetId)` Always throws a RuntimeException.

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

- Constructor Detail
  - Event
```
public Event()
```
    Constructs an Event.
  - Event
```
public Event(long id,
             long sessId,
             long appSessId,
             String opType,
             Date createDate,
             long creatorId,
             long sessionUserId,
             long domainId,
             boolean success,
             long targetId,
             long[] auxTargetIds,
             long[] auxTargetTypeIds,
             String appUser,
             String appContext,
             String auxString,
             Long auxNumber,
             NamedValue[] properties)
```
    Constructs an Event. Used internally.
    
    (Unpublished)
- Method Detail
  - getId
```
public long getId()
```
    Returns this Event's ID.
    
    Returns:
    
    the audit identifier
  - getSessionId
```
public long getSessionId()
```
    Returns the ID of the server session used to perform the operation that resulted in creating this Event.
    
    Returns:
    
    the session ID
  - getApplicationSessionId
```
public long getApplicationSessionId()
```
    Returns the ID of the application session context (if any) used to perform the operation that resulted in creating this Event.
    Returns 0 if the operation was performed without an application context.
    
    Returns:
    
    the application session context ID
  - getOperationType
```
public String getOperationType()
```
    Returns this Event's operation type key.
    
    Returns:
    
    the Event operation type key
  - getCreateDate
```
public Date getCreateDate()
```
    Returns the Date this Event was created.
    
    Returns:
    
    the create Date
  - getCreatorId
```
public long getCreatorId()
```
    Returns the ID of the User Item that performed the operation that resulted in creating this Event.
    
    Returns:
    
    the creator ID
  - getSessionUserId
```
public long getSessionUserId()
```
    Returns the ID of the User Item that performed the operation that resulted in creating this Event.
    Can be different from the creator ID if the session which caused the event to be created was switched into administration mode, or if the operation was performed on behalf of the user in an asynchronous process, such as in a workflow or agent.
    
    Returns:
    
    the session user ID
  - getDomainId
```
public long getDomainId()
```
    Returns the ID of the Domain Item with which this Event is associated.
    
    Returns:
    
    the Domain Item ID
  - isOperationSuccessful
```
public boolean isOperationSuccessful()
```
    Returns an indication as to whether the operation sttempted which resulted in the creation of this Event actually succeeded.
    
    Returns:
    
    true if the operation represented by this Event completed successfully; false otherwise
  - getTargetId
```
public long getTargetId()
```
    Returns the ID of the target Item with which this Event is associated.
    
    Returns:
    
    the target Item ID
  - getAuxTargetIds
```
public long[] getAuxTargetIds()
```
    Returns the IDs of the auxiliary Items associated with this Event.
    
    Returns:
    
    the auxiliary Item IDs
  - getAuxTargetTypeIds
```
public long[] getAuxTargetTypeIds()
```
    Returns the internal IDs used to identify the types of the auxiliary Items associated with this Event.
    
    Returns:
    
    the auxiliary Item's type IDs
  - getApplicationUser
```
public String getApplicationUser()
```
    Returns the Application User identifier in effect on the session that performed the operation that resulted in creating this Event.
    
    Returns:
    
    the Application User name
  - getApplicationContext
```
public String getApplicationContext()
```
    Returns the Application Context identifier in effect on the session that performed the operation that resulted in creating this Event.
    
    Returns:
    
    the Application Context string
  - getAuxiliaryString
```
public String getAuxiliaryString()
```
    Returns the auxiliary string associated with this Event.
    
    Returns:
    
    the auxiliary string
  - getAuxiliaryNumber
```
public Long getAuxiliaryNumber()
```
    Returns the auxiliary number associated with this Event.
    
    Returns:
    
    the auxiliary number
  - getProperties
```
public NamedValue[] getProperties()
```
    Returns the auxiliary properties associated with this Event.
    
    Returns:
    
    the auxiliary event properties
  - setId
```
public void setId(long id)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setSessionId
```
public void setSessionId(long sessionId)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setApplicationSessionId
```
public void setApplicationSessionId(long appSessionId)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setOperationType
```
public void setOperationType(String operationType)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setCreateDate
```
public void setCreateDate(Date createDate)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setCreatorId
```
public void setCreatorId(long creatorId)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setSessionUserId
```
public void setSessionUserId(long sessionUserId)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setDomainId
```
public void setDomainId(long domainId)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setOperationSuccessful
```
public void setOperationSuccessful(boolean opSuccessful)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setTargetId
```
public void setTargetId(long targetId)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setAuxTargetIds
```
public void setAuxTargetIds(long[] auxTargetIds)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setAuxTargetTypeIds
```
public void setAuxTargetTypeIds(long[] auxTargetTypeIds)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setApplicationUser
```
public void setApplicationUser(String applicationUser)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setApplicationContext
```
public void setApplicationContext(String applicationContext)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setAuxiliaryString
```
public void setAuxiliaryString(String auxString)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setAuxiliaryNumber
```
public void setAuxiliaryNumber(Long auxNumber)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)
  - setProperties
```
public void setProperties(NamedValue[] properties)
```
    Always throws a RuntimeException. Method needs to be here in order for the object to be a Java Bean.
    
    Throws:
    
    RuntimeException - Always.
    
    (Unpublished)

Class Event

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Event

Event

Method Detail

getId

getSessionId

getApplicationSessionId

getOperationType

getCreateDate

getCreatorId

getSessionUserId

getDomainId

isOperationSuccessful

getTargetId

getAuxTargetIds

getAuxTargetTypeIds

getApplicationUser

getApplicationContext

getAuxiliaryString

getAuxiliaryNumber

getProperties

setId

setSessionId

setApplicationSessionId

setOperationType

setCreateDate

setCreatorId

setSessionUserId

setDomainId

setOperationSuccessful

setTargetId

setAuxTargetIds

setAuxTargetTypeIds

setApplicationUser

setApplicationContext

setAuxiliaryString

setAuxiliaryNumber

setProperties