com.wewebu.ow.server.ecm
Class OwStandardUnresolvedReference

java.lang.Object
  extended by com.wewebu.ow.server.ecm.OwStandardUnresolvedReference
All Implemented Interfaces:
OwObjectReference, OwUnresolvedReference

public class OwStandardUnresolvedReference
extends Object
implements OwUnresolvedReference

Base interface for unresolved ECM Objects. Used to determine access errors.

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
 
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
OwStandardUnresolvedReference(Exception cause_p, String reason_p, String dmsid_p, String mimetype_p, String name_p, int type_p)
          construct a unresolved reference object
 
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
 Exception getUnresolvedCause()
          get the causing exception
 String getUnresolvedReason()
          get the reason for being unresolved
 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
 

Constructor Detail

OwStandardUnresolvedReference

public OwStandardUnresolvedReference(Exception cause_p,
                                     String reason_p,
                                     String dmsid_p,
                                     String mimetype_p,
                                     String name_p,
                                     int type_p)
construct a unresolved reference object

Parameters:
cause_p -
reason_p -
dmsid_p -
mimetype_p -
name_p -
type_p -
Method Detail

getUnresolvedCause

public Exception getUnresolvedCause()
Description copied from interface: OwUnresolvedReference
get the causing exception

Specified by:
getUnresolvedCause in interface OwUnresolvedReference
Returns:
Exception or null if not available

getUnresolvedReason

public String getUnresolvedReason()
Description copied from interface: OwUnresolvedReference
get the reason for being unresolved

Specified by:
getUnresolvedReason in interface OwUnresolvedReference
Returns:
String with reason description

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

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

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

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

getType

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

Specified by:
getType in interface OwObjectReference
Returns:
the type 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

hasContent

public boolean hasContent(int iContext_p)
                   throws Exception
Description copied from interface: OwObjectReference
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.