com.wewebu.ow.server.ecm
Interface OwObjectReference

All Known Subinterfaces:
OwHistoryEntry, OwObject, OwObjectLink, OwSemiVirtualFolder, OwUnresolvedReference, OwVirtualFolderObject, OwWorkitem, OwWorkitemContainer
All Known Implementing Classes:
OwFileObject, OwObjectSkeleton, OwSessionHistoryEntry, OwSettingsPropertyObject.OwObjectEntry, OwStandardDecoratorObject, OwStandardHistoryEntry, OwStandardObjectReference, OwStandardUnresolvedReference, OwStandardVirtualFolderObjectFactory

public interface OwObjectReference

Base interface for all ECM Objects. Used to serialize 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


Field Summary
static int OBJECT_TYPE_ALL_CONTAINER_OBJECTS
          object type objects with child objects
static int OBJECT_TYPE_ALL_CONTENT_OBJECTS
          object type objects with content
static int OBJECT_TYPE_ALL_TUPLE_OBJECTS
          object type objects with only metadata
static int OBJECT_TYPE_ALL_WORKFLOW_OBJECTS
          object type objects for workflows
static int OBJECT_TYPE_BPM_ROOT_FOLDER
          object type for the BPM root folder
static int OBJECT_TYPE_CONTAINER_USER_START
          start value for user defined object types
static int OBJECT_TYPE_CONTENT_USER_START
          start value for user defined object types
static int OBJECT_TYPE_CROSS_QUEUE_FOLDER
          object type cross queue object enumerator
static int OBJECT_TYPE_CUSTOM
          object type Custom object enumerator
static int OBJECT_TYPE_DOCUMENT
          object type Document enumerator
static int OBJECT_TYPE_DYNAMIC_VIRTUAL_FOLDER
          an object which is create out of a search
static int OBJECT_TYPE_ECM_ROOT_FOLDER
          object type for the ECM root folder
static int OBJECT_TYPE_FOLDER
          object type physical folder enumerator
static int OBJECT_TYPE_HISTORY
          object type History object enumerator
static int OBJECT_TYPE_LINK
          object type for Link/Relationship/Association objects
static int OBJECT_TYPE_PROXY_QUEUE_FOLDER
          object type proxy queue object enumerator
static int OBJECT_TYPE_PUBLIC_QUEUE_FOLDER
          object type public queue object enumerator
static int OBJECT_TYPE_ROSTER_FOLDER
          object type roster object enumerator
static int OBJECT_TYPE_ROSTERITEM
          object type roster item object enumerator
static int OBJECT_TYPE_STORED_SEARCH
          object type stored searches
static int OBJECT_TYPE_SYS_QUEUE_FOLDER
          object type system queue object enumerator
static int OBJECT_TYPE_TRACKER_QUEUE_FOLDER
          object type tracker queue object enumerator
static int OBJECT_TYPE_TUPLE_USER_START
          start value for user defined object types
static int OBJECT_TYPE_UNDEFINED
          object type base definitions
static int OBJECT_TYPE_USER_QUEUE_FOLDER
          object type user queue object enumerator
static int OBJECT_TYPE_VIRTUAL_FOLDER
          an object described in a search node, represented as folder
static int OBJECT_TYPE_WORKFLOW_USER_START
          start value for user defined object types
static int OBJECT_TYPE_WORKITEM
          object type work item object enumerator
static int OBJECT_TYPE_WORKITEM_PROXY
          object type proxy object enumerator
static int OBJECT_TYPE_WORKITEM_TRACKER
          object type tracker object enumerator
 
Method Summary
 String getDMSID()
          get the ECM specific ID of the Object.
 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
 String getMIMEParameter()
          get the additional MIME Parameter of the Object
 String getMIMEType()
          get the MIME Type of the Object
 String getName()
          get Object name property string
 int getPageCount()
          retrieve the number of pages in the objects
 String getResourceID()
          get the ID / name identifying the resource the object belongs to
 int getType()
          get Object type
 boolean hasContent(int iContext_p)
          check if the object contains a content, which can be retrieved using getContentCollection
 

Field Detail

OBJECT_TYPE_UNDEFINED

static final int OBJECT_TYPE_UNDEFINED
object type base definitions

See Also:
Constant Field Values

OBJECT_TYPE_ALL_CONTENT_OBJECTS

static final int OBJECT_TYPE_ALL_CONTENT_OBJECTS
object type objects with content

See Also:
Constant Field Values

OBJECT_TYPE_DOCUMENT

static final int OBJECT_TYPE_DOCUMENT
object type Document enumerator

See Also:
Constant Field Values

OBJECT_TYPE_CONTENT_USER_START

static final int OBJECT_TYPE_CONTENT_USER_START
start value for user defined object types

See Also:
Constant Field Values

OBJECT_TYPE_ALL_CONTAINER_OBJECTS

static final int OBJECT_TYPE_ALL_CONTAINER_OBJECTS
object type objects with child objects

See Also:
Constant Field Values

OBJECT_TYPE_FOLDER

static final int OBJECT_TYPE_FOLDER
object type physical folder enumerator

See Also:
Constant Field Values

OBJECT_TYPE_ECM_ROOT_FOLDER

static final int OBJECT_TYPE_ECM_ROOT_FOLDER
object type for the ECM root folder

See Also:
Constant Field Values

OBJECT_TYPE_BPM_ROOT_FOLDER

static final int OBJECT_TYPE_BPM_ROOT_FOLDER
object type for the BPM root folder

See Also:
Constant Field Values

OBJECT_TYPE_STORED_SEARCH

static final int OBJECT_TYPE_STORED_SEARCH
object type stored searches

See Also:
Constant Field Values

OBJECT_TYPE_DYNAMIC_VIRTUAL_FOLDER

static final int OBJECT_TYPE_DYNAMIC_VIRTUAL_FOLDER
an object which is create out of a search

See Also:
Constant Field Values

OBJECT_TYPE_VIRTUAL_FOLDER

static final int OBJECT_TYPE_VIRTUAL_FOLDER
an object described in a search node, represented as folder

See Also:
Constant Field Values

OBJECT_TYPE_ROSTER_FOLDER

static final int OBJECT_TYPE_ROSTER_FOLDER
object type roster object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_PUBLIC_QUEUE_FOLDER

static final int OBJECT_TYPE_PUBLIC_QUEUE_FOLDER
object type public queue object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_USER_QUEUE_FOLDER

static final int OBJECT_TYPE_USER_QUEUE_FOLDER
object type user queue object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_SYS_QUEUE_FOLDER

static final int OBJECT_TYPE_SYS_QUEUE_FOLDER
object type system queue object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_CROSS_QUEUE_FOLDER

static final int OBJECT_TYPE_CROSS_QUEUE_FOLDER
object type cross queue object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_PROXY_QUEUE_FOLDER

static final int OBJECT_TYPE_PROXY_QUEUE_FOLDER
object type proxy queue object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_TRACKER_QUEUE_FOLDER

static final int OBJECT_TYPE_TRACKER_QUEUE_FOLDER
object type tracker queue object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_CONTAINER_USER_START

static final int OBJECT_TYPE_CONTAINER_USER_START
start value for user defined object types

See Also:
Constant Field Values

OBJECT_TYPE_ALL_TUPLE_OBJECTS

static final int OBJECT_TYPE_ALL_TUPLE_OBJECTS
object type objects with only metadata

See Also:
Constant Field Values

OBJECT_TYPE_CUSTOM

static final int OBJECT_TYPE_CUSTOM
object type Custom object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_HISTORY

static final int OBJECT_TYPE_HISTORY
object type History object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_LINK

static final int OBJECT_TYPE_LINK
object type for Link/Relationship/Association objects

See Also:
Constant Field Values

OBJECT_TYPE_TUPLE_USER_START

static final int OBJECT_TYPE_TUPLE_USER_START
start value for user defined object types

See Also:
Constant Field Values

OBJECT_TYPE_ALL_WORKFLOW_OBJECTS

static final int OBJECT_TYPE_ALL_WORKFLOW_OBJECTS
object type objects for workflows

See Also:
Constant Field Values

OBJECT_TYPE_WORKITEM

static final int OBJECT_TYPE_WORKITEM
object type work item object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_ROSTERITEM

static final int OBJECT_TYPE_ROSTERITEM
object type roster item object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_WORKITEM_PROXY

static final int OBJECT_TYPE_WORKITEM_PROXY
object type proxy object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_WORKITEM_TRACKER

static final int OBJECT_TYPE_WORKITEM_TRACKER
object type tracker object enumerator

See Also:
Constant Field Values

OBJECT_TYPE_WORKFLOW_USER_START

static final int OBJECT_TYPE_WORKFLOW_USER_START
start value for user defined object types

See Also:
Constant Field Values
Method Detail

getResourceID

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

Returns:
String ID of resource or throws OwObjectNotFoundException
Throws:
Exception, - OwObjectNotFoundException
Exception
See Also:
OwResource

getInstance

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

Returns:
OwObject or throws OwObjectNotFoundException
Throws:
Exception, - OwObjectNotFoundException
Exception

getName

String getName()
get Object name property string

Returns:
the name property string of the object

getID

String getID()
get Object symbolic name of the object which is unique among its siblings used for path construction

Returns:
the symbolic name of the object which is unique among its siblings

getType

int getType()
get Object type

Returns:
the type of the object

getDMSID

String getDMSID()
                throws Exception
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:

Throws:
Exception

getPageCount

int getPageCount()
                 throws Exception
retrieve the number of pages in the objects

Returns:
number of pages
Throws:
Exception

getMIMEType

String getMIMEType()
                   throws Exception
get the MIME Type of the Object

Returns:
MIME Type as String
Throws:
Exception

getMIMEParameter

String getMIMEParameter()
                        throws Exception
get the additional MIME Parameter of the Object

Returns:
MIME Parameter as String
Throws:
Exception

hasContent

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

Parameters:
iContext_p - OwStatusContextDefinitions
Returns:
boolean true = object contains content, false = object has no content
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.