|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.wewebu.ow.server.ecm.OwStandardDecoratorObject
public abstract class OwStandardDecoratorObject
OwObject wrapper to implement a decorator pattern.
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
| Field Summary |
|---|
| Fields inherited from interface com.wewebu.ow.server.ecm.OwObject |
|---|
STANDARD_PATH_DELIMITER |
| Fields inherited from interface com.wewebu.ow.server.field.OwFieldProvider |
|---|
TYPE_AJAX, TYPE_CHECKIN_OBJECT, TYPE_CREATE_OBJECT, TYPE_META_OBJECT, TYPE_RESULT_LIST, TYPE_SEARCH, TYPE_SMALL |
| Constructor Summary | |
|---|---|
OwStandardDecoratorObject()
|
|
| Method Summary | |
|---|---|
void |
add(OwObject object_p)
adds a object reference to this parent object (folder) |
boolean |
canAdd(OwObject object_p,
int context_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 context_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 contentType_p,
int context_p)
check if content retrieval is allowed |
boolean |
canGetPermissions()
check if permissions are accessible |
boolean |
canGetProperties(int context_p)
check if property retrieval is allowed |
boolean |
canLock()
check if object supports lock mechanism |
boolean |
canMove(OwObject object_p,
OwObject oldParent_p,
int context_p)
check if move operation is allowed |
boolean |
canRemoveReference(OwObject object_p,
int context_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 contentType_p,
int context_p)
check if content can be set on this document with setContent |
boolean |
canSetPermissions()
check if permissions can be set |
boolean |
canSetProperties(int context_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[] objectTypes_p,
int context_p)
get the number of children |
OwObjectCollection |
getChilds(int[] objectTypes_p,
Collection propertyNames_p,
OwSort sort_p,
int maxSize_p,
int versionSelection_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 |
String |
getDMSID()
get the ECM specific ID of the Object. |
OwField |
getField(String strFieldClassName_p)
get a field with the given field definition class name |
String |
getFieldProviderName()
get a name that identifies the field provider, e.g. |
Object |
getFieldProviderSource()
get the source object that originally provided the fields. |
int |
getFieldProviderType()
get the type of field provider can be one or more of 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 |
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 |
boolean |
getLock(int context_p)
get the lock state of the object for ALL users |
String |
getLockUserID(int context_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 context_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 NOTE: 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 |
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 |
String |
getResourceID()
get the ID / name identifying the resource the object belongs to |
Object |
getSafeFieldValue(String name_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 |
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 |
abstract OwObject |
getWrappedObject()
to be overridden |
boolean |
hasChilds(int[] objectTypes_p,
int context_p)
check if object has children |
boolean |
hasContent(int context_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 |
move(OwObject object_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 object_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 |
void |
setField(String name_p,
Object value_p)
modify a Field value, but does not save the value right away |
boolean |
setLock(boolean lock_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 |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public OwStandardDecoratorObject()
| Method Detail |
|---|
public abstract OwObject getWrappedObject()
public boolean canAdd(OwObject object_p,
int context_p)
throws Exception
OwObject
canAdd in interface OwObjectobject_p - OwObject reference to be addedcontext_p - OwStatusContextDefinitions
Exception
public void add(OwObject object_p)
throws Exception
OwObject
add in interface OwObjectobject_p - OwObject reference to add to
Exception
public boolean canChangeClass()
throws Exception
OwObject
canChangeClass in interface OwObjectException
public void setProperties(OwPropertyCollection properties_p,
Object mode_p)
throws Exception
OwObject
setProperties in interface OwObjectproperties_p - OwPropertyList list of OwProperties to setmode_p - mode to use or null to use default mode, @see OwObjectClass.getModes(int)
Exception
public boolean canDelete(int context_p)
throws Exception
OwObject
canDelete in interface OwObjectcontext_p - OwStatusContextDefinitions
Exception
public boolean canFilterChilds()
throws Exception
OwObject
canFilterChilds in interface OwObjectException
public boolean canGetContent(int contentType_p,
int context_p)
throws Exception
OwObject
canGetContent in interface OwObjectcontentType_p - int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)context_p - OwStatusContextDefinitions
Exception
public boolean canGetPermissions()
throws Exception
OwObject
canGetPermissions in interface OwObjectException
public boolean canGetProperties(int context_p)
throws Exception
OwObject
canGetProperties in interface OwObjectcontext_p - OwStatusContextDefinitions
Exception
public boolean canLock()
throws Exception
OwObject
canLock in interface OwObjectException
public boolean canMove(OwObject object_p,
OwObject oldParent_p,
int context_p)
throws Exception
OwObject
canMove in interface OwObjectobject_p - OwObject reference to add tooldParent_p - OwObject Old Parent to remove from, used for move operation, can be nullcontext_p - OwStatusContextDefinitions
Exception
public boolean canRemoveReference(OwObject object_p,
int context_p)
throws Exception
OwObject
canRemoveReference in interface OwObjectobject_p - OwObject reference to be checked uponcontext_p - OwStatusContextDefinitions
Exception
public boolean canSetContent(int contentType_p,
int context_p)
throws Exception
OwObject
canSetContent in interface OwObjectcontentType_p - int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)context_p - OwStatusContextDefinitions
Exception
public boolean canSetPermissions()
throws Exception
OwObject
canSetPermissions in interface OwObjectException
public boolean canSetProperties(int context_p)
throws Exception
OwObject
canSetProperties in interface OwObjectcontext_p - OwStatusContextDefinitions
Exception
public void changeClass(String strNewClassName_p,
OwPropertyCollection properties_p,
OwPermissionCollection permissions_p)
throws Exception
OwObject
changeClass in interface OwObjectproperties_p - OwPropertyCollection (optional, can be null to set previous properties)permissions_p - OwPermissionCollection (optional, can be null to set previous permissions)
Exception
public void delete()
throws Exception
OwObject
delete in interface OwObjectException
public int getChildCount(int[] objectTypes_p,
int context_p)
throws Exception
OwObject
getChildCount in interface OwObjectobjectTypes_p - the requested object types (folder or document)context_p - OwStatusContextDefinitions
Exception
public OwObjectCollection getChilds(int[] objectTypes_p,
Collection propertyNames_p,
OwSort sort_p,
int maxSize_p,
int versionSelection_p,
OwSearchNode filterCriteria_p)
throws Exception
OwObject
getChilds in interface OwObjectobjectTypes_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 listmaxSize_p - int maximum number of objects to retrieveversionSelection_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 node
Exceptionpublic String getClassName()
OwObject
getClassName in interface OwObject
public OwPermissionCollection getClonedPermissions()
throws Exception
OwObject
getClonedPermissions in interface OwObjectException
public OwPropertyCollection getClonedProperties(Collection propertyNames_p)
throws Exception
OwObject
getClonedProperties in interface OwObjectpropertyNames_p - a collection of property names to retrieve, if null all properties are retrieved
Exception
public Collection getColumnInfoList()
throws Exception
OwObject
getColumnInfoList in interface OwObjectException
public OwContentCollection getContentCollection()
throws Exception
OwObject
getContentCollection in interface OwObjectException
public Collection getFilterProperties(Collection propertynames_p)
throws Exception
OwObject
getFilterProperties in interface OwObjectpropertynames_p - Collection of property names the client wants to use as filter properties or null to retrieve all possible filter properties
Exception
public boolean getLock(int context_p)
throws Exception
OwObject
getLock in interface OwObjectcontext_p - OwStatusContextDefinitions
Exception
public String getLockUserID(int context_p)
throws Exception
OwObject
getLockUserID in interface OwObjectcontext_p - OwStatusContextDefinitions
Exception
public boolean getMyLock(int context_p)
throws Exception
OwObject
getMyLock in interface OwObjectcontext_p - OwStatusContextDefinitions
Exception
public Object getNativeObject()
throws Exception
OwObject
getNativeObject in interface OwObjectExceptionpublic OwObjectClass getObjectClass()
OwObject
getObjectClass in interface OwObject
public OwObjectCollection getParents()
throws Exception
OwObject
getParents in interface OwObjectException
public String getPath()
throws Exception
OwObject
getPath in interface OwObjectException
public OwPermissionCollection getPermissions()
throws Exception
OwObject
getPermissions in interface OwObjectException
public OwPropertyCollection getProperties(Collection propertyNames_p)
throws Exception
OwObject
getProperties in interface OwObjectpropertyNames_p - a collection of property names to retrieve, if null all properties are retrieved
Exception
public OwProperty getProperty(String strPropertyName_p)
throws Exception
OwObject
getProperty in interface OwObjectstrPropertyName_p - the name of the requested property
Exception
public OwResource getResource()
throws Exception
OwObject
getResource in interface OwObjectException
public OwSearchTemplate getSearchTemplate()
throws Exception
OwObject
getSearchTemplate in interface OwObjectException
public OwVersion getVersion()
throws Exception
OwObject
getVersion in interface OwObjectException
public OwVersionSeries getVersionSeries()
throws Exception
OwObject
getVersionSeries in interface OwObjectException
public boolean hasChilds(int[] objectTypes_p,
int context_p)
throws Exception
OwObject
hasChilds in interface OwObjectobjectTypes_p - the requested object types (folder or document)context_p - int as defined in OwStatusContextDefinitions
Exception
public boolean hasVersionSeries()
throws Exception
OwObject
hasVersionSeries in interface OwObjectException
public void move(OwObject object_p,
OwObject oldParent_p)
throws Exception
OwObject
move in interface OwObjectobject_p - OwObject reference to add to this folderoldParent_p - OwObject Old Parent to remove from, used for move operation, can be null
Exception
public void refreshProperties()
throws Exception
OwObject
refreshProperties in interface OwObjectException
public void refreshProperties(Collection props_p)
throws Exception
OwObject
refreshProperties in interface OwObjectprops_p - Collection of property names to update
Exception
public void removeReference(OwObject object_p)
throws Exception
OwObject
removeReference in interface OwObjectobject_p - OwObject reference to be removed from this object (folder)
Exception
public void setContentCollection(OwContentCollection content_p)
throws Exception
OwObject
setContentCollection in interface OwObjectcontent_p - OwContentCollection to store in the object
Exception
public boolean setLock(boolean lock_p)
throws Exception
OwObject
setLock in interface OwObjectlock_p - true to lock it, false to unlock it.
Exception
public void setPermissions(OwPermissionCollection permissions_p)
throws Exception
OwObject
setPermissions in interface OwObjectpermissions_p - OwPermissionCollection to set
Exception
public void setProperties(OwPropertyCollection properties_p)
throws Exception
OwObject
setProperties in interface OwObjectproperties_p - OwPropertyList list of OwProperties to set
Exception
public String getDMSID()
throws Exception
OwObjectReference
getDMSID in interface OwObjectReferenceExceptionpublic String getID()
OwObjectReference
getID in interface OwObjectReference
public OwObject getInstance()
throws Exception
OwObjectReference
getInstance in interface OwObjectReferenceException
public String getMIMEParameter()
throws Exception
OwObjectReference
getMIMEParameter in interface OwObjectReferenceException
public String getMIMEType()
throws Exception
OwObjectReference
getMIMEType in interface OwObjectReferenceExceptionpublic String getName()
OwObjectReference
getName in interface OwObjectReference
public int getPageCount()
throws Exception
OwObjectReference
getPageCount in interface OwObjectReferenceException
public String getResourceID()
throws Exception
OwObjectReference
getResourceID in interface OwObjectReferenceExceptionOwResourcepublic int getType()
OwObjectReference
getType in interface OwObjectReference
public boolean hasContent(int context_p)
throws Exception
OwObjectReference
hasContent in interface OwObjectReferencecontext_p - OwStatusContextDefinitions
Exception
public OwField getField(String strFieldClassName_p)
throws Exception,
OwObjectNotFoundException
OwFieldProvider
getField in interface OwFieldProviderstrFieldClassName_p - String class name of requested fields
Exception
OwObjectNotFoundExceptionpublic String getFieldProviderName()
OwFieldProvider
getFieldProviderName in interface OwFieldProviderpublic Object getFieldProviderSource()
OwFieldProvider
getFieldProviderSource in interface OwFieldProviderpublic int getFieldProviderType()
OwFieldProvider
getFieldProviderType in interface OwFieldProvider
public Collection getFields()
throws Exception
OwFieldProvider
getFields in interface OwFieldProviderException
public Object getSafeFieldValue(String name_p,
Object defaultvalue_p)
OwFieldProvider
getSafeFieldValue in interface OwFieldProvider
public void setField(String name_p,
Object value_p)
throws Exception,
OwObjectNotFoundException
OwFieldProvider
setField in interface OwFieldProviderException
OwObjectNotFoundException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||