com.wewebu.ow.server.history
Interface OwHistoryManager

All Superinterfaces:
OwEventManager, OwFieldDefinitionProvider, OwRepository
All Known Implementing Classes:
OwSimpleHistoryManager, OwStandardHistoryManager

public interface OwHistoryManager
extends OwEventManager, OwRepository

Interface for history managers to collect and retrieve history information.
History Events are collected both in the EcmAdapter and in the Workdesk itself.
Most ECM Systems will write their own history and so the history manager needs only to read that information. If the ECM System does not write a history, then the Adapter needs to write events to a database and the history manager needs to read the events there.
For Workdesk events such as a clicked plugin the addEntry function needs to be implemented and the event needs to be written to a database.

To be implemented with the specific ECM system.

You get a instance of the HistoryManager by calling getContext().getHistoryManager().

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
 
Fields inherited from interface com.wewebu.ow.server.event.OwEventManager
HISTORY_EVENT_ID_COPY_OBJECT, HISTORY_EVENT_ID_DOWNLOAD, HISTORY_EVENT_ID_LOGIN, HISTORY_EVENT_ID_LOGOFF, HISTORY_EVENT_ID_NEW_OBJECT, HISTORY_EVENT_ID_OBJECT_ADD, HISTORY_EVENT_ID_OBJECT_CANCELCHECKOUT, HISTORY_EVENT_ID_OBJECT_CHECKIN, HISTORY_EVENT_ID_OBJECT_CHECKOUT, HISTORY_EVENT_ID_OBJECT_DELETE, HISTORY_EVENT_ID_OBJECT_DEMOTE, HISTORY_EVENT_ID_OBJECT_DISPATCH, HISTORY_EVENT_ID_OBJECT_GENERIC, HISTORY_EVENT_ID_OBJECT_LOCK, HISTORY_EVENT_ID_OBJECT_MODIFY_ANNOTATIONS, HISTORY_EVENT_ID_OBJECT_MODIFY_PERMISSIONS, HISTORY_EVENT_ID_OBJECT_MODIFY_PROPERTIES, HISTORY_EVENT_ID_OBJECT_MOVE, HISTORY_EVENT_ID_OBJECT_PROMOTE, HISTORY_EVENT_ID_OBJECT_REMOVE_REF, HISTORY_EVENT_ID_OBJECT_RESUBMIT, HISTORY_EVENT_ID_OBJECT_RETURN_TO_SOURCE, HISTORY_EVENT_ID_SEARCH, HISTORY_EVENT_ID_UPLOAD, HISTORY_EVENT_TYPE_CLEAR_SESSION_HISTORY_FOR_OBJECT, HISTORY_EVENT_TYPE_ECM, HISTORY_EVENT_TYPE_GENERIC, HISTORY_EVENT_TYPE_OBJECT, HISTORY_EVENT_TYPE_PLUGIN_DSPATCH, HISTORY_EVENT_TYPE_PLUGIN_INVOKE_EDIT, HISTORY_EVENT_TYPE_PLUGIN_INVOKE_UI, HISTORY_EVENT_TYPE_PLUGIN_INVOKE_VIEW, HISTORY_EVENT_TYPE_PROPERTY, HISTORY_EVENT_TYPE_VERSION, HISTORY_STATUS_BEGIN, HISTORY_STATUS_CANCEL, HISTORY_STATUS_DISABLED, HISTORY_STATUS_FAILED, HISTORY_STATUS_OK
 
Method Summary
 OwObjectCollection doObjectSearch(OwObjectReference object_p, OwSearchNode filterCriteria_p, OwSort sortCriteria_p, Collection propertyNames_p, int[] includeSubObjectTypes_p, int iMaxSize_p)
          search for entries in the database for a specific ECM object
 void init(OwHistoryManagerContext mainContext_p, OwXMLUtil configNode_p)
          init the manager, set context
 void setNetwork(OwNetwork network_p)
          set a reference to the network adapter
 
Methods inherited from interface com.wewebu.ow.server.event.OwEventManager
addEvent, addEvent
 
Methods inherited from interface com.wewebu.ow.server.ecm.OwRepository
canBatch, canRefreshStaticClassdescriptions, closeBatch, doSearch, getDMSPrefix, getEventManager, getObjectClass, getObjectClassNames, getObjectFromDMSID, getObjectFromPath, getResource, getResourceIDs, openBatch, refreshStaticClassdescriptions, releaseResources
 
Methods inherited from interface com.wewebu.ow.server.field.OwFieldDefinitionProvider
getFieldDefinition, getWildCardDefinitions
 

Method Detail

init

void init(OwHistoryManagerContext mainContext_p,
          OwXMLUtil configNode_p)
          throws Exception
init the manager, set context

Parameters:
configNode_p - OwXMLUtil node with configuration information
mainContext_p - reference to the main app context of the application
Throws:
Exception

setNetwork

void setNetwork(OwNetwork network_p)
set a reference to the network adapter

Parameters:
network_p - OwNetwork

doObjectSearch

OwObjectCollection doObjectSearch(OwObjectReference object_p,
                                  OwSearchNode filterCriteria_p,
                                  OwSort sortCriteria_p,
                                  Collection propertyNames_p,
                                  int[] includeSubObjectTypes_p,
                                  int iMaxSize_p)
                                  throws Exception
search for entries in the database for a specific ECM object

Parameters:
object_p - OwObjectReference to find entries for
filterCriteria_p - OwSearchNode to refine the search or null to retrieve all entries
sortCriteria_p - OwSort to apply, or null
propertyNames_p - Collection of properties to retrieve with the history entries
includeSubObjectTypes_p - array of child OwObject types to be included in history, or null
iMaxSize_p - max size of entries to retrieve
Returns:
Collection of OwHistoryEntry
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.