public class OwAddressObject extends Object implements com.wewebu.ow.server.ecm.OwObject
Address Object.
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 OwDummyFileObject.OwDummyFileObjectClass |
m_classDescription
the class description for the object JUST USE THE DUMMY Class
|
protected com.wewebu.ow.server.ecm.OwPropertyCollection |
m_PropertyMap
map with the properties
|
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
Constructor and Description |
---|
OwAddressObject(ResultSet resultset_p,
com.wewebu.ow.server.ui.OwAppContext context_p)
construct a address object from a JDBC resultset
|
Modifier and Type | Method and Description |
---|---|
void |
add(com.wewebu.ow.server.ecm.OwObject oObject_p) |
boolean |
canAdd(com.wewebu.ow.server.ecm.OwObject oObject_p,
int iContext_p) |
boolean |
canChangeClass()
check if object can change its class
|
boolean |
canDelete(int iContext_p) |
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) |
boolean |
canGetPermissions()
check if permissions are accessible
|
boolean |
canGetProperties(int iContext_p) |
boolean |
canLock() |
boolean |
canMove(com.wewebu.ow.server.ecm.OwObject oObject_p,
com.wewebu.ow.server.ecm.OwObject oldParent_p,
int iContext_p) |
boolean |
canRemoveReference(com.wewebu.ow.server.ecm.OwObject oObject_p,
int iContext_p) |
boolean |
canSetContent(int iContentType_p,
int iContext_p) |
boolean |
canSetPermissions()
check if permissions can be set
|
boolean |
canSetProperties(int iContext_p) |
void |
changeClass(String strNewClassName_p,
com.wewebu.ow.server.ecm.OwPropertyCollection properties_p,
com.wewebu.ow.server.ecm.OwPermissionCollection permissions_p)
change the class of the object
|
void |
delete() |
int |
getChildCount(int[] iObjectTypes_p,
int iContext_p)
get the number of children
|
com.wewebu.ow.server.ecm.OwObjectCollection |
getChilds(int[] iObjectTypes_p,
Collection propertyNames_p,
com.wewebu.ow.server.field.OwSort sort_p,
int iMaxSize_p,
int iVersionSelection_p,
com.wewebu.ow.server.field.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() |
com.wewebu.ow.server.ecm.OwPermissionCollection |
getClonedPermissions()
get the cloned permissions
|
com.wewebu.ow.server.ecm.OwPropertyCollection |
getClonedProperties(Collection strPropertyNames_p) |
Collection |
getColumnInfoList() |
com.wewebu.ow.server.ecm.OwContentCollection |
getContentCollection() |
String |
getDMSID() |
com.wewebu.ow.server.field.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 IDs
|
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
|
String |
getID()
get Object symbolic name of the object which is unique among its siblings
used for path construction
|
com.wewebu.ow.server.ecm.OwObject |
getInstance()
get a instance from this reference
|
boolean |
getLock(int iContext_p) |
String |
getLockUserID(int iContext_p)
get the lock user of the object
|
String |
getMIMEParameter() |
String |
getMIMEType() |
boolean |
getMyLock(int iContext_p)
get the lock state of the object for the CURRENTLY logged on user
|
String |
getName() |
Object |
getNativeObject()
get the native object from the ECM system
WARNING: The returned object is Opaque.
|
com.wewebu.ow.server.ecm.OwObjectClass |
getObjectClass() |
int |
getPageCount() |
com.wewebu.ow.server.ecm.OwObjectCollection |
getParents() |
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.
|
com.wewebu.ow.server.ecm.OwPermissionCollection |
getPermissions() |
com.wewebu.ow.server.ecm.OwPropertyCollection |
getProperties(Collection propertyNames_p) |
com.wewebu.ow.server.ecm.OwProperty |
getProperty(String strPropertyName_p) |
com.wewebu.ow.server.ecm.OwResource |
getResource() |
String |
getResourceID()
get the ID / name identifying the resource the object belongs to
|
Object |
getSafeFieldValue(String sName_p,
Object defaultvalue_p)
retrieve the value of a Field
|
com.wewebu.ow.server.field.OwSearchTemplate |
getSearchTemplate() |
int |
getType() |
com.wewebu.ow.server.ecm.OwVersion |
getVersion() |
com.wewebu.ow.server.ecm.OwVersionSeries |
getVersionSeries() |
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() |
void |
move(com.wewebu.ow.server.ecm.OwObject oObject_p,
com.wewebu.ow.server.ecm.OwObject oldParent_p) |
void |
refreshProperties() |
void |
refreshProperties(Collection props_p)
refresh the property cache
|
void |
removeReference(com.wewebu.ow.server.ecm.OwObject oObject_p) |
void |
setContentCollection(com.wewebu.ow.server.ecm.OwContentCollection content_p) |
void |
setField(String sName_p,
Object value_p)
modify a Field value, but does not save the value right away
|
boolean |
setLock(boolean fLock_p) |
void |
setPermissions(com.wewebu.ow.server.ecm.OwPermissionCollection permissions_p)
set the permissions object
|
void |
setProperties(com.wewebu.ow.server.ecm.OwPropertyCollection properties_p) |
void |
setProperties(com.wewebu.ow.server.ecm.OwPropertyCollection properties_p,
Object mode_p) |
public static final OwDummyFileObject.OwDummyFileObjectClass m_classDescription
protected com.wewebu.ow.server.ecm.OwPropertyCollection m_PropertyMap
public String getMIMEType() throws Exception
getMIMEType
in interface com.wewebu.ow.server.ecm.OwObjectReference
Exception
public String getName()
getName
in interface com.wewebu.ow.server.ecm.OwObjectReference
public String getID()
getID
in interface com.wewebu.ow.server.ecm.OwObjectReference
public com.wewebu.ow.server.ecm.OwObjectClass getObjectClass()
getObjectClass
in interface com.wewebu.ow.server.ecm.OwObject
public String getClassName()
getClassName
in interface com.wewebu.ow.server.ecm.OwObject
public com.wewebu.ow.server.ecm.OwPropertyCollection getClonedProperties(Collection strPropertyNames_p) throws Exception
getClonedProperties
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.ecm.OwPropertyCollection getProperties(Collection propertyNames_p) throws Exception
getProperties
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.ecm.OwProperty getProperty(String strPropertyName_p) throws Exception
getProperty
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public int getType()
getType
in interface com.wewebu.ow.server.ecm.OwObjectReference
public void setProperties(com.wewebu.ow.server.ecm.OwPropertyCollection properties_p) throws Exception
setProperties
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public void add(com.wewebu.ow.server.ecm.OwObject oObject_p) throws Exception
add
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canAdd(com.wewebu.ow.server.ecm.OwObject oObject_p, int iContext_p) throws Exception
canAdd
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canDelete(int iContext_p) throws Exception
canDelete
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canGetContent(int iContentType_p, int iContext_p) throws Exception
canGetContent
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canGetProperties(int iContext_p) throws Exception
canGetProperties
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canLock() throws Exception
canLock
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canMove(com.wewebu.ow.server.ecm.OwObject oObject_p, com.wewebu.ow.server.ecm.OwObject oldParent_p, int iContext_p) throws Exception
canMove
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canRemoveReference(com.wewebu.ow.server.ecm.OwObject oObject_p, int iContext_p) throws Exception
canRemoveReference
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canSetContent(int iContentType_p, int iContext_p) throws Exception
canSetContent
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canSetProperties(int iContext_p) throws Exception
canSetProperties
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public void delete() throws Exception
delete
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.ecm.OwObjectCollection getChilds(int[] iObjectTypes_p, Collection propertyNames_p, com.wewebu.ow.server.field.OwSort sort_p, int iMaxSize_p, int iVersionSelection_p, com.wewebu.ow.server.field.OwSearchNode filterCriteria_p) throws Exception
getChilds
in interface com.wewebu.ow.server.ecm.OwObject
iObjectTypes_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 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 boolean canFilterChilds() throws Exception
canFilterChilds
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public Collection getFilterProperties(Collection propertynames_p) throws Exception
getFilterProperties
in interface com.wewebu.ow.server.ecm.OwObject
propertynames_p
- Collection of property names the client wants to use as filter properties or null to retrieve all possible filter propertiesException
public Collection getColumnInfoList() throws Exception
getColumnInfoList
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.ecm.OwContentCollection getContentCollection() throws Exception
getContentCollection
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public String getDMSID() throws Exception
getDMSID
in interface com.wewebu.ow.server.ecm.OwObjectReference
Exception
public boolean getLock(int iContext_p) throws Exception
getLock
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean getMyLock(int iContext_p) throws Exception
getMyLock
in interface com.wewebu.ow.server.ecm.OwObject
iContext_p
- OwStatusContextDefinitionsException
public String getLockUserID(int iContext_p) throws Exception
getLockUserID
in interface com.wewebu.ow.server.ecm.OwObject
iContext_p
- as defined by OwStatusContextDefinitions
Exception
public String getMIMEParameter() throws Exception
getMIMEParameter
in interface com.wewebu.ow.server.ecm.OwObjectReference
Exception
public int getPageCount() throws Exception
getPageCount
in interface com.wewebu.ow.server.ecm.OwObjectReference
Exception
public com.wewebu.ow.server.ecm.OwObjectCollection getParents() throws Exception
getParents
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.ecm.OwPermissionCollection getPermissions() throws Exception
getPermissions
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.ecm.OwPermissionCollection getClonedPermissions() throws Exception
getClonedPermissions
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canGetPermissions() throws Exception
canGetPermissions
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean canSetPermissions() throws Exception
canSetPermissions
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public void setPermissions(com.wewebu.ow.server.ecm.OwPermissionCollection permissions_p) throws Exception
setPermissions
in interface com.wewebu.ow.server.ecm.OwObject
permissions_p
- OwPermissionCollection to setException
public com.wewebu.ow.server.ecm.OwResource getResource() throws Exception
getResource
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.field.OwSearchTemplate getSearchTemplate() throws Exception
getSearchTemplate
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.ecm.OwVersion getVersion() throws Exception
getVersion
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.ecm.OwVersionSeries getVersionSeries() throws Exception
getVersionSeries
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean hasVersionSeries() throws Exception
hasVersionSeries
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public void move(com.wewebu.ow.server.ecm.OwObject oObject_p, com.wewebu.ow.server.ecm.OwObject oldParent_p) throws Exception
move
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public void refreshProperties() throws Exception
refreshProperties
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public void refreshProperties(Collection props_p) throws Exception
refreshProperties
in interface com.wewebu.ow.server.ecm.OwObject
props_p
- Collection of property names to updateException
public void removeReference(com.wewebu.ow.server.ecm.OwObject oObject_p) throws Exception
removeReference
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public void setContentCollection(com.wewebu.ow.server.ecm.OwContentCollection content_p) throws Exception
setContentCollection
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public boolean setLock(boolean fLock_p) throws Exception
setLock
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public Object getNativeObject() throws Exception
getNativeObject
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public com.wewebu.ow.server.field.OwField getField(String strFieldClassName_p) throws Exception, com.wewebu.ow.server.exceptions.OwObjectNotFoundException
getField
in interface com.wewebu.ow.server.field.OwFieldProvider
strFieldClassName_p
- String class name of requested fieldsException
com.wewebu.ow.server.exceptions.OwObjectNotFoundException
public Object getFieldProviderSource()
getFieldProviderSource
in interface com.wewebu.ow.server.field.OwFieldProvider
public int getFieldProviderType()
getFieldProviderType
in interface com.wewebu.ow.server.field.OwFieldProvider
public boolean hasContent(int iContext_p) throws Exception
hasContent
in interface com.wewebu.ow.server.ecm.OwObjectReference
iContext_p
- as defined by OwStatusContextDefinitions
Exception
public boolean hasChilds(int[] iObjectTypes_p, int iContext_p) throws Exception
hasChilds
in interface com.wewebu.ow.server.ecm.OwObject
iContext_p
- OwStatusContextDefinitionsException
public String getPath() throws Exception
getPath
in interface com.wewebu.ow.server.ecm.OwObject
Exception
public int getChildCount(int[] iObjectTypes_p, int iContext_p) throws Exception
getChildCount
in interface com.wewebu.ow.server.ecm.OwObject
iObjectTypes_p
- the requested object type (folder or document)iContext_p
- OwStatusContextDefinitionsint
number of children or throws OwStatusContextExceptionException
public void changeClass(String strNewClassName_p, com.wewebu.ow.server.ecm.OwPropertyCollection properties_p, com.wewebu.ow.server.ecm.OwPermissionCollection permissions_p) throws Exception
changeClass
in interface com.wewebu.ow.server.ecm.OwObject
strNewClassName_p
- new class name as String
properties_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 com.wewebu.ow.server.ecm.OwObject
Exception
public String getFieldProviderName()
getFieldProviderName
in interface com.wewebu.ow.server.field.OwFieldProvider
public void setField(String sName_p, Object value_p) throws Exception, com.wewebu.ow.server.exceptions.OwObjectNotFoundException
setField
in interface com.wewebu.ow.server.field.OwFieldProvider
sName_p
- value_p
- Exception
com.wewebu.ow.server.exceptions.OwObjectNotFoundException
public Object getSafeFieldValue(String sName_p, Object defaultvalue_p)
getSafeFieldValue
in interface com.wewebu.ow.server.field.OwFieldProvider
sName_p
- defaultvalue_p
- public Collection getFields() throws Exception
getFields
in interface com.wewebu.ow.server.field.OwFieldProvider
Exception
public com.wewebu.ow.server.ecm.OwObject getInstance() throws Exception
getInstance
in interface com.wewebu.ow.server.ecm.OwObjectReference
Exception,
- OwObjectNotFoundExceptionException
public String getResourceID() throws Exception
getResourceID
in interface com.wewebu.ow.server.ecm.OwObjectReference
Exception,
- OwObjectNotFoundExceptionException
OwResource
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.