com.wewebu.ow.server.settingsimpl
Class OwSettingsPropertyObject.OwObjectEntry

java.lang.Object
  extended by com.wewebu.ow.server.settingsimpl.OwSettingsPropertyObject.OwObjectEntry
All Implemented Interfaces:
OwObjectReference
Enclosing class:
OwSettingsPropertyObject

public static class OwSettingsPropertyObject.OwObjectEntry
extends Object
implements OwObjectReference

Class defining a single object reference instance.

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
protected  int m_iType
          object type
protected  String m_strDmsID
          the DMSID of the object
protected  String m_strMimetype
          object mimetype
protected  String m_strName
          the name that should be displayed for the object
 
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
 
Constructor Summary
OwSettingsPropertyObject.OwObjectEntry()
           
 
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
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_strName

protected String m_strName
the name that should be displayed for the object


m_iType

protected int m_iType
object type


m_strDmsID

protected String m_strDmsID
the DMSID of the object


m_strMimetype

protected String m_strMimetype
object mimetype

Constructor Detail

OwSettingsPropertyObject.OwObjectEntry

public OwSettingsPropertyObject.OwObjectEntry()
Method Detail

getName

public String getName()
get Object name property string

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

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

getID

public String getID()
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()
get Object type

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

getDMSID

public 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:

Specified by:
getDMSID in interface OwObjectReference
Throws:
Exception

getPageCount

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

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

getMIMEType

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

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

getMIMEParameter

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

Specified by:
getMIMEParameter in interface OwObjectReference
Returns:
MIME Parameter as String
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


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.