|
Oracle Content Database Web Services Java API Reference 10g Release 1 (10.2) B31408-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Processing context used by EventHandler implementations.
Method Summary | |
java.lang.Long |
getAuditHistoryId() Returns the custom Audit History ID where Events are posted. |
NamedValue |
getAuditHistoryProperty(java.lang.String key) Gets a property of the custom Audit History by its property name. |
FdkSession |
getSession() Returns the session context to use for processing. |
void |
purgeEvent(Event event) Purges an Event from its audit history. |
void |
purgeEvents(Event[] events) Purges a set of Events from their audit histories. |
void |
restartEventHandler() Causes a reset of the handler settings. |
void |
setAuditHistoryProperty(java.lang.String key, NamedValue value) Sets a property of the custom Audit history. |
void |
setDomain(long domainId) Sets the Domain that should be used while processing an Event. |
Method Detail |
public FdkSession getSession()
public java.lang.Long getAuditHistoryId()
public NamedValue getAuditHistoryProperty(java.lang.String key) throws FdkException
key
- the Audit History property keyFdkException
- if the operation failspublic void setAuditHistoryProperty(java.lang.String key, NamedValue value) throws FdkException
key
- the Audit History property keyvalue
- the Audit History property valueFdkException
- if the operation failspublic void setDomain(long domainId) throws FdkException
In a multi-Domain instance, this must be set to the ID of the Domain for the Event that is being processed, because an EventHandler will be invoked for Events that have occurred in any Domain in the instance.
A value of zero for the Domain ID will effectively clear the previously established Domain context.
Note that a Domain is sometimes referred to as a "Site".
domainId
- the ID of the Domain to use while processing an Event or zero to clear the previously established Domain contextFdkException
- if the operation failspublic void restartEventHandler() throws FdkException
FdkException
- if the operation failspublic void purgeEvent(Event event) throws FdkException
event
- the Event to purgeFdkException
- if the operation failspublic void purgeEvents(Event[] events) throws FdkException
events
- the Events to purgeFdkException
- if the operation fails
|
Oracle Content Database Web Services Java API Reference 10g Release 1 (10.2) B31408-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |