com.wewebu.ow.server.event
Interface OwEventManager

All Known Subinterfaces:
OwHistoryManager
All Known Implementing Classes:
OwSimpleHistoryManager, OwStandardHistoryManager

public interface OwEventManager

Interface for adding events to a database. Base class of the history manager to add new events to the database

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com


Field Summary
static String HISTORY_EVENT_ID_COPY_OBJECT
          event type to be used in addEvent: generated for new object events
static String HISTORY_EVENT_ID_DOWNLOAD
          event type to be used in addEvent: generated for OwObject access events
static String HISTORY_EVENT_ID_LOGIN
          event type to be used in addEvent: generated for login events
static String HISTORY_EVENT_ID_LOGOFF
          event type to be used in addEvent: generated for logoff events
static String HISTORY_EVENT_ID_NEW_OBJECT
          event type to be used in addEvent: generated for new object events
static String HISTORY_EVENT_ID_OBJECT_ADD
          event type to be used in addEvent: generated for OwObject access events
static String HISTORY_EVENT_ID_OBJECT_CANCELCHECKOUT
          event type to be used in addEvent: generated for OwObject DMS events
static String HISTORY_EVENT_ID_OBJECT_CHECKIN
          event type to be used in addEvent: generated for OwObject DMS events
static String HISTORY_EVENT_ID_OBJECT_CHECKOUT
          event type to be used in addEvent: generated for OwObject DMS events
static String HISTORY_EVENT_ID_OBJECT_DELETE
          event type to be used in addEvent: generated for OwObject access events
static String HISTORY_EVENT_ID_OBJECT_DEMOTE
          event type to be used in addEvent: generated for OwObject DMS events
static String HISTORY_EVENT_ID_OBJECT_DISPATCH
          event type to be used in addEvent: generated for workflow objects
static String HISTORY_EVENT_ID_OBJECT_GENERIC
          event type to be used in addEvent: generic event
static String HISTORY_EVENT_ID_OBJECT_LOCK
          event type to be used in addEvent: generated for OwObject access events
static String HISTORY_EVENT_ID_OBJECT_MODIFY_ANNOTATIONS
          event type to be used in addEvent: generated for OwObject property events
static String HISTORY_EVENT_ID_OBJECT_MODIFY_PERMISSIONS
          event type to be used in addEvent: generated for OwObject property events
static String HISTORY_EVENT_ID_OBJECT_MODIFY_PROPERTIES
          event type to be used in addEvent: generated for OwObject property events
static String HISTORY_EVENT_ID_OBJECT_MOVE
          event type to be used in addEvent: generated for OwObject access events
static String HISTORY_EVENT_ID_OBJECT_PROMOTE
          event type to be used in addEvent: generated for OwObject DMS events
static String HISTORY_EVENT_ID_OBJECT_REMOVE_REF
          event type to be used in addEvent: generated for OwObject access events
static String HISTORY_EVENT_ID_OBJECT_RESUBMIT
          event type to be used in addEvent: generated if a object is resubmitted
static String HISTORY_EVENT_ID_OBJECT_RETURN_TO_SOURCE
          event type to be used in addEvent: generated for workflow objects
static String HISTORY_EVENT_ID_SEARCH
          event type to be used in addEvent: generated for search events
static String HISTORY_EVENT_ID_UPLOAD
          event type to be used in addEvent: generated for OwObject access events
static int HISTORY_EVENT_TYPE_CLEAR_SESSION_HISTORY_FOR_OBJECT
          event type to be used in addEvent: used to for clear the session history events associated with the OwObject
static int HISTORY_EVENT_TYPE_ECM
          event type to be used in addEvent: generated for login or search events
static int HISTORY_EVENT_TYPE_GENERIC
          event type to be used in addEvent: generated for arbitrary events
static int HISTORY_EVENT_TYPE_OBJECT
          event type to be used in addEvent: generated for OwObject access events
static int HISTORY_EVENT_TYPE_PLUGIN_DSPATCH
          event type to be used in addEvent: generated when dispatch function is called e.g.
static int HISTORY_EVENT_TYPE_PLUGIN_INVOKE_EDIT
          event type to be used in addEvent: generated for invoked plugin events, which edit objects, like edit properties if save was pressed
static int HISTORY_EVENT_TYPE_PLUGIN_INVOKE_UI
          event type to be used in addEvent: generated for invoked plugin events, which do not modify or view anything like copy or add to favorites
static int HISTORY_EVENT_TYPE_PLUGIN_INVOKE_VIEW
          event type to be used in addEvent: generated for invoked plugin events, which view objects without modifying, like edit properties if save was not pressed
static int HISTORY_EVENT_TYPE_PROPERTY
          event type to be used in addEvent: generated for OwObject access events
static int HISTORY_EVENT_TYPE_VERSION
          event type to be used in addEvent: generated for OwObject access events
static int HISTORY_STATUS_BEGIN
          status flag: event started, there will be an additional failed, cancel, or ok event
static int HISTORY_STATUS_CANCEL
          status flag: event was canceled
static int HISTORY_STATUS_DISABLED
          status flag: event was not executed, the resource was disabled
static int HISTORY_STATUS_FAILED
          status flag: event failed
static int HISTORY_STATUS_OK
          status flag: event was ok
 
Method Summary
 void addEvent(int iEventType_p, String strEventID_p, int iStatus_p)
          add a new history event to the history database if supported by the historymanager
 void addEvent(int iEventType_p, String strEventID_p, OwEvent event_p, int iStatus_p)
          add a new history event to the history database if supported by the historymanager
 

Field Detail

HISTORY_EVENT_TYPE_PLUGIN_INVOKE_UI

static final int HISTORY_EVENT_TYPE_PLUGIN_INVOKE_UI
event type to be used in addEvent: generated for invoked plugin events, which do not modify or view anything like copy or add to favorites

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_PLUGIN_INVOKE_VIEW

static final int HISTORY_EVENT_TYPE_PLUGIN_INVOKE_VIEW
event type to be used in addEvent: generated for invoked plugin events, which view objects without modifying, like edit properties if save was not pressed

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_PLUGIN_INVOKE_EDIT

static final int HISTORY_EVENT_TYPE_PLUGIN_INVOKE_EDIT
event type to be used in addEvent: generated for invoked plugin events, which edit objects, like edit properties if save was pressed

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_PLUGIN_DSPATCH

static final int HISTORY_EVENT_TYPE_PLUGIN_DSPATCH
event type to be used in addEvent: generated when dispatch function is called e.g. when a folder is opened in the RecordManager

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_ECM

static final int HISTORY_EVENT_TYPE_ECM
event type to be used in addEvent: generated for login or search events

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_OBJECT

static final int HISTORY_EVENT_TYPE_OBJECT
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_PROPERTY

static final int HISTORY_EVENT_TYPE_PROPERTY
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_VERSION

static final int HISTORY_EVENT_TYPE_VERSION
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_GENERIC

static final int HISTORY_EVENT_TYPE_GENERIC
event type to be used in addEvent: generated for arbitrary events

See Also:
Constant Field Values

HISTORY_EVENT_TYPE_CLEAR_SESSION_HISTORY_FOR_OBJECT

static final int HISTORY_EVENT_TYPE_CLEAR_SESSION_HISTORY_FOR_OBJECT
event type to be used in addEvent: used to for clear the session history events associated with the OwObject

Since:
3.1.0.0
See Also:
Constant Field Values

HISTORY_EVENT_ID_LOGIN

static final String HISTORY_EVENT_ID_LOGIN
event type to be used in addEvent: generated for login events

See Also:
Constant Field Values

HISTORY_EVENT_ID_LOGOFF

static final String HISTORY_EVENT_ID_LOGOFF
event type to be used in addEvent: generated for logoff events

See Also:
Constant Field Values

HISTORY_EVENT_ID_SEARCH

static final String HISTORY_EVENT_ID_SEARCH
event type to be used in addEvent: generated for search events

See Also:
Constant Field Values

HISTORY_EVENT_ID_NEW_OBJECT

static final String HISTORY_EVENT_ID_NEW_OBJECT
event type to be used in addEvent: generated for new object events

See Also:
Constant Field Values

HISTORY_EVENT_ID_COPY_OBJECT

static final String HISTORY_EVENT_ID_COPY_OBJECT
event type to be used in addEvent: generated for new object events

See Also:
Constant Field Values

HISTORY_EVENT_ID_DOWNLOAD

static final String HISTORY_EVENT_ID_DOWNLOAD
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_ID_UPLOAD

static final String HISTORY_EVENT_ID_UPLOAD
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_ADD

static final String HISTORY_EVENT_ID_OBJECT_ADD
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_MOVE

static final String HISTORY_EVENT_ID_OBJECT_MOVE
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_LOCK

static final String HISTORY_EVENT_ID_OBJECT_LOCK
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_REMOVE_REF

static final String HISTORY_EVENT_ID_OBJECT_REMOVE_REF
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_DELETE

static final String HISTORY_EVENT_ID_OBJECT_DELETE
event type to be used in addEvent: generated for OwObject access events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_DISPATCH

static final String HISTORY_EVENT_ID_OBJECT_DISPATCH
event type to be used in addEvent: generated for workflow objects

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_RETURN_TO_SOURCE

static final String HISTORY_EVENT_ID_OBJECT_RETURN_TO_SOURCE
event type to be used in addEvent: generated for workflow objects

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_RESUBMIT

static final String HISTORY_EVENT_ID_OBJECT_RESUBMIT
event type to be used in addEvent: generated if a object is resubmitted

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_GENERIC

static final String HISTORY_EVENT_ID_OBJECT_GENERIC
event type to be used in addEvent: generic event

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_MODIFY_PROPERTIES

static final String HISTORY_EVENT_ID_OBJECT_MODIFY_PROPERTIES
event type to be used in addEvent: generated for OwObject property events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_MODIFY_PERMISSIONS

static final String HISTORY_EVENT_ID_OBJECT_MODIFY_PERMISSIONS
event type to be used in addEvent: generated for OwObject property events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_MODIFY_ANNOTATIONS

static final String HISTORY_EVENT_ID_OBJECT_MODIFY_ANNOTATIONS
event type to be used in addEvent: generated for OwObject property events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_CHECKOUT

static final String HISTORY_EVENT_ID_OBJECT_CHECKOUT
event type to be used in addEvent: generated for OwObject DMS events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_CANCELCHECKOUT

static final String HISTORY_EVENT_ID_OBJECT_CANCELCHECKOUT
event type to be used in addEvent: generated for OwObject DMS events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_CHECKIN

static final String HISTORY_EVENT_ID_OBJECT_CHECKIN
event type to be used in addEvent: generated for OwObject DMS events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_PROMOTE

static final String HISTORY_EVENT_ID_OBJECT_PROMOTE
event type to be used in addEvent: generated for OwObject DMS events

See Also:
Constant Field Values

HISTORY_EVENT_ID_OBJECT_DEMOTE

static final String HISTORY_EVENT_ID_OBJECT_DEMOTE
event type to be used in addEvent: generated for OwObject DMS events

See Also:
Constant Field Values

HISTORY_STATUS_OK

static final int HISTORY_STATUS_OK
status flag: event was ok

See Also:
Constant Field Values

HISTORY_STATUS_FAILED

static final int HISTORY_STATUS_FAILED
status flag: event failed

See Also:
Constant Field Values

HISTORY_STATUS_CANCEL

static final int HISTORY_STATUS_CANCEL
status flag: event was canceled

See Also:
Constant Field Values

HISTORY_STATUS_BEGIN

static final int HISTORY_STATUS_BEGIN
status flag: event started, there will be an additional failed, cancel, or ok event

See Also:
Constant Field Values

HISTORY_STATUS_DISABLED

static final int HISTORY_STATUS_DISABLED
status flag: event was not executed, the resource was disabled

See Also:
Constant Field Values
Method Detail

addEvent

void addEvent(int iEventType_p,
              String strEventID_p,
              OwEvent event_p,
              int iStatus_p)
              throws Exception
add a new history event to the history database if supported by the historymanager

Parameters:
iEventType_p - int type of event as defined in OwHistoryManager.HISTORY_EVENT_TYPE_...
strEventID_p - Id of event such as a plugin id, can be null
event_p - OwEvent according to iEventType_p, contains additional information, such as the affected Objects or properties
iStatus_p - int as defined in OwHistoryManager.HISTORY_STATUS_...
Throws:
Exception

addEvent

void addEvent(int iEventType_p,
              String strEventID_p,
              int iStatus_p)
              throws Exception
add a new history event to the history database if supported by the historymanager

Parameters:
iEventType_p - int type of event as defined in OwHistoryManager.HISTORY_EVENT_TYPE_...
strEventID_p - Id of event such as a plugin id, can be null
iStatus_p - int as defined in OwHistoryManager.HISTORY_STATUS_...
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.