org.apache.manifoldcf.crawler.common.DCTM

Interface IDocumentumObject

All Superinterfaces:

java.rmi.Remote

public interface IDocumentumObject
extends java.rmi.Remote

This represents the limited equivalent of an IDfSysObject, containing only the properties that the crawler code needs to do its job.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Method Summary

Modifier and Type	Method and Description
boolean	exists() Does the object exist?
java.lang.String	getACLDomain() Get the ACL domain
java.lang.String	getACLName() Get the ACL name
java.lang.String[]	getAttributeValues(java.lang.String attribute) Get all the values that an attribute has, including multiple ones if present
long	getContentSize() Get object's content size
java.lang.String	getContentType() Get the object's content type
java.lang.String	getFile(java.lang.String path) Write the content of the object to a file path.
java.lang.String[]	getFolderPaths(java.util.Map pathMapCache) Get the path set for the object.
java.lang.String	getObjectId() Get the object identifier
java.lang.String	getObjectName() Get the object name
int	getPageCount() Get object's page count
int	getPermit() Get object's permit level
java.lang.String	getTypeName() Get object type name
java.lang.String	getUserName() Get a user's name
int	getUserState() Get a user state
java.lang.String	getVersionLabel() Get the object's version label
java.lang.String	getVStamp() Get the vstamp field for the object
boolean	isDeleted() Check if object is deleted
boolean	isHidden() Check if object is hidden
void	release() Release the object

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

release

void release()
      throws java.rmi.RemoteException

Release the object

Throws:

java.rmi.RemoteException

exists

boolean exists()
        throws DocumentumException,
               java.rmi.RemoteException

Does the object exist?

Throws:

DocumentumException

java.rmi.RemoteException

getObjectId

java.lang.String getObjectId()
                      throws DocumentumException,
                             java.rmi.RemoteException

Get the object identifier

Throws:

DocumentumException

java.rmi.RemoteException

getObjectName

java.lang.String getObjectName()
                        throws DocumentumException,
                               java.rmi.RemoteException

Get the object name

Throws:

DocumentumException

java.rmi.RemoteException

getContentType

java.lang.String getContentType()
                         throws DocumentumException,
                                java.rmi.RemoteException

Get the object's content type

Throws:

DocumentumException

java.rmi.RemoteException

getACLDomain

java.lang.String getACLDomain()
                       throws DocumentumException,
                              java.rmi.RemoteException

Get the ACL domain

Throws:

DocumentumException

java.rmi.RemoteException

getACLName

java.lang.String getACLName()
                     throws DocumentumException,
                            java.rmi.RemoteException

Get the ACL name

Throws:

DocumentumException

java.rmi.RemoteException

isDeleted

boolean isDeleted()
           throws DocumentumException,
                  java.rmi.RemoteException

Check if object is deleted

Throws:

DocumentumException

java.rmi.RemoteException

isHidden

boolean isHidden()
          throws DocumentumException,
                 java.rmi.RemoteException

Check if object is hidden

Throws:

DocumentumException

java.rmi.RemoteException

getPermit

int getPermit()
       throws DocumentumException,
              java.rmi.RemoteException

Get object's permit level

Throws:

DocumentumException

java.rmi.RemoteException

getContentSize

long getContentSize()
             throws DocumentumException,
                    java.rmi.RemoteException

Get object's content size

Throws:

DocumentumException

java.rmi.RemoteException

getPageCount

int getPageCount()
          throws DocumentumException,
                 java.rmi.RemoteException

Get object's page count

Throws:

DocumentumException

java.rmi.RemoteException

getVersionLabel

java.lang.String getVersionLabel()
                          throws DocumentumException,
                                 java.rmi.RemoteException

Get the object's version label

Throws:

DocumentumException

java.rmi.RemoteException

getTypeName

java.lang.String getTypeName()
                      throws DocumentumException,
                             java.rmi.RemoteException

Get object type name

Throws:

DocumentumException

java.rmi.RemoteException

getVStamp

java.lang.String getVStamp()
                    throws DocumentumException,
                           java.rmi.RemoteException

Get the vstamp field for the object

Throws:

DocumentumException

java.rmi.RemoteException

getFolderPaths

java.lang.String[] getFolderPaths(java.util.Map pathMapCache)
                           throws DocumentumException,
                                  java.rmi.RemoteException

Get the path set for the object. This is the complete set of folder paths that lead to the object.

Throws:

DocumentumException

java.rmi.RemoteException

getFile

java.lang.String getFile(java.lang.String path)
                  throws DocumentumException,
                         java.rmi.RemoteException

Write the content of the object to a file path.

Parameters:

path - is where the content should be written.

Returns:

the file path where the content was written.

Throws:

DocumentumException

java.rmi.RemoteException

getAttributeValues

java.lang.String[] getAttributeValues(java.lang.String attribute)
                               throws DocumentumException,
                                      java.rmi.RemoteException

Get all the values that an attribute has, including multiple ones if present

Throws:

DocumentumException

java.rmi.RemoteException

getUserState

int getUserState()
          throws DocumentumException,
                 java.rmi.RemoteException

Get a user state

Throws:

DocumentumException

java.rmi.RemoteException

getUserName

java.lang.String getUserName()
                      throws DocumentumException,
                             java.rmi.RemoteException

Get a user's name

Throws:

DocumentumException

java.rmi.RemoteException