com.wewebu.ow.server.history
Class OwStandardHistoryEntry

java.lang.Object
  extended by com.wewebu.ow.server.history.OwStandardHistoryEntry
All Implemented Interfaces:
OwObject, OwObjectReference, OwFieldProvider, OwHistoryEntry
Direct Known Subclasses:
OwSessionHistoryEntry

public class OwStandardHistoryEntry
extends Object
implements OwHistoryEntry

Standard implementation of the OwHistoryEntry interface.

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


Nested Class Summary
static class OwStandardHistoryEntry.OwStandardHistoryEntryObjectClass
           Object class description of history entry.
static class OwStandardHistoryEntry.OwStandardHistoryEntryPropertyClass
           Property class description of history entry object properties.
 
Field Summary
static String CARDINALITY_ARRAY
          cardinality serialize string to be written to the database
static String CARDINALITY_SCALAR
          cardinality serialize string to be written to the database
 
Fields inherited from interface com.wewebu.ow.server.ecm.OwObject
STANDARD_PATH_DELIMITER
 
Fields inherited from interface com.wewebu.ow.server.ecm.OwObjectReference
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
 
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
OwStandardHistoryEntry(OwHistoryManagerContext context_p, Date time_p, String id_p, int iType_p, int iStatus_p, String strSummary_p, String strUser_p)
          construct a history entry for non modifying or generic events
OwStandardHistoryEntry(OwHistoryManagerContext context_p, Date time_p, String id_p, int iType_p, int iStatus_p, String strSummary_p, String strUser_p, OwObjectReference parent_p, Collection objects_p)
          construct a history entry for object modifying events
OwStandardHistoryEntry(OwHistoryManagerContext context_p, Date time_p, String id_p, int iType_p, int iStatus_p, String strSummary_p, String strUser_p, OwObjectReference object_p, OwFieldDefinitionProvider fielddefinitionprovider_p, String sResource_p, Collection propertycardinalitiesandnames_p, Collection oldProperties_p, Collection newProperties_p)
          construct a history entry for property modifying events
 
Method Summary
 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
 boolean canUndo()
          checks if the underlying event can be undone
 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 strPropertyNames_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)
          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 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 iContext_p)
          get the lock state of the object for ALL users
 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 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 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
static OwObjectClass getStaticObjectClass()
           
 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
 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 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
 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)
          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
protected  void setProperty(String strClassName_p, Object value_p)
          set a property in the history object
 void undo()
          rewinds the the underlying event to the state before it occurred
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CARDINALITY_SCALAR

public static final String CARDINALITY_SCALAR
cardinality serialize string to be written to the database

See Also:
Constant Field Values

CARDINALITY_ARRAY

public static final String CARDINALITY_ARRAY
cardinality serialize string to be written to the database

See Also:
Constant Field Values
Constructor Detail

OwStandardHistoryEntry

public OwStandardHistoryEntry(OwHistoryManagerContext context_p,
                              Date time_p,
                              String id_p,
                              int iType_p,
                              int iStatus_p,
                              String strSummary_p,
                              String strUser_p,
                              OwObjectReference parent_p,
                              Collection objects_p)
                       throws Exception
construct a history entry for object modifying events

Parameters:
time_p - time of the event
id_p - pluginid or function name the invoked event
iType_p - type of the event as specified in OwEventManager.HISTORY_EVENT_TYPE_...
iStatus_p - type of the event as specified in OwEventManager.HISTORY_STATUS_...
strSummary_p - of the event as specified in OwEvent
parent_p - OwObjectReference as specified in OwHistoryObjectChangeEvent
objects_p - Collection of modified OwObjectReference's as specified in OwHistoryObjectChangeEvent
Throws:
Exception

OwStandardHistoryEntry

