public interface OwSemiVirtualFolder extends OwObject
Semi-virtual-folder object adapter interface.
Implementors are meant to be custom-adapter-based semi-virtual folder
like children fetching, path properties processing and property value conversions.
implementations that use OwSemiVirtualFolderAdapter for common operations.
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
STANDARD_PATH_DELIMITEROBJECT_TYPE_ALL_CONTAINER_OBJECTS, OBJECT_TYPE_ALL_CONTENT_OBJECTS, OBJECT_TYPE_ALL_TUPLE_OBJECTS, OBJECT_TYPE_ALL_WORKFLOW_OBJECTS, OBJECT_TYPE_BPM_ROOT_FOLDER, OBJECT_TYPE_CONTAINER_USER_START, OBJECT_TYPE_CONTENT_USER_START, OBJECT_TYPE_CROSS_QUEUE_FOLDER, OBJECT_TYPE_CUSTOM, OBJECT_TYPE_DOCUMENT, OBJECT_TYPE_DYNAMIC_VIRTUAL_FOLDER, OBJECT_TYPE_ECM_ROOT_FOLDER, OBJECT_TYPE_FOLDER, OBJECT_TYPE_HISTORY, OBJECT_TYPE_LINK, OBJECT_TYPE_PROXY_QUEUE_FOLDER, OBJECT_TYPE_PUBLIC_QUEUE_FOLDER, OBJECT_TYPE_ROSTER_FOLDER, OBJECT_TYPE_ROSTERITEM, OBJECT_TYPE_STORED_SEARCH, OBJECT_TYPE_SYS_QUEUE_FOLDER, OBJECT_TYPE_TRACKER_QUEUE_FOLDER, OBJECT_TYPE_TUPLE_USER_START, OBJECT_TYPE_UNDEFINED, OBJECT_TYPE_USER_QUEUE_FOLDER, OBJECT_TYPE_VIRTUAL_FOLDER, OBJECT_TYPE_WORKFLOW_USER_START, OBJECT_TYPE_WORKITEM, OBJECT_TYPE_WORKITEM_PROXY, OBJECT_TYPE_WORKITEM_TRACKERTYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL| Modifier and Type | Method and Description |
|---|---|
OwObjectCollection |
getPhysicalChildren(int[] objectTypes_p,
Collection propertyNames_p,
OwSort sort_p,
int maxSize_p,
int versionSelection_p,
OwSearchNode filterCriteria_p)
Retrieves the physical children of this semi-virtual-folder object.
|
OwIterable<OwObject> |
getPhysicalChildren(OwLoadContext loadContext)
Same as
getPhysicalChildren(int[], Collection, OwSort, int, int, OwSearchNode) but with a different signature. |
Map<String,String> |
getPropertyMap() |
String |
getVirtualFolderName() |
boolean |
includesPhysicalChildren() |
boolean |
searchSubstructure()
Return a flag indicating if the substructure of current "physical" root
should be include in search also.
|
add, canAdd, canChangeClass, canDelete, canFilterChilds, canGetContent, canGetPermissions, canGetProperties, canLock, canMove, canRemoveReference, canSetContent, canSetPermissions, canSetProperties, changeClass, delete, getChildCount, getChilds, getClassName, getClonedPermissions, getClonedProperties, getColumnInfoList, getContentCollection, getFilterProperties, getLock, getLockUserID, getMyLock, getNativeObject, getObjectClass, getParents, getPath, getPermissions, getProperties, getProperty, getResource, getSearchTemplate, getVersion, getVersionSeries, hasChilds, hasVersionSeries, move, refreshProperties, refreshProperties, removeReference, setContentCollection, setLock, setPermissions, setProperties, setPropertiesgetDMSID, getID, getInstance, getMIMEParameter, getMIMEType, getName, getPageCount, getResourceID, getType, hasContentgetField, getFieldProviderName, getFieldProviderSource, getFieldProviderType, getFields, getSafeFieldValue, setFieldString getVirtualFolderName()
String name of the virtual folder associated with the semi-virtual-folder
as specified in the bootstrap semi virtual record configurationMap<String,String> getPropertyMap()
Map for modeling the mapping between the virtual folder properties
(the String keys of the map) and the corresponding search template fields (the String
values of the map).boolean includesPhysicalChildren()
boolean value of the includephysicalchilds configuration
as specified in the bootstrap semi virtual record configuration.boolean searchSubstructure()
OW_ObjectPath=OwSearchPath
boolean value of the searchSubstructure configuration
as specified in the bootstrap semi virtual record configuration.OwObjectCollection getPhysicalChildren(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.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 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 nodeOwExceptionOwIterable<OwObject> getPhysicalChildren(OwLoadContext loadContext) throws OwException
getPhysicalChildren(int[], Collection, OwSort, int, int, OwSearchNode) but with a different signature.loadContext - OwExceptionCopyright © 2014 Alfresco Business Solutions. All Rights Reserved.