public interface OwSemiVirtualFolderAdapter
Semi-virtual-folder object adapter interface. Implementors are meant to be used in custom-adapter-based semi-virtual folder implementations for common operations like children fetching, path properties processing and property value conversions.
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 | Field and Description |
---|---|
static String |
VIRTUAL_FOLDER_SEARCH_PATH_PROPERTY |
Modifier and Type | Method and Description |
---|---|
OwObjectCollection |
getChildren(OwSemiVirtualFolder semiVirtualFolder_p,
int[] objectTypes_p,
Collection propertyNames_p,
OwSort sort_p,
int maxSize_p,
int versionSelection_p,
OwSearchNode filterCriteria_p)
Retrieves all children of the given semi-virtual-folder object.
|
OwIterable<? extends OwObject> |
getChildren(OwSemiVirtualFolder semiVirtualFolder_p,
OwLoadContext loadContext)
Same behavior as
getChildren(OwSemiVirtualFolder, int[], Collection, OwSort, int, int, OwSearchNode) but returning a pageable OwIterable . |
OwVirtualFolderObject |
getVirtualFolder(OwSemiVirtualFolder semiVirtualFolder_p)
Retrieve the virtual folder object corresponding to this semi-virtual-folder adapter.
Clients of this interface should consider the possible caching of the virtual folder object instance by their adapter. |
static final String VIRTUAL_FOLDER_SEARCH_PATH_PROPERTY
OwObjectCollection getChildren(OwSemiVirtualFolder semiVirtualFolder_p, int[] objectTypes_p, Collection propertyNames_p, OwSort sort_p, int maxSize_p, int versionSelection_p, OwSearchNode filterCriteria_p) throws OwException
OwObject.getChilds(int[], Collection, OwSort, int, int, OwSearchNode)
method.semiVirtualFolder_p
- the semi-virtual-folder object whose children are to be retrievedobjectTypes_p
- the requested object types (folder or document)propertyNames_p
- properties to fetch from DMS system along with the children, can be null.sort_p
- OwSort Sortcriteria list to sort return listmaxSize_p
- int maximum number of objects to retrieveversionSelection_p
- int Selects the versions as defined in OwSearchTemplate.VERSION_SELECT_...filterCriteria_p
- optional OwSearchNode to filter the children, can be null
NOTE: This parameter is an additional filter to the internal SearchTemplate used in the getSearchTemplate(...) function
The internal SearchTemplate used in the getSearchTemplate(...) is used for virtual folders, the FilterCriteria_p is used to refine the result of a nodeOwSemiVirtualFolder.includesPhysicalChildren()
)OwException
OwVirtualFolderObject getVirtualFolder(OwSemiVirtualFolder semiVirtualFolder_p) throws OwException
OwException
OwIterable<? extends OwObject> getChildren(OwSemiVirtualFolder semiVirtualFolder_p, OwLoadContext loadContext) throws OwException
getChildren(OwSemiVirtualFolder, int[], Collection, OwSort, int, int, OwSearchNode)
but returning a pageable OwIterable
.loadContext
- OwIterable
OwException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.