oracle.bpm.casemgmt
Interface ICaseEventService

All Known Subinterfaces:

ICaseService

public interface ICaseEventService

Interface defines APIs related to case events

Method Summary

CaseObjectsList	getAudit(IBPMContext context, CaseIdentifier caseIdentifier, TEventType eventType, java.lang.String updatedBy, int pageSize, int pageNumber) Get an audit of all the events that have happened in the case instance Example usage is below.
boolean	raiseCaseEvent(IBPMContext context, CaseIdentifier caseIdentifier, CaseEvent event) Raise a case event

Method Detail

raiseCaseEvent

boolean raiseCaseEvent(IBPMContext context,
                       CaseIdentifier caseIdentifier,
                       CaseEvent event)
                       throws CaseServiceException

Raise a case event

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

event - a CaseEvent value

Returns:

a boolean value

Throws:

CaseServiceException - if an error occurs

getAudit

CaseObjectsList getAudit(IBPMContext context,
                         CaseIdentifier caseIdentifier,
                         TEventType eventType,
                         java.lang.String updatedBy,
                         int pageSize,
                         int pageNumber)
                         throws CaseServiceException

Get an audit of all the events that have happened in the case instance Example usage is below.

 import java.util.Collection;
 import java.util.List;
 import oracle.bpel.services.bpm.common.IBPMContext;
 import oracle.bpm.casemgmt.CaseIdentifier;
 import oracle.bpm.casemgmt.CaseObjectsList;
 import oracle.bpm.casemgmt.ICaseService;
 import oracle.bpm.casemgmt.persistence.model.CaseEvent;
 import oracle.bpm.casemgmt.persistence.model.PropertyBag;
 import oracle.bpm.casemgmt.metadata.event.model.TEventType;
 import oracle.bpm.client.BPMServiceClientFactory"
 ...


        IBPMContext context = ..;
        CaseIdentifier caseIdentifier = ..;
        ICaseService caseService = ..;

        TEventType eventType = null;

        // event types is one of the following
        eventType = TEventType.ACTIVITY_EVENT;
        eventType = TEventType.LIFECYCLE_EVENT;
        eventType = TEventType.DOCUMENT_EVENT;
        eventType = TEventType.COMMENT_EVENT;
        eventType = TEventType.USER_DEFINED_EVENT;

        int pageNum = ..;
        int pageSize = ..;
        String updatedBy = ..;

        CaseObjectsList caseObjectsList =
            caseService.getAudit(context, caseIdentifier, eventType, updatedBy, pageSize, pageNum);
        List<CaseEvent> persistedEvents = caseObjectsList.getCaseObjects();
        int totalEntries = caseObjectsList.getTotalNumberOfCaseObjects();

        int nEvents = persistedEvents.size();
        for (CaseEvent ce: persistedEvents)
        {
            String updatedBy = ce.getUpdatedBy();
            String displayName = ce.getDisplayName();
            String comment = (ce.getComment() != null) ? ce.getComment().getCaseObjectComment() : null;
            String eventType = ce.getEventType().toString();
        }

 
 

Parameters:

context - an IBPMContext value

caseIdentifier - a CaseIdentifier value

eventType - a TEventType value

updatedBy - a String value

pageSize - a int value

pageNumber - a int value

Returns:

a CaseObjectsList value

Throws:

CaseServiceException - if an error occurs