public OwStandardHistoryEntry(OwHistoryManagerContext context_p,
                              Date time_p,
                              String id_p,
                              int iType_p,
                              int iStatus_p,
                              String strSummary_p,
                              String strUser_p,
                              OwObjectReference object_p,
                              OwFieldDefinitionProvider fielddefinitionprovider_p,
                              String sResource_p,
                              Collection propertycardinalitiesandnames_p,
                              Collection oldProperties_p,
                              Collection newProperties_p)
                       throws Exception
construct a history entry for property modifying events

Parameters:
time_p - time of the event
id_p - pluginid or function name the invoked event
iType_p - type of the event as specified in OwEventManager.HISTORY_EVENT_TYPE_...
iStatus_p - type of the event as specified in OwEventManager.HISTORY_STATUS_...
strSummary_p - of the event as specified in OwEvent
object_p - modified OwObjectReference as specified in OwHistoryPropertyChangeEvent
fielddefinitionprovider_p - OwFieldDefinitionProvider to lookup the property definitions
sResource_p - String name of the resource to lookup the property definitions, or null to use default resource
propertycardinalitiesandnames_p - Collection of modified property cardinality and names as specified in CARDINALITY_.... Each cardinality follows a propertyname. in case of an array, the values are delimited with OwEscapedStringTokenizer.STANDARD_DELIMITER
oldProperties_p - Collection of modified string values specified in OwHistoryPropertyChangeEvent
newProperties_p - Collection of modified string values as specified in OwHistoryPropertyChangeEvent
Throws:
Exception

OwStandardHistoryEntry

public OwStandardHistoryEntry(OwHistoryManagerContext context_p,
                              Date time_p,
                              String id_p,
                              int iType_p,
                              int iStatus_p,
                              String strSummary_p,
                              String strUser_p)
                       throws Exception
construct a history entry for non modifying or generic events

Parameters:
time_p - time of the event
id_p - pluginid or function name the invoked event
iType_p - type of the event as specified in OwEventManager.HISTORY_EVENT_TYPE_...
iStatus_p - type of the event as specified in OwEventManager.HISTORY_STATUS_...
strSummary_p - of the event as specified in OwEvent
Throws:
Exception
Method Detail

setProperty

protected void setProperty(String strClassName_p,
                           Object value_p)
                    throws Exception
set a property in the history object

Throws:
Exception

add

public void add(OwObject oObject_p)
         throws Exception
Description copied from interface: OwObject
adds a object reference to this parent object (folder)

Specified by:
add in interface OwObject
Parameters:
oObject_p - OwObject reference to add to
Throws:
Exception

canAdd

public boolean canAdd(OwObject oObject_p,
                      int iContext_p)
               throws Exception
Description copied from interface: OwObject
checks if object supports add function and if user has sufficient access rights

Specified by:
canAdd in interface OwObject
Parameters:
oObject_p - OwObject reference to be added
iContext_p - OwStatusContextDefinitions
Returns:
true if object supports add function
Throws:
Exception

canDelete

public boolean canDelete(int iContext_p)
                  throws Exception
Description copied from interface: OwObject
check if object can be deleted and if user has sufficient access rights

Specified by:
canDelete in interface OwObject
Parameters:
iContext_p - OwStatusContextDefinitions
Returns:
true, if delete operation works on object
Throws:
Exception

canFilterChilds

public boolean canFilterChilds()
                        throws Exception
Description copied from interface: OwObject
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

Specified by:
canFilterChilds in interface OwObject
Returns:
true = filter children with FilterCriteria_p is possible, false = filter is not possible / ignored
Throws:
Exception

getFilterProperties

public Collection getFilterProperties(Collection propertynames_p)
                               throws Exception
get a collection of OwFieldDefinition's for a given list of names

Specified by:
getFilterProperties in interface OwObject
Parameters:
propertynames_p - Collection of property names the client wants to use as filter properties or null to retrieve all possible filter properties
Returns:
Collection of OwFieldDefinition's that can actually be filtered, may be a subset of propertynames_p, or null if no filter properties are allowed
Throws:
Exception

canGetContent

public boolean canGetContent(int iContentType_p,
                             int iContext_p)
                      throws Exception
Description copied from interface: OwObject
check if content retrieval is allowed

Specified by:
canGetContent in interface OwObject
Parameters:
iContentType_p - int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)
iContext_p - OwStatusContextDefinitions
Returns:
true if allowed
Throws:
Exception

canGetPermissions

public boolean canGetPermissions()
                          throws Exception
Description copied from interface: OwObject
check if permissions are accessible

Specified by:
canGetPermissions in interface OwObject
Returns:
true = permissions can be retrieved
Throws:
Exception

canGetProperties

public boolean canGetProperties(int iContext_p)
                         throws Exception
Description copied from interface: OwObject
check if property retrieval is allowed

Specified by:
canGetProperties in interface OwObject
Parameters:
iContext_p - OwStatusContextDefinitions
Returns:
true if allowed
Throws:
Exception

canLock

public boolean canLock()
                throws Exception
Description copied from interface: OwObject
check if object supports lock mechanism

Specified by:
canLock in interface OwObject
Returns:
true, if object supports lock, i.e. the setLock function works
Throws:
Exception

canMove

public boolean canMove(OwObject oObject_p,
                       OwObject oldParent_p,
                       int iContext_p)
                throws Exception
Description copied from interface: OwObject
check if move operation is allowed

Specified by:
canMove in interface OwObject
Parameters:
oObject_p - OwObject reference to add to
oldParent_p - OwObject Old Parent to remove from, used for move operation, can be null
iContext_p - OwStatusContextDefinitions
Throws:
Exception

canRemoveReference

public boolean canRemoveReference(OwObject oObject_p,
                                  int iContext_p)
                           throws Exception
Description copied from interface: OwObject
checks if the reference can be removed this object needs to be parent of given object, and user needs to have sufficient access rights

Specified by:
canRemoveReference in interface OwObject
Parameters:
oObject_p - OwObject reference to be checked upon
iContext_p - OwStatusContextDefinitions
Returns:
true, if given OwObject reference can be removed from this object (folder)
Throws:
Exception

canSetContent

public boolean canSetContent(int iContentType_p,
                             int iContext_p)
                      throws Exception
Description copied from interface: OwObject
check if content can be set on this document with setContent

Specified by:
canSetContent in interface OwObject
Parameters:
iContentType_p - int designating the type of content (CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_ANNOTATION,...)
iContext_p - OwStatusContextDefinitions
Returns:
true, if content can be set with setContent
Throws:
Exception

canSetPermissions

public boolean canSetPermissions()
                          throws Exception
Description copied from interface: OwObject
check if permissions can be set

Specified by:
canSetPermissions in interface OwObject
Returns:
true = permissions can be set
Throws:
Exception

canSetProperties

public boolean canSetProperties(int iContext_p)
                         throws Exception
Description copied from interface: OwObject
check if object allows to set / change properties

Specified by:
canSetProperties in interface OwObject
Parameters:
iContext_p - OwStatusContextDefinitions
Returns:
true if allowed
Throws:
Exception

canUndo

public boolean canUndo()
                throws Exception
Description copied from interface: OwHistoryEntry
checks if the underlying event can be undone

Specified by:
canUndo in interface OwHistoryEntry
Throws:
Exception

delete

public void delete()
            throws Exception
Description copied from interface: OwObject
delete object and all references from DB

Specified by:
delete in interface OwObject
Throws:
Exception

getChilds

public OwObjectCollection getChilds(int[] iObjectTypes_p,
                                    Collection propertyNames_p,
                                    OwSort sort_p,
                                    int iMaxSize_p,
                                    int iVersionSelection_p,
                                    OwSearchNode filterCriteria_p)
                             throws Exception
Description copied from interface: OwObject
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

Specified by:
getChilds in interface OwObject
Parameters:
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 list
iMaxSize_p - int maximum number of objects to retrieve
iVersionSelection_p - int Selects the versions as defined in OwSearchTemplate.VERSION_SELECT_... or 0 to use default version
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 node
Returns:
list of child objects, or null
Throws:
Exception

getClassName

public String getClassName()
Description copied from interface: OwObject
get the class name of the object, the class names are defined by the ECM System

Specified by:
getClassName in interface OwObject
Returns:
class name of object class

getClonedPermissions

public OwPermissionCollection getClonedPermissions()
                                            throws Exception
Description copied from interface: OwObject
get the cloned permissions

Specified by:
getClonedPermissions in interface OwObject
Returns:
OwPermissionCollection clone of the object
Throws:
Exception

getClonedProperties

public OwPropertyCollection getClonedProperties(Collection strPropertyNames_p)
                                         throws Exception
Description copied from interface: OwObject
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. by OwNetwork.doSearch(...,PropertyList)), than the ECM Adapter has to launch a new query. It is therefore best practice to obtain the needed properties in advance in a call to OwNetwork.doSearch(...)

Specified by:
getClonedProperties in interface OwObject
Parameters:
strPropertyNames_p - a collection of property names to retrieve, if null all properties are retrieved
Returns:
a property list
Throws:
Exception

getColumnInfoList

public Collection getColumnInfoList()
                             throws Exception
Description copied from interface: OwObject
get the column info list that describes the columns for the child list

Specified by:
getColumnInfoList in interface OwObject
Returns:
List of OwFieldColumnInfo, or null if not defined
Throws:
Exception

getContentCollection

public OwContentCollection getContentCollection()
                                         throws Exception
Description copied from interface: OwObject
get the content of the object

Specified by:
getContentCollection in interface OwObject
Returns:
OwContentCollection
Throws:
Exception

getDMSID

public String getDMSID()
                throws Exception
Description copied from interface: OwObjectReference
get the ECM specific ID of the Object. The DMSID is not interpreted by the Workdesk, nor does the Workdesk need to know the syntax. However, it must hold enough information, so that the ECM Adapter is able to reconstruct the Object. The reconstruction is done through OwNetwork.createObjectFromDMSID(...) The Workdesk uses the DMSID to store ObjectReferences as Strings. E.g.: in the task databases. The syntax of the ID is up to the ECM Adapter, but would usually be made up like the following:

Specified by:
getDMSID in interface OwObjectReference
Throws:
Exception

getFieldProviderType

public int getFieldProviderType()
Description copied from interface: OwFieldProvider
get the type of field provider can be one or more of TYPE_...

Specified by:
getFieldProviderType in interface OwFieldProvider

getFieldProviderName

public String getFieldProviderName()
get a name that identifies the field provider, can be used to create IDs

Specified by:
getFieldProviderName in interface OwFieldProvider
Returns:
String unique ID / Name of fieldprovider

getFieldProviderSource

public Object getFieldProviderSource()
get the source object that originally provided the fields. e.g. the fieldprovider might be a template pattern implementation like a view, where the original provider would still be an OwObject

Specified by:
getFieldProviderSource in interface OwFieldProvider
Returns:
Object the original source object where the fields have been taken, can be a this pointer

getField

public OwField getField(String strFieldClassName_p)
                 throws Exception,
                        OwObjectNotFoundException
implementation of the OwFieldProvider interface get a field with the given field definition class name

Specified by:
getField in interface OwFieldProvider
Parameters:
strFieldClassName_p - String class name of requested fields
Returns:
OwField or throws OwObjectNotFoundException
Throws:
Exception
OwObjectNotFoundException

getLock

public boolean getLock(int iContext_p)
                throws Exception
Description copied from interface: OwObject
get the lock state of the object for ALL users

Specified by:
getLock in interface OwObject
Parameters:
iContext_p - OwStatusContextDefinitions
Returns:
the lock state of the object
Throws:
Exception

getMyLock

