|
Content Manager OnDemand V7 WEK APIs |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.edms.od.ODHit
A class representing a document within OnDemand.
(c) Copyright IBM Corp. 1993, 2003. All Rights Reserved
Constructor Summary | |
protected |
ODHit(com.ibm.edms.od.ODServer server,
com.ibm.edms.od.ODFolder folder,
java.lang.String id,
char type,
int hit_location,
java.lang.String[] values)
|
protected |
ODHit(com.ibm.edms.od.ODServer server,
com.ibm.edms.od.ODFolder folder,
java.lang.String id,
char type,
java.lang.String[] values)
|
Method Summary | |
void |
addNote(com.ibm.edms.od.ODNote note)
Add a note to this document. |
java.lang.String |
getDisplayValue(java.lang.String name)
Get the documents display value for the specified folder criteria name. |
java.util.Enumeration |
getDisplayValues()
Get the documents display values. |
java.lang.String |
getDocId()
Get a persistent id for this document. |
int |
getDocLocation()
Get the document location. |
char |
getDocType()
Get the document type. |
java.lang.String |
getMimeType()
Get the mimetype of the data returned by a call to retrieve. |
java.util.Vector |
getNotes()
Get the notes associated with this document. |
int |
getNoteStatus(boolean allow_unknown)
Get the status of notes associated with this document. |
byte[] |
retrieve(java.lang.String viewer)
Retrieve document data. |
void |
update(java.util.Hashtable newValues)
Update this documents criteria values. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected ODHit(com.ibm.edms.od.ODServer server, com.ibm.edms.od.ODFolder folder, java.lang.String id, char type, java.lang.String[] values) throws java.lang.Exception
protected ODHit(com.ibm.edms.od.ODServer server, com.ibm.edms.od.ODFolder folder, java.lang.String id, char type, int hit_location, java.lang.String[] values) throws java.lang.Exception
Method Detail |
public byte[] retrieve(java.lang.String viewer) throws java.lang.Exception
viewer
- Specifies if any conversion is to be applied to the data.
java.lang.Exception
ODConstant.APPLET
,
ODConstant.ASCII
,
ODConstant.HTML
,
ODConstant.NATIVE
,
ODConstant.PDF
,
ODConstant.PLUGIN
,
ODConstant.XENOS
,
ODServer.viewerPassthru(java.lang.String)
public int getNoteStatus(boolean allow_unknown)
allow_unknown
- If true, and the server must be accessed
to determine the status, ODConstant.NoteStatusUnknown
will be returned. If false, the server will be accessed
to determine the status if necessary.
ODConstant.NoteStatusUnknown
,
ODConstant.NoteStatusYes
,
ODConstant.NoteStatusNo
,
ODConstant.NoteStatusError
public java.util.Vector getNotes() throws java.lang.Exception
java.lang.Exception
public void addNote(com.ibm.edms.od.ODNote note) throws java.lang.Exception
note
- An ODNote object.
java.lang.Exception
public void update(java.util.Hashtable newValues) throws java.lang.Exception
newValues
- This hashtable contains the criteria names
to update along with the new values.
java.lang.Exception
public java.lang.String getDocId()
public char getDocType()
ODConstant.FileTypeAFP
,
ODConstant.FileTypeBMP
,
ODConstant.FileTypeEMAIL
,
ODConstant.FileTypeGIF
,
ODConstant.FileTypeJFIF
,
ODConstant.FileTypeLINE
,
ODConstant.FileTypeMETA
,
ODConstant.FileTypeNONE
,
ODConstant.FileTypePCX
,
ODConstant.FileTypePDF
,
ODConstant.FileTypePNG
,
ODConstant.FileTypeTIFF
,
ODConstant.FileTypeUSRDEF
public int getDocLocation()
ODConstant.DocLocationUnknown
,
ODConstant.DocLocationCache
,
ODConstant.DocLocationArchive
,
ODConstant.DocLocationExternal
public java.lang.String getMimeType()
public java.util.Enumeration getDisplayValues()
public java.lang.String getDisplayValue(java.lang.String name)
|
CM OnDemand V7 WEK Java APIs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |