com.wewebu.ow.server.ecm
Interface OwSemiVirtualFolderAdapter

All Known Implementing Classes:
OwStandardSemiVirtualFolderAdapter

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

Since:
3.0.0.0

Field Summary
static String VIRTUAL_FOLDER_SEARCH_PATH_PROPERTY
           
 
Method Summary
 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.
 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.
 

Field Detail

VIRTUAL_FOLDER_SEARCH_PATH_PROPERTY

static final String VIRTUAL_FOLDER_SEARCH_PATH_PROPERTY
See Also:
Constant Field Values
Method Detail

getChildren

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
Retrieves all children of the given semi-virtual-folder object. Does NOT cache the returned object. Has similar contract with the OwObject.getChilds(int[], Collection, OwSort, int, int, OwSearchNode) method.

Parameters:
semiVirtualFolder_p - the semi-virtual-folder object whose children are to be retrieved
objectTypes_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 list
maxSize_p - int maximum number of objects to retrieve
versionSelection_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 node
Returns:
all children of the given semi-virtual-folder object (physical included if specified by OwSemiVirtualFolder.includesPhysicalChildren())
Throws:
OwException

getVirtualFolder

OwVirtualFolderObject getVirtualFolder(OwSemiVirtualFolder semiVirtualFolder_p)
                                       throws OwException
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.

Returns:
the virtual folder object of this semi-virtual-folder adapter
Throws:
OwException


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.