public class OwStandardVirtualFolderObjectFactory extends Object implements OwVirtualFolderObjectFactory, OwVirtualFolderObject
Base Class for virtual folder objects.
Folder Objects can contain other objects like documents and sub folders.
They can be real physical folders or virtual search based folders.
OwVitualFolderObject implements a search based virtual folder, which is feed by a XML description.
Both virtual and real folders are treated the same way.
Virtual Folders are made up of Searches.
I.e. each node creates a OwSearchNode Object which result list acts as the nodes objects.
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 | Class and Description |
---|---|
protected static class |
OwStandardVirtualFolderObjectFactory.OwSearchTemplateWrapper
Helper to identify if a refresh/reset of the searchtemplate was processed or not.
|
static class |
OwStandardVirtualFolderObjectFactory.OwVirtualFolderObjectClass
ObjectClass of virtual folder.
|
protected static class |
OwStandardVirtualFolderObjectFactory.OwVirtualFolderRefineCriteria
Tuple of criteria name and value to refine a search criteria.
|
Modifier and Type | Field and Description |
---|---|
protected OwObjectCollection |
m_folderChilds
cached child list
|
protected String |
m_nodePath
the path to the currently opened sub folder
|
protected String |
m_objectPath
the path to the currently opened sub folder
|
protected OwXMLUtil |
m_OpenFolderNode
the OwXMLUtil wrapped DOM node of the currently opened sub folder
|
protected OwStandardVirtualFolderObjectFactory |
m_parent
parent
|
protected OwPropertyCollection |
m_PropertyMap
map containing the properties of the virtual folder object
|
protected List |
m_refinementCriteriaList
a List of criteria to refine this node
|
protected OwRepository |
m_repository
reference to the repository
|
protected Node |
m_rootNode
root node describing the virtual folder
|
protected OwSearchTemplate |
m_SearchTemplate
search template to use for this node, can be null
|
protected Set |
m_searchTemplateRefinementCriteriaNameSet
a set of criteria names to refine the search template
|
protected static OwStandardVirtualFolderObjectFactory.OwVirtualFolderObjectClass |
m_StandardClassDescription
the one and only class description for the virtual folder objects
|
protected String |
m_strDMSID
ID of virtual folder used in getDMSID to recreate the folder
|
static String |
MIME_TYPE
the MIME type of the virtual folder
|
protected static String |
NODE_ATTRIBUTE_CONTAINS_DOCUMENTS
name of the containing documents attribute flag
|
static String |
NODE_ATTRIBUTE_MIME_TYPE
attribute in NODE to define an explicit MIME type
|
protected static String |
NODE_ATTRIBUTE_NAME
name of the for the name attribute
|
protected static String |
NODE_TAG_NAME
name of the node tag
|
protected static String |
REFINE_CRITERIA_NODE_TAG_NAME
node name of the refine criteria node
|
protected static String |
SEARCH_NODE_TAG_NAME
node name of the search node
|
CLASSNAME_TAG_NAME, ROOT_NODE_TAG_NAME
STANDARD_PATH_DELIMITER
OBJECT_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_TRACKER
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL
Constructor and Description |
---|
OwStandardVirtualFolderObjectFactory()
Empty default constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
add(OwObject oObject_p)
adds a object reference to this parent object / folder
|
boolean |
canAdd(OwObject oObject_p,
int iContext_p)
checks if object supports add function
|
boolean |
canChangeClass()
check if object can change its class
|
boolean |
canDelete(int iContext_p)
check if object can be deleted
|
boolean |
canFilterChilds()
check if the FilterCriteria_p in getChilds is possible
NOTE: The FilterCriteria_p parameter in getChilds 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
|
boolean |
canGetContent(int iContentType_p,
int iContext_p)
check if content retrieval is allowed
|
boolean |
canGetPermissions()
check if permissions are accessible
|
boolean |
canGetProperties(int iContext_p)
check if property retrieval is allowed
|
boolean |
canLock()
check if object supports lock mechanism
|
boolean |
canMove(OwObject oObject_p,
OwObject oldParent_p,
int iContext_p)
check if move operation is allowed
|
boolean |
canRemoveReference(OwObject oObject_p,
int iContext_p)
checks if the reference can be removed
this object needs to be parent of given object, and user needs to have sufficient access rights
|
boolean |
canSetContent(int iContentType_p,
int iContext_p)
check if content can be set on this document with setContent
|
boolean |
canSetPermissions()
check if permissions can be set
|
boolean |
canSetProperties(int iContext_p)
check if object allows to set / change properties
|
void |
changeClass(String strNewClassName_p,
OwPropertyCollection properties_p,
OwPermissionCollection permissions_p)
change the class of the object
|
protected void |
checkResetState()
Check if a reset was called,
and will process a propagation of values from parent search once again.
|
protected boolean |
compatibleObjectClasses(OwClass classInfo_p,
OwObjectClass objectClass_p)
(overridable)
Checks whether two given class descriptions (an
OwClass and an OwObjectClass ) are compatible
in the context of this virtual folder. |
protected OwStandardVirtualFolderObjectFactory |
createNewSubfolderInstance()
(overridable) create a virtual folder object, used internally in getChilds
|
protected void |
createProperties(String strName_p)
(overridable) create all properties of the file.
|
protected OwSearchTemplate |
createSearchTemplate(Node searchNode_p,
String sResourceName_p)
overridable factory method
|
protected void |
deepCriteriaValuePropagation(OwSearchNode childNode,
OwSearchNode parentNode)
Propagation of criteria values from top search.
|
void |
delete()
delete object and all references from DB
|
protected OwSearchTemplate |
findParentSearch(OwStandardVirtualFolderObjectFactory parent)
Find Parent search definition, useful for propagation of criteria
|
int |
getChildCount(int[] iObjectTypes_p,
int iContext_p)
get the number of children
|
OwIterable<OwObject> |
getChildren(OwLoadContext loadContext) |
OwObjectCollection |
getChilds(int[] iObjectTypes_p,
Collection propertyNames_p,
OwSort sort_p,
int iMaxSize_p,
int iVersionSelection_p,
OwSearchNode filterCriteria_p)
get the children of the object.
|
OwObjectCollection |
getChilds(OwSearchNode search_p,
int[] iObjectTypes_p,
Collection propertyNames_p,
OwSort sort_p,
int iMaxSize_p,
int iVersionSelection_p,
OwSearchNode filterCriteria_p)
get the children of the object.
|
String |
getClassName()
get the class name of the object, the class names are defined by the ECM System
|
OwPermissionCollection |
getClonedPermissions()
get the cloned permissions
|
OwPropertyCollection |
getClonedProperties(Collection strPropertyNames_p)
retrieve the specified properties from the object as a copy
NOTE: The returned collection might contain more Properties than requested with PropertyNames_p
NOTE: if the properties where not already obtained from the archive (e.g. |
Collection |
getColumnInfoList()
get the column info list that describes the columns for the child list
|
OwContentCollection |
getContentCollection()
get the content of the object
|
OwNetworkContext |
getContext()
get context
|
String |
getDMSID()
get the ECM specific ID of the Object.
|
OwField |
getField(String strFieldClassName_p)
implementation of the OwFieldProvider interface
get a field with the given field definition class name
|
String |
getFieldProviderName()
get a name that identifies the field provider, can be used to create ID's
|
Object |
getFieldProviderSource()
get the source object that originally provided the fields.
|
int |
getFieldProviderType()
get the type of field provider as defined with TYPE_...
|
Collection |
getFields()
get all the properties in the form
|
Collection |
getFilterProperties(Collection propertynames_p)
get a collection of OwFieldDefinition's for a given list of names
|
protected OwObjectCollection |
getFolderChilds() |
String |
getID()
get Object symbolic name of the object which is unique among its siblings
used for path construction
|
OwObject |
getInstance()
get a instance from this reference
|
OwVirtualFolderObject |
getInstance(String strDmsIDPart_p)
get a folder instance from the factory with the given DMSID part.
|
boolean |
getLock(int iContext_p)
get the lock state of the object
|
String |
getLockUserID(int iContext_p)
get the lock user of the object
|
String |
getMIMEParameter()
get the additional MIME Parameter of the Object
|
String |
getMIMEType()
get the MIME type of the Object
|
boolean |
getMyLock(int iContext_p)
get the lock state of the object for the CURRENTLY logged on user
|
String |
getName()
get Object name property string
|
Object |
getNativeObject()
get the native object from the ECM system
WARNING: The returned object is Opaque.
|
OwObjectClass |
getObjectClass()
get the class description of the object, the class descriptions are defined by the ECM System
|
int |
getPageCount()
retrieve the number of pages in the objects
|
protected OwStandardVirtualFolderObjectFactory |
getParent()
virtual folders have only one parent,
easy access to it, rather than using getParents
|
OwObjectCollection |
getParents()
get the containing parent of this object, does NOT cache returned objects
|
String |
getPath()
get the path to the object, which can be used in OwNetwork.getObjectFromPath to recreate the object
The path is build with the name property.
|
OwPermissionCollection |
getPermissions()
get the permissions object
|
Map |
getPropagationMap()
Return a map which represents external triggered value propagation.
|
OwPropertyCollection |
getProperties(Collection propertyNames_p)
retrieve the specified properties from the object.
|
OwProperty |
getProperty(String strPropertyName_p)
retrieve the specified property from the object.
|
protected List |
getRefineCriteriaList()
get from the given node, a list of criteria to refine the search template
|
protected OwSearchNode |
getRefinedSearch(OwSearchNode search_p,
List refineList_p)
refine a search according to the given refine criteria list
|
OwRepository |
getRepository()
get repository
|
OwResource |
getResource()
get the resource the object belongs to in a multiple resource Network
|
String |
getResourceID()
get the ID / name identifying the resource the object belongs to
|
protected Node |
getRootNode()
get the root DOM Node of the folder structure
|
protected OwStandardVirtualFolderObjectFactory |
getRootObject()
get the root virtual folder object
|
Object |
getSafeFieldValue(String sName_p,
Object defaultvalue_p)
retrieve the value of a Field
|
OwSearchTemplate |
getSearchTemplate()
get a search template associated with this Object
The search from the template can be used to refine the result in getChilds(...)
==> The search is automatically performed when calling getChilds(...)
The ColumnInfoList from the template can be used to format the result list of the children
NOTE: This function is especially used in virtual folders
|
protected Set |
getSearchTemplateRefineCriteriaNameSet()
get from the whole search template, a list of criteria to refine the search template
|
protected Node |
getSubNode(String strPath_p)
retrieve a sub DOM Node from the structure XML document using a string path
|
int |
getType()
get Object type
|
OwVersion |
getVersion()
get the current version object
|
OwVersionSeries |
getVersionSeries()
get the version series object to this object, if the object is versionable
|
String |
getVirtualFolderName()
Retrieve the name of the virtual folder template used for constructing this object
as defined in the bootstrap SemiVirtualRecordClass configurations.
|
boolean |
hasChilds(int[] iObjectTypes_p,
int iContext_p)
check if object has children
|
boolean |
hasContent(int iContext_p)
check if the object contains a content, which can be retrieved using getContentCollection
|
boolean |
hasVersionSeries()
check if a version series object is available, i.e.
|
void |
init(OwNetworkContext context_p,
OwRepository repository_p,
String strBaseDMSID_p,
String virtualFolderName_p,
Node rootNode_p)
init a virtual folder object
|
boolean |
isRoot()
check if this is the root folder
|
void |
move(OwObject oObject_p,
OwObject oldParent_p)
moves a object reference to this parent object (folder)
|
void |
refreshProperties()
refresh the property cache
|
void |
refreshProperties(Collection props_p)
refresh the property cache
|
void |
removeReference(OwObject oObject_p)
removes the reference of the given object from this object (folder)
this object needs to be parent of given object
|
protected Object |
resolveLiteralPlaceholder(String contextname_p,
String placeholdername_p)
(overridable) resolve the given literal placeholder name to a property / criteria value
|
protected Object |
resolveLiteralValue(String contextname_p,
OwFieldDefinition propClass_p,
Node literal_p)
resolve the given literal node to a property / criteria value
|
protected void |
scanSearchNode(Node searchDOMNode_p)
Recursively traverse the DOM nodes of the search template to collect refine criteria names.
|
void |
setContentCollection(OwContentCollection content_p)
set the content to the object
|
void |
setField(String sName_p,
Object value_p)
modify a Field value, but does not save the value right away
|
void |
setFiledObjectProperties(OwObjectClass objectClass_p,
OwPropertyCollection properties_p)
modify the properties of an object to meet the criteria list of this virtual folders search template
This method is used to add documents to a virtual folder.
|
boolean |
setLock(boolean fLock_p)
lock / unlock object, make it unaccessible for other users
|
void |
setPermissions(OwPermissionCollection permissions_p)
set the permissions object
|
void |
setPropagationMap(Map propagationMap)
Set a map which defines an external triggered value propagation.
|
void |
setProperties(OwPropertyCollection properties_p)
set the properties in the object
|
void |
setProperties(OwPropertyCollection properties_p,
Object mode_p)
set the properties in the object
|
public static final String MIME_TYPE
public static final String NODE_ATTRIBUTE_MIME_TYPE
protected static final String NODE_ATTRIBUTE_CONTAINS_DOCUMENTS
protected static final String NODE_ATTRIBUTE_NAME
protected static final String NODE_TAG_NAME
protected static final String SEARCH_NODE_TAG_NAME
protected static final String REFINE_CRITERIA_NODE_TAG_NAME
protected static final OwStandardVirtualFolderObjectFactory.OwVirtualFolderObjectClass m_StandardClassDescription
protected OwObjectCollection m_folderChilds
protected OwStandardVirtualFolderObjectFactory m_parent
protected OwRepository m_repository
protected Node m_rootNode
protected OwPropertyCollection m_PropertyMap
protected String m_nodePath
protected String m_objectPath
protected OwXMLUtil m_OpenFolderNode
protected String m_strDMSID
protected OwSearchTemplate m_SearchTemplate
protected List m_refinementCriteriaList
protected Set m_searchTemplateRefinementCriteriaNameSet
public OwStandardVirtualFolderObjectFactory()
public void init(OwNetworkContext context_p, OwRepository repository_p, String strBaseDMSID_p, String virtualFolderName_p, Node rootNode_p) throws Exception
OwVirtualFolderObjectFactory
init
in interface OwVirtualFolderObjectFactory
context_p
- OwNetworkContextrepository_p
- OwRepositorystrBaseDMSID_p
- String name to identify the virtual folder by the DMSID, to be extended by instance part (see getInstance)virtualFolderName_p
- name of the virtual folderrootNode_p
- Node XML root node describing the virtual folderException
protected OwStandardVirtualFolderObjectFactory createNewSubfolderInstance() throws Exception
Exception
public OwNetworkContext getContext()
public OwRepository getRepository()
protected Node getRootNode() throws Exception
Exception
protected Node getSubNode(String strPath_p) throws Exception
strPath_p
- String path to the sub nodeException
protected void createProperties(String strName_p) throws Exception
strName_p
- String the name to set the name propertyException
public String getName()
getName
in interface OwObjectReference
public String getID()
getID
in interface OwObjectReference
protected List getRefineCriteriaList() throws Exception
Exception
protected Set getSearchTemplateRefineCriteriaNameSet() throws Exception
Exception
protected void scanSearchNode(Node searchDOMNode_p) throws Exception
searchDOMNode_p
- node to traverse furtherException
protected OwSearchNode getRefinedSearch(OwSearchNode search_p, List refineList_p) throws Exception
search_p
- OwSearchNode to refinerefineList_p
- List of OwVirtualFolderRefineCriteria for refinementException
protected Object resolveLiteralValue(String contextname_p, OwFieldDefinition propClass_p, Node literal_p) throws Exception
protected Object resolveLiteralPlaceholder(String contextname_p, String placeholdername_p) throws Exception
public String getClassName()
getClassName
in interface OwObject
public OwObjectClass getObjectClass()
getObjectClass
in interface OwObject
protected OwStandardVirtualFolderObjectFactory getRootObject() throws Exception
Exception
protected OwStandardVirtualFolderObjectFactory getParent() throws Exception
Exception
public OwObjectCollection getParents() throws Exception
getParents
in interface OwObject
Exception
public OwObjectCollection getChilds(int[] iObjectTypes_p, Collection propertyNames_p, OwSort sort_p, int iMaxSize_p, int iVersionSelection_p, OwSearchNode filterCriteria_p) throws Exception
getChilds
in interface OwObject
iObjectTypes_p
- the requested object types (folder or document)propertyNames_p
- properties to fetch from ECM system along with the children, can be null.sort_p
- OwSort sort criteria list to sort return listiMaxSize_p
- int maximum number of objects to retrieveiVersionSelection_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 nodeException
public OwIterable<OwObject> getChildren(OwLoadContext loadContext) throws OwException
getChildren
in interface OwPageableObject<OwObject>
OwException
protected OwObjectCollection getFolderChilds() throws Exception
Exception
protected void deepCriteriaValuePropagation(OwSearchNode childNode, OwSearchNode parentNode) throws Exception
childNode
- OwSearchNode representing sub search definitionparentNode
- OwSearchNode representing parent search to be used for propagationException
public OwObjectCollection getChilds(OwSearchNode search_p, int[] iObjectTypes_p, Collection propertyNames_p, OwSort sort_p, int iMaxSize_p, int iVersionSelection_p, OwSearchNode filterCriteria_p) throws Exception
search_p
- OwSearchNode to use for virtual searchiObjectTypes_p
- the requested object types (folder or document)propertyNames_p
- properties to fetch from ECM system along with the children, can be null.sort_p
- OwSort sort criteria list to sort return listiMaxSize_p
- int maximum number of objects to retrieveiVersionSelection_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 nodeException
protected boolean compatibleObjectClasses(OwClass classInfo_p, OwObjectClass objectClass_p)
OwClass
and an OwObjectClass
) are compatible
in the context of this virtual folder. classInfo_p
- objectClass_p
- true
if the given OwObjectClass
is virtually compatible with the given OwClass
false
otherwisepublic void setFiledObjectProperties(OwObjectClass objectClass_p, OwPropertyCollection properties_p) throws Exception
setFiledObjectProperties
in interface OwVirtualFolderObject
objectClass_p
- OwObjectClass of the new documentproperties_p
- OwPropertyCollection to be modifiedException
public boolean canFilterChilds() throws Exception
canFilterChilds
in interface OwObject
Exception
public Collection getFilterProperties(Collection propertynames_p) throws Exception
getFilterProperties
in interface OwObject
propertynames_p
- Collection of property names the client wants to use as filter properties or null to retrieve all possible filter propertiesException
public OwVersionSeries getVersionSeries() throws Exception
getVersionSeries
in interface OwObject
Exception
public boolean hasVersionSeries() throws Exception
hasVersionSeries
in interface OwObject
Exception
public OwVersion getVersion() throws Exception
getVersion
in interface OwObject
Exception
public int getType()
getType
in interface OwObjectReference
public String getDMSID() throws Exception
getDMSID
in interface OwObjectReference
Exception
public OwProperty getProperty(String strPropertyName_p) throws Exception
getProperty
in interface OwObject
strPropertyName_p
- the name of the requested propertyException
public OwPropertyCollection getProperties(Collection propertyNames_p) throws Exception
getProperties
in interface OwObject
propertyNames_p
- a collection of property names to retrieve, if null all properties are retrievedException
public OwPropertyCollection getClonedProperties(Collection strPropertyNames_p) throws Exception
getClonedProperties
in interface OwObject
strPropertyNames_p
- a collection of property names to retrieve, if null all properties are retrievedException
public void setProperties(OwPropertyCollection properties_p) throws Exception
setProperties
in interface OwObject
properties_p
- OwPropertyList list of OwProperties to setException
public boolean canSetProperties(int iContext_p) throws Exception
canSetProperties
in interface OwObject
iContext_p
- OwStatusContextDefinitionsException
public boolean canGetProperties(int iContext_p) throws Exception
canGetProperties
in interface OwObject
iContext_p
- OwStatusContextDefinitionsException
public boolean canLock() throws Exception
public boolean setLock(boolean fLock_p) throws Exception
public boolean getLock(int iContext_p) throws Exception
public boolean getMyLock(int iContext_p) throws Exception
getMyLock
in interface OwObject
iContext_p
- int value from OwStatusContextDefinitions
Exception
public String getLockUserID(int iContext_p) throws Exception
getLockUserID
in interface OwObject
iContext_p
- int value from OwStatusContextDefinitions
Exception
public boolean canSetContent(int iContentType_p, int iContext_p) throws Exception
canSetContent
in interface OwObject
iContentType_p
- int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)iContext_p
- OwStatusContextDefinitionsException
public boolean canGetContent(int iContentType_p, int iContext_p) throws Exception
canGetContent
in interface OwObject
iContentType_p
- int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)iContext_p
- OwStatusContextDefinitionsException
public String getMIMEType() throws Exception
getMIMEType
in interface OwObjectReference
Exception
public String getMIMEParameter() throws Exception
getMIMEParameter
in interface OwObjectReference
Exception
public void delete() throws Exception
public boolean canDelete(int iContext_p) throws Exception
public void removeReference(OwObject oObject_p) throws Exception
removeReference
in interface OwObject
oObject_p
- OwObject reference to be removed from this object (folder)Exception
public boolean canRemoveReference(OwObject oObject_p, int iContext_p) throws Exception
canRemoveReference
in interface OwObject
oObject_p
- OwObject reference to be checked uponiContext_p
- OwStatusContextDefinitionsException
public void add(OwObject oObject_p) throws Exception
public boolean canAdd(OwObject oObject_p, int iContext_p) throws Exception
public void move(OwObject oObject_p, OwObject oldParent_p) throws Exception
public boolean canMove(OwObject oObject_p, OwObject oldParent_p, int iContext_p) throws Exception
public OwSearchTemplate getSearchTemplate() throws Exception
getSearchTemplate
in interface OwObject
Exception
protected OwSearchTemplate createSearchTemplate(Node searchNode_p, String sResourceName_p) throws Exception
searchNode_p
- sResourceName_p
- OwSearchTemplate
Exception
public Collection getColumnInfoList() throws Exception
getColumnInfoList
in interface OwObject
Exception
public int getPageCount() throws Exception
getPageCount
in interface OwObjectReference
Exception
public OwResource getResource() throws Exception
getResource
in interface OwObject
Exception
public OwPermissionCollection getPermissions() throws Exception
getPermissions
in interface OwObject
Exception
public OwPermissionCollection getClonedPermissions() throws Exception
getClonedPermissions
in interface OwObject
Exception
public boolean canGetPermissions() throws Exception
canGetPermissions
in interface OwObject
Exception
public boolean canSetPermissions() throws Exception
canSetPermissions
in interface OwObject
Exception
public void setPermissions(OwPermissionCollection permissions_p) throws Exception
setPermissions
in interface OwObject
permissions_p
- OwPermissionCollection to setException
public void setContentCollection(OwContentCollection content_p) throws Exception
setContentCollection
in interface OwObject
content_p
- OwContentCollection to store in the objectException
public OwContentCollection getContentCollection() throws Exception
By default this method returns null
getContentCollection
in interface OwObject
Exception
public void refreshProperties() throws Exception
refreshProperties
in interface OwObject
Exception
public void refreshProperties(Collection props_p) throws Exception
refreshProperties
in interface OwObject
props_p
- Collection of property names to updateException
public Object getNativeObject() throws Exception
getNativeObject
in interface OwObject
Exception
public OwField getField(String strFieldClassName_p) throws Exception, OwObjectNotFoundException
getField
in interface OwFieldProvider
strFieldClassName_p
- String class name of requested fieldsException
OwObjectNotFoundException
public Object getFieldProviderSource()
getFieldProviderSource
in interface OwFieldProvider
public int getFieldProviderType()
getFieldProviderType
in interface OwFieldProvider
public boolean hasContent(int iContext_p) throws Exception
hasContent
in interface OwObjectReference
iContext_p
- int value from OwStatusContextDefinitions
Exception
public boolean hasChilds(int[] iObjectTypes_p, int iContext_p) throws Exception
hasChilds
in interface OwObject
iContext_p
- int value from OwStatusContextDefinitions
iObjectTypes_p
- Exception
public String getPath() throws Exception
public OwVirtualFolderObject getInstance(String strDmsIDPart_p) throws Exception
init(OwNetworkContext, OwRepository, String, String, Node)
)getInstance
in interface OwVirtualFolderObjectFactory
strDmsIDPart_p
- String DMSID part for the instance, or null to get a default virtual folderException
public int getChildCount(int[] iObjectTypes_p, int iContext_p) throws Exception
By default an empty OwStatusContextException is thrown
getChildCount
in interface OwObject
iObjectTypes_p
- the requested object types (folder or document)iContext_p
- int value from OwStatusContextDefinitions
Exception
public void changeClass(String strNewClassName_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p) throws Exception
changeClass
in interface OwObject
strNewClassName_p
- Stringproperties_p
- OwPropertyCollection (optional, can be null to set previous properties)permissions_p
- OwPermissionCollection (optional, can be null to set previous permissions)Exception
public boolean canChangeClass() throws Exception
canChangeClass
in interface OwObject
Exception
public String getFieldProviderName()
getFieldProviderName
in interface OwFieldProvider
public void setField(String sName_p, Object value_p) throws Exception, OwObjectNotFoundException
setField
in interface OwFieldProvider
sName_p
- value_p
- Exception
OwObjectNotFoundException
public Object getSafeFieldValue(String sName_p, Object defaultvalue_p)
getSafeFieldValue
in interface OwFieldProvider
sName_p
- defaultvalue_p
- public OwObject getInstance() throws Exception
getInstance
in interface OwObjectReference
Exception,
- OwObjectNotFoundExceptionException
public String getResourceID() throws Exception
getResourceID
in interface OwObjectReference
Exception,
- OwObjectNotFoundExceptionException
OwResource
public void setProperties(OwPropertyCollection properties_p, Object mode_p) throws Exception
OwObject
setProperties
in interface OwObject
properties_p
- OwPropertyList list of OwProperties to setmode_p
- mode to use or null to use default mode, @see OwObjectClass.getModes(int)
Exception
public Collection getFields() throws Exception
getFields
in interface OwFieldProvider
Exception
public Map getPropagationMap()
OwVirtualFolderObject
getPropagationMap
in interface OwVirtualFolderObject
OwVirtualFolderObject.setPropagationMap(Map)
public void setPropagationMap(Map propagationMap)
OwVirtualFolderObject
Can be set to null to avoid any external defined propagation.
setPropagationMap
in interface OwVirtualFolderObject
propagationMap
- Map (String criteria Name, Object value)OwVirtualFolderObject.getPropagationMap()
public String getVirtualFolderName()
OwVirtualFolderObject
getVirtualFolderName
in interface OwVirtualFolderObject
protected void checkResetState() throws Exception
Exception
protected OwSearchTemplate findParentSearch(OwStandardVirtualFolderObjectFactory parent) throws Exception
parent
- OwStandardVirtualFolderObjectFactory (can be null)Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.