public interface OwObject extends OwObjectReference, OwFieldProvider
Base interface for all ECM 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 | Field and Description |
---|---|
static String |
STANDARD_PATH_DELIMITER
path delimiter for building paths
|
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
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 and if user has sufficient access rights
|
boolean |
canChangeClass()
check if object can change its class
|
boolean |
canDelete(int iContext_p)
check if object can be deleted and if user has sufficient access rights
|
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
|
void |
delete()
delete object and all references from DB
|
int |
getChildCount(int[] iObjectTypes_p,
int iContext_p)
get the number of children
|
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, does NOT cache the returned object
For Compound Documents returns the list of contained documents
For Folders returns the list of subfolders
|
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 propertyNames_p)
retrieve the specified properties from the object as a copy
NOTE: Other the getProperties, the returned collection returns exactly the requested properties
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
|
Collection |
getFilterProperties(Collection propertynames_p)
get a collection of OwFieldDefinition's for a given list of names
|
boolean |
getLock(int iContext_p)
get the lock state of the object for ALL users
|
String |
getLockUserID(int iContext_p)
get the lock user of the object
|
boolean |
getMyLock(int iContext_p)
get the lock state of the object for the CURRENTLY logged on user
|
Object |
getNativeObject()
get the native object from the ECM system
NOTE: The returned object is Opaque.
|
OwObjectClass |
getObjectClass()
get the class description of the object, the class descriptions are defined by the ECM System
|
OwObjectCollection |
getParents()
get the containing parents of this object, does NOT cache returned objects
for folders it is several parent folders, for compound documents it is one parent document.
|
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
|
OwPropertyCollection |
getProperties(Collection propertyNames_p)
retrieve the specified properties from the object.
|
OwProperty |
getProperty(String strPropertyName_p)
retrieve the specified property from the object.
|
OwResource |
getResource()
get the resource the object belongs to in a multiple resource Network
|
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
|
OwVersion |
getVersion()
get the current version object
|
OwVersionSeries |
getVersionSeries()
get the version series object to this object, if the object is versionable
|
boolean |
hasChilds(int[] iObjectTypes_p,
int iContext_p)
check if object has children
|
boolean |
hasVersionSeries()
check if a version series object is available, i.e.
|
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
|
void |
setContentCollection(OwContentCollection content_p)
set the content to the object
|
boolean |
setLock(boolean fLock_p)
lock / unlock object, make it unaccessible for other users
|
void |
setPermissions(OwPermissionCollection permissions_p)
set the permissions object
|
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
|
getDMSID, getID, getInstance, getMIMEParameter, getMIMEType, getName, getPageCount, getResourceID, getType, hasContent
getField, getFieldProviderName, getFieldProviderSource, getFieldProviderType, getFields, getSafeFieldValue, setField
static final String STANDARD_PATH_DELIMITER
String getClassName()
OwObjectClass getObjectClass()
OwObjectCollection getParents() throws Exception
Exception
OwObjectCollection getChilds(int[] iObjectTypes_p, Collection propertyNames_p, OwSort sort_p, int iMaxSize_p, int iVersionSelection_p, OwSearchNode filterCriteria_p) throws Exception
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 Sortcriteria list to sort return listiMaxSize_p
- int maximum number of objects to retrieveiVersionSelection_p
- int Selects the versions as defined in OwSearchTemplate.VERSION_SELECT_... or 0 to use default versionfilterCriteria_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
boolean hasChilds(int[] iObjectTypes_p, int iContext_p) throws Exception
iObjectTypes_p
- the requested object types (folder or document)iContext_p
- int as defined in OwStatusContextDefinitions
Exception
int getChildCount(int[] iObjectTypes_p, int iContext_p) throws Exception
iObjectTypes_p
- the requested object types (folder or document)iContext_p
- OwStatusContextDefinitionsException
void changeClass(String strNewClassName_p, OwPropertyCollection properties_p, OwPermissionCollection permissions_p) throws Exception
strNewClassName_p
- properties_p
- OwPropertyCollection (optional, can be null to set previous properties)permissions_p
- OwPermissionCollection (optional, can be null to set previous permissions)Exception
boolean canChangeClass() throws Exception
Exception
boolean canFilterChilds() throws Exception
Exception
Collection getFilterProperties(Collection propertynames_p) throws Exception
propertynames_p
- Collection of property names the client wants to use as filter properties or null to retrieve all possible filter propertiesException
OwVersionSeries getVersionSeries() throws Exception
Exception
boolean hasVersionSeries() throws Exception
Exception
OwVersion getVersion() throws Exception
Exception
OwProperty getProperty(String strPropertyName_p) throws Exception
strPropertyName_p
- the name of the requested propertyException
OwPropertyCollection getProperties(Collection propertyNames_p) throws Exception
propertyNames_p
- a collection of property names to retrieve, if null all properties are retrievedException
OwPropertyCollection getClonedProperties(Collection propertyNames_p) throws Exception
propertyNames_p
- a collection of property names to retrieve, if null all properties are retrievedException
void setProperties(OwPropertyCollection properties_p) throws Exception
properties_p
- OwPropertyList list of OwProperties to setException
void setProperties(OwPropertyCollection properties_p, Object mode_p) throws Exception
properties_p
- OwPropertyList list of OwProperties to setmode_p
- mode to use or null to use default mode, @see OwObjectClass.getModes(int)
Exception
boolean canSetProperties(int iContext_p) throws Exception
iContext_p
- OwStatusContextDefinitionsException
boolean canGetProperties(int iContext_p) throws Exception
iContext_p
- OwStatusContextDefinitionsException
boolean canLock() throws Exception
Exception
boolean setLock(boolean fLock_p) throws Exception
fLock_p
- true to lock it, false to unlock it.Exception
boolean getLock(int iContext_p) throws Exception
iContext_p
- OwStatusContextDefinitionsException
boolean getMyLock(int iContext_p) throws Exception
iContext_p
- OwStatusContextDefinitionsException
String getLockUserID(int iContext_p) throws Exception
iContext_p
- OwStatusContextDefinitionsException
boolean canDelete(int iContext_p) throws Exception
iContext_p
- OwStatusContextDefinitionsException
void removeReference(OwObject oObject_p) throws Exception
oObject_p
- OwObject reference to be removed from this object (folder)Exception
boolean canRemoveReference(OwObject oObject_p, int iContext_p) throws Exception
oObject_p
- OwObject reference to be checked uponiContext_p
- OwStatusContextDefinitionsException
void add(OwObject oObject_p) throws Exception
oObject_p
- OwObject reference to add toException
boolean canAdd(OwObject oObject_p, int iContext_p) throws Exception
oObject_p
- OwObject reference to be addediContext_p
- OwStatusContextDefinitionsException
void move(OwObject oObject_p, OwObject oldParent_p) throws Exception
oObject_p
- OwObject reference to add to this folderoldParent_p
- OwObject Old Parent to remove from, used for move operation, can be nullException
boolean canMove(OwObject oObject_p, OwObject oldParent_p, int iContext_p) throws Exception
oObject_p
- OwObject reference to add tooldParent_p
- OwObject Old Parent to remove from, used for move operation, can be nulliContext_p
- OwStatusContextDefinitionsException
OwSearchTemplate getSearchTemplate() throws Exception
Exception
Collection getColumnInfoList() throws Exception
Exception
OwResource getResource() throws Exception
Exception
OwPermissionCollection getPermissions() throws Exception
Exception
OwPermissionCollection getClonedPermissions() throws Exception
Exception
boolean canGetPermissions() throws Exception
Exception
boolean canSetPermissions() throws Exception
Exception
void setPermissions(OwPermissionCollection permissions_p) throws Exception
permissions_p
- OwPermissionCollection to setException
OwContentCollection getContentCollection() throws Exception
Exception
void setContentCollection(OwContentCollection content_p) throws Exception
content_p
- OwContentCollection to store in the objectException
boolean canSetContent(int iContentType_p, int iContext_p) throws Exception
iContentType_p
- int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)iContext_p
- OwStatusContextDefinitionsException
boolean canGetContent(int iContentType_p, int iContext_p) throws Exception
iContentType_p
- int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)iContext_p
- OwStatusContextDefinitionsException
void refreshProperties() throws Exception
Exception
void refreshProperties(Collection props_p) throws Exception
props_p
- Collection of property names to updateException
Object getNativeObject() throws Exception
Exception
String getPath() throws Exception
Exception
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.