public boolean getMyLock(int iContext_p)
                  throws Exception
get the lock state of the object for the CURRENTLY logged on user

Specified by:
getMyLock in interface OwObject
Parameters:
iContext_p - OwStatusContextDefinitions
Returns:
the lock state of the object
Throws:
Exception

getLockUserID

public String getLockUserID(int iContext_p)
                     throws Exception
get the lock user of the object

Specified by:
getLockUserID in interface OwObject
Parameters:
iContext_p - OwStatusContextDefinitions
Returns:
the User ID of the user who locked the item, or null if it is not locked
Throws:
Exception

getMIMEParameter

public String getMIMEParameter()
                        throws Exception
Description copied from interface: OwObjectReference
get the additional MIME Parameter of the Object

Specified by:
getMIMEParameter in interface OwObjectReference
Returns:
MIME Parameter as String
Throws:
Exception

getMIMEType

public String getMIMEType()
                   throws Exception
Description copied from interface: OwObjectReference
get the MIME Type of the Object

Specified by:
getMIMEType in interface OwObjectReference
Returns:
MIME Type as String
Throws:
Exception

getName

public String getName()
Description copied from interface: OwObjectReference
get Object name property string

Specified by:
getName in interface OwObjectReference
Returns:
the name property string of the object

getNativeObject

public Object getNativeObject()
                       throws Exception
Description copied from interface: OwObject
get the native object from the ECM system NOTE: The returned object is Opaque. Using the native object makes the client dependent on the ECM System

Specified by:
getNativeObject in interface OwObject
Returns:
Object native to the ECM System
Throws:
Exception

getObjectClass

public OwObjectClass getObjectClass()
Description copied from interface: OwObject
get the class description of the object, the class descriptions are defined by the ECM System

Specified by:
getObjectClass in interface OwObject
Returns:
class description name of object class

getStaticObjectClass

public static OwObjectClass getStaticObjectClass()
                                          throws Exception
Throws:
Exception

getPageCount

public int getPageCount()
                 throws Exception
Description copied from interface: OwObjectReference
retrieve the number of pages in the objects

Specified by:
getPageCount in interface OwObjectReference
Returns:
number of pages
Throws:
Exception

getParents

public OwObjectCollection getParents()
                              throws Exception
Description copied from interface: OwObject
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.

Specified by:
getParents in interface OwObject
Returns:
Parent Object, or null if object does not have any parents
Throws:
Exception

getPermissions

public OwPermissionCollection getPermissions()
                                      throws Exception
Description copied from interface: OwObject
get the permissions object

Specified by:
getPermissions in interface OwObject
Returns:
OwPermissionCollection of the object
Throws:
Exception

getProperties

public OwPropertyCollection getProperties(Collection propertyNames_p)
                                   throws Exception
Description copied from interface: OwObject
retrieve the specified properties from the object. 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. by OwNetwork.doSearch(...,PropertyList)), than the ECM Adapter has to launch a new query. It is therefore best practice to obtain the needed properties in advance in a call to OwNetwork.doSearch(...)

Specified by:
getProperties in interface OwObject
Parameters:
propertyNames_p - a collection of property names to retrieve, if null all properties are retrieved
Returns:
a property list
Throws:
Exception

getProperty

public OwProperty getProperty(String strPropertyName_p)
                       throws Exception
Description copied from interface: OwObject
retrieve the specified property from the object. NOTE: if the property was not already obtained from the archive (e.g. by OwNetwork.doSearch(...,PropertyList)), than the ECM Adapter has to launch a new query. It is therefore best practice to obtain the needed properties in advance in a call to OwNetwork.doSearch(...) ==> Alternatively you can use the getProperties Function to retrieve a whole bunch of properties in one step, making the ECM adaptor use only one new query.

Specified by:
getProperty in interface OwObject
Parameters:
strPropertyName_p - the name of the requested property
Returns:
a property object
Throws:
Exception

getResource

public OwResource getResource()
                       throws Exception
