Skip navigation links

Oracle Content Database Web Services Java API Reference
10g Release 1 (10.2)

B31408-02


oracle.ifs.fdk
Interface EventHandlerContext


public interface EventHandlerContext

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

getSession

public FdkSession getSession()
Returns the session context to use for processing.
Returns:
the FdkSession for processing

getAuditHistoryId

public java.lang.Long getAuditHistoryId()
Returns the custom Audit History ID where Events are posted. Use this ID when using AuditManager.searchAuditHistory() to find Events that occurred.
Returns:
the ID of the Audit History

getAuditHistoryProperty

public NamedValue getAuditHistoryProperty(java.lang.String key)
                                   throws FdkException
Gets a property of the custom Audit History by its property name.
Parameters:
key - the Audit History property key
Returns:
the property value, or null if not defined
Throws:
FdkException - if the operation fails

setAuditHistoryProperty

public void setAuditHistoryProperty(java.lang.String key,
                                    NamedValue value)
                             throws FdkException
Sets a property of the custom Audit history.
Parameters:
key - the Audit History property key
value - the Audit History property value
Throws:
FdkException - if the operation fails

setDomain

public void setDomain(long domainId)
               throws FdkException
Sets the Domain that should be used while processing an Event. By default, this is the default Domain.

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".

Parameters:
domainId - the ID of the Domain to use while processing an Event or zero to clear the previously established Domain context
Throws:
FdkException - if the operation fails

restartEventHandler

public void restartEventHandler()
                         throws FdkException
Causes a reset of the handler settings.
Throws:
FdkException - if the operation fails

purgeEvent

public void purgeEvent(Event event)
                throws FdkException
Purges an Event from its audit history.
Parameters:
event - the Event to purge
Throws:
FdkException - if the operation fails

purgeEvents

public void purgeEvents(Event[] events)
                 throws FdkException
Purges a set of Events from their audit histories.
Parameters:
events - the Events to purge
Throws:
FdkException - if the operation fails

Skip navigation links

Oracle Content Database Web Services Java API Reference
10g Release 1 (10.2)

B31408-02


Copyright © 2002, 2006, Oracle. All rights reserved.