public interface OwRepository<O extends OwObject> extends OwFieldDefinitionProvider
Base interface for Repositories. Subclasses are OwNetwork
and OwHistoryManager
.
Offers search and browse functions for Objects stored in the repository.
To be implemented with the specific ECM system.
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
Modifier and Type | Method and Description |
---|---|
boolean |
canBatch()
check if repository supports batch operations
|
boolean |
canPageSearch()
check for support paging in search
|
boolean |
canRefreshStaticClassdescriptions()
check if reload of all the static class description data is supported / necessary.
|
void |
closeBatch(OwBatch batch_p)
close a batch operation, if the batch was not committed, rollback the batch
|
OwIterable<O> |
doSearch(OwSearchNode searchClause,
OwLoadContext loadContext)
performs a search on the network and returns an iterable collection of results
corresponding to the given search clause in the given load context
|
OwObjectCollection |
doSearch(OwSearchNode searchCriteria_p,
OwSort sortCriteria_p,
Collection propertyNames_p,
int iMaxSize_p,
int iVersionSelection_p)
performs a search on the network and returns a result list, if more than iMaxSize_p objects are found then doSearch returns the first iMaxSize_p Objects
|
String |
getDMSPrefix()
get a prefix which is used to distinguish the DMSID of objects from the repository
|
OwEventManager |
getEventManager()
get the instance of the history manager
|
OwObjectClass |
getObjectClass(String strClassName_p,
OwResource resource_p)
get a Property class description of the available object class descriptions
|
Map |
getObjectClassNames(int[] iTypes_p,
boolean fExcludeHiddenAndNonInstantiable_p,
boolean fRootOnly_p,
OwResource resource_p)
get a list of the available object class descriptions names
|
OwObject |
getObjectFromDMSID(String strDMSID_p,
boolean fRefresh_p)
reconstructs an Object from ECM Id,
OwObjectReference.getDMSID() for details. |
OwObject |
getObjectFromPath(String strPath_p,
boolean fRefresh_p)
get object from given path
|
OwResource |
getResource(String strID_p)
get the resource with the specified key
|
Iterator |
getResourceIDs()
get a Iterator of available resource IDs
|
OwBatch |
openBatch()
open a new batch operation
|
void |
refreshStaticClassdescriptions()
force the network adapter to reload all the static class description data.
|
void |
releaseResources()
releases all resources that have been used during this session
|
getFieldDefinition, getWildCardDefinitions
void refreshStaticClassdescriptions() throws Exception
Exception
boolean canRefreshStaticClassdescriptions() throws Exception
Exception
OwObjectCollection doSearch(OwSearchNode searchCriteria_p, OwSort sortCriteria_p, Collection propertyNames_p, int iMaxSize_p, int iVersionSelection_p) throws Exception
searchCriteria_p
- list of search criteriasortCriteria_p
- optional list of sort criteriapropertyNames_p
- a optional Collection of properties to retrieve with the documents, can be nulliMaxSize_p
- int value to specify the maximum size of the OwObjectCollection if more objects match the criteriaiVersionSelection_p
- int Selects the versions as defined in OwSearchTemplate.VERSION_SELECT_... or (OwSearchTemplate.VERSION_SELECT_DEFAULT or 0) to use default versionException
OwObject getObjectFromDMSID(String strDMSID_p, boolean fRefresh_p) throws Exception
OwObjectReference.getDMSID()
for details.strDMSID_p
- ECM ID for the requested objectfRefresh_p
- true = force refresh of object from ECM System, false = may use cached objectException
OwObject getObjectFromPath(String strPath_p, boolean fRefresh_p) throws Exception
strPath_p
- path to the object starting with "/..."fRefresh_p
- true = force refresh of object from ECM System, false = may use cached objectException
OwObjectClass getObjectClass(String strClassName_p, OwResource resource_p) throws Exception
strClassName_p
- Name of classresource_p
- OwResource to retrieve the objects from, or null to use the default resourceException
Map getObjectClassNames(int[] iTypes_p, boolean fExcludeHiddenAndNonInstantiable_p, boolean fRootOnly_p, OwResource resource_p) throws Exception
iTypes_p
- int array of Object types as defined in OwObject, if null to retrieve all class namesfExcludeHiddenAndNonInstantiable_p
- boolean true = exclude all hidden and non instantiable class descriptionsfRootOnly_p
- true = gets only the root classes if we deal with a class tree, false = gets all classesresource_p
- OwResource to retrieve the objects from, or null to use the default resourceException
OwResource getResource(String strID_p) throws Exception
strID_p
- String resource ID, if strID_p is null returns the default resource or OwObjectNotFoundExceptionOwResource
Exception
Iterator getResourceIDs() throws Exception
Exception
OwEventManager getEventManager()
String getDMSPrefix()
void releaseResources() throws Exception
Exception
boolean canBatch()
openBatch()
,
closeBatch(OwBatch)
OwBatch openBatch() throws OwException
OwException
canBatch()
,
closeBatch(OwBatch)
void closeBatch(OwBatch batch_p) throws OwException
OwException
canBatch()
,
openBatch()
OwIterable<O> doSearch(OwSearchNode searchClause, OwLoadContext loadContext) throws OwException
searchClause
- loadContext
- OwIterable
OwException
boolean canPageSearch()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.