public interface OwHistoryManager extends OwEventManager, OwRepository<OwHistoryEntry>
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
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
Modifier and Type | Method and Description |
---|---|
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
|
addEvent, addEvent
canBatch, canPageSearch, canRefreshStaticClassdescriptions, closeBatch, doSearch, doSearch, getDMSPrefix, getEventManager, getObjectClass, getObjectClassNames, getObjectFromDMSID, getObjectFromPath, getResource, getResourceIDs, openBatch, refreshStaticClassdescriptions, releaseResources
getFieldDefinition, getWildCardDefinitions
void init(OwHistoryManagerContext mainContext_p, OwXMLUtil configNode_p) throws Exception
configNode_p
- OwXMLUtil node with configuration informationmainContext_p
- reference to the main app context of the applicationException
void setNetwork(OwNetwork network_p)
network_p
- OwNetworkOwObjectCollection doObjectSearch(OwObjectReference object_p, OwSearchNode filterCriteria_p, OwSort sortCriteria_p, Collection propertyNames_p, int[] includeSubObjectTypes_p, int iMaxSize_p) throws Exception
object_p
- OwObjectReference to find entries forfilterCriteria_p
- OwSearchNode to refine the search or null to retrieve all entriessortCriteria_p
- OwSort to apply, or nullpropertyNames_p
- Collection of properties to retrieve with the history entriesincludeSubObjectTypes_p
- array of child OwObject types to be included in history, or nulliMaxSize_p
- max size of entries to retrieveException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.