Description copied from interface: OwObject
get the resource the object belongs to in a multiple resource Network

Specified by:
getResource in interface OwObject
Returns:
OwResource to identify the resource, or null for the default resource
Throws:
Exception

getSearchTemplate

public OwSearchTemplate getSearchTemplate()
                                   throws Exception
Description copied from interface: OwObject
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

Specified by:
getSearchTemplate in interface OwObject
Returns:
OwSearchTemplate or null if not defined for the object
Throws:
Exception

getID

public String getID()
Description copied from interface: OwObjectReference
get Object symbolic name of the object which is unique among its siblings used for path construction

Specified by:
getID in interface OwObjectReference
Returns:
the symbolic name of the object which is unique among its siblings

getType

public int getType()
Description copied from interface: OwObjectReference
get Object type

Specified by:
getType in interface OwObjectReference
Returns:
the type of the object

getVersion

public OwVersion getVersion()
                     throws Exception
Description copied from interface: OwObject
get the current version object

Specified by:
getVersion in interface OwObject
Returns:
OwVersion Object identifying the currently set version, or null if versions not supported
Throws:
Exception

getVersionSeries

public OwVersionSeries getVersionSeries()
                                 throws Exception
Description copied from interface: OwObject
get the version series object to this object, if the object is versionable

Specified by:
getVersionSeries in interface OwObject
Returns:
a list of object versions, or null if object contains no versions
Throws:
Exception

hasContent

public boolean hasContent(int iContext_p)
                   throws Exception
check if the object contains a content, which can be retrieved using getContentCollection

Specified by:
hasContent in interface OwObjectReference
Parameters:
iContext_p - OwStatusContextDefinitions
Returns:
boolean true = object contains content, false = object has no content
Throws:
Exception

hasVersionSeries

public boolean hasVersionSeries()
                         throws Exception
Description copied from interface: OwObject
check if a version series object is available, i.e. the object is versionable

Specified by:
hasVersionSeries in interface OwObject
Returns:
true if object is versionable
Throws:
Exception

move

public void move(OwObject oObject_p,
                 OwObject oldParent_p)
          throws Exception
Description copied from interface: OwObject
moves a object reference to this parent object (folder)

Specified by:
move in interface OwObject
Parameters:
oObject_p - OwObject reference to add to this folder
oldParent_p - OwObject Old Parent to remove from, used for move operation, can be null
Throws:
Exception

refreshProperties

public void refreshProperties()
                       throws Exception
Description copied from interface: OwObject
refresh the property cache

Specified by:
refreshProperties in interface OwObject
Throws:
Exception

refreshProperties

public void refreshProperties(Collection props_p)
                       throws Exception
refresh the property cache

Specified by:
refreshProperties in interface OwObject
Parameters:
props_p - Collection of property names to update
Throws:
Exception

removeReference

public void removeReference(OwObject oObject_p)
                     throws Exception
Description copied from interface: OwObject
removes the reference of the given object from this object (folder) this object needs to be parent of given object

Specified by:
removeReference in interface OwObject
Parameters:
oObject_p - OwObject reference to be removed from this object (folder)
Throws:
Exception

setContentCollection

public void setContentCollection(OwContentCollection content_p)
                          throws Exception
Description copied from interface: OwObject
set the content to the object

Specified by:
setContentCollection in interface OwObject
Parameters:
content_p - OwContentCollection to store in the object
Throws:
Exception

setLock

public boolean setLock(boolean fLock_p)
                throws Exception
Description copied from interface: OwObject
lock / unlock object, make it unaccessible for other users

Specified by:
setLock in interface OwObject
Parameters:
fLock_p - true to lock it, false to unlock it.
Returns:
the new lock state of the object
Throws:
Exception

setPermissions

public void setPermissions(OwPermissionCollection permissions_p)
                    throws Exception
Description copied from interface: OwObject
set the permissions object

Specified by:
setPermissions in interface OwObject
Parameters:
permissions_p - OwPermissionCollection to set
Throws:
Exception

setProperties

public void setProperties(OwPropertyCollection properties_p)
                   throws Exception
Description copied from interface: OwObject
set the properties in the object

Specified by:
setProperties in interface OwObject
Parameters:
properties_p - OwPropertyList list of OwProperties to set
Throws:
Exception

undo

public void undo()
          throws Exception
Description copied from interface: OwHistoryEntry
rewinds the the underlying event to the state before it occurred

Specified by:
undo in interface OwHistoryEntry
Throws:
Exception

hasChilds

public boolean hasChilds(int[] iObjectTypes_p,
                         int iContext_p)
                  throws Exception
check if object has children

Specified by:
hasChilds in interface OwObject
Parameters:
iContext_p - OwStatusContextDefinitions
iObjectTypes_p - the requested object types (folder or document)
Returns:
true, object has children
Throws:
Exception

getPath

public String getPath()
               throws Exception
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. Unlike the symbol name and the dmsid, the path is not necessarily unique, but provids a readable information of the objects location.

Specified by:
getPath in interface OwObject
Throws:
Exception

getChildCount

public int getChildCount(int[] iObjectTypes_p,
                         int iContext_p)
                  throws Exception
get the number of children

Specified by:
getChildCount in interface OwObject
Parameters:
iObjectTypes_p - the requested object type (folder or document)
iContext_p - OwStatusContextDefinitions
Returns:
int number of children or throws OwStatusContextException
Throws:
Exception

changeClass

public void changeClass(String strNewClassName_p,
                        OwPropertyCollection properties_p,
                        OwPermissionCollection permissions_p)
                 throws Exception
change the class of the object

Specified by:
changeClass in interface OwObject
Parameters:
strNewClassName_p - String class name
properties_p - OwPropertyCollection (optional, can be null to set previous properties)
permissions_p - OwPermissionCollection (optional, can be null to set previous permissions)
Throws:
Exception

canChangeClass

public boolean canChangeClass()
                       throws Exception
check if object can change its class

Specified by:
canChangeClass in interface OwObject
Throws:
Exception

setField

public void setField(String sName_p,
                     Object value_p)
              throws Exception,
                     OwObjectNotFoundException
modify a Field value, but does not save the value right away

Specified by:
setField in interface OwFieldProvider
Parameters:
sName_p -
value_p -
Throws:
Exception
OwObjectNotFoundException

getSafeFieldValue

public Object getSafeFieldValue(String sName_p,
                                Object defaultvalue_p)
retrieve the value of a Field

Specified by:
getSafeFieldValue in interface OwFieldProvider
Parameters:
sName_p -
defaultvalue_p -
Returns:
Object the value of the Field of defaultvalue_p

getFields

public Collection getFields()
                     throws Exception
get all the properties in the form

Specified by:
getFields in interface OwFieldProvider
Returns:
Collection of OwField
Throws:
Exception

getInstance

public OwObject getInstance()
                     throws Exception
get a instance from this reference

Specified by:
getInstance in interface OwObjectReference
Returns:
OwObject or throws OwObjectNotFoundException
Throws:
Exception, - OwObjectNotFoundException
Exception

getResourceID

public String getResourceID()
                     throws Exception
get the ID / name identifying the resource the object belongs to

Specified by:
getResourceID in interface OwObjectReference
Returns:
String ID of resource or throws OwObjectNotFoundException
Throws:
Exception, - OwObjectNotFoundException
Exception
See Also:
OwResource

setProperties

public void setProperties(OwPropertyCollection properties_p,
                          Object mode_p)
                   throws Exception
Description copied from interface: OwObject
set the properties in the object

Specified by:
setProperties in interface OwObject
Parameters:
properties_p - OwPropertyList list of OwProperties to set
mode_p - mode to use or null to use default mode, @see OwObjectClass.getModes(int)
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.