|
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.ODCallback | +--com.ibm.edms.od.ODFolder
A class representing an OnDemand folder.
This object is returned from a successful call to ODServer.openFolder().
It contains folder criteria information. These criteria objects are what
need to be modified in order to narrow the query on the server.
(c) Copyright IBM Corp. 1993, 2003. All Rights Reserved
Constructor Summary | |
protected |
ODFolder(com.ibm.edms.od.ODServer server,
java.lang.String name)
|
protected |
ODFolder(com.ibm.edms.od.ODServer server,
java.lang.String name,
java.lang.String desc)
|
Method Summary | |
boolean |
addHit(java.lang.String id,
char type,
int hit_location,
java.lang.String[] values)
This method should be used to selectively add hits to the ODFolder's working set of hits. |
boolean |
addHit(java.lang.String id,
char type,
java.lang.String[] values)
This method should be used to selectively add hits to the ODFolder's working set of hits. |
void |
close()
This method will close the folder. |
boolean |
DataCallback(byte[] data)
Not for public use. |
protected void |
done()
Deprecated. |
java.lang.Object[] |
getApplGroups()
Get the application groups for this folder. |
java.util.Enumeration |
getCriteria()
Get the search criteria for this folder. |
com.ibm.edms.od.ODCriteria |
getCriteria(java.lang.String name)
Get criteria object for the specified criteria name. |
java.lang.String |
getDescription()
The description of the folder. |
java.lang.String[] |
getDisplayOrder()
Get the display order for the folder's criteria. |
java.util.ArrayList |
getFolderSortOrder()
Get the sort order for the folder's criteria. |
java.util.Vector |
getHits()
Return the hits obtained from the last search method call. |
java.lang.String |
getName()
The name of the folder. |
int |
getNumApplGroups()
Get the number of application groups for this folder. |
int |
getNumCriteria()
Get the number of search criteria for this folder. |
java.lang.String |
getSearchMessage()
Message returned from server during search operation. |
boolean |
getSortEnabled()
Get the sort enablement for the open folder's criteria,true/false, true meaning sorting is enabled, false meaning sorting is disabled. |
boolean |
hasODCallback()
Not for public use. |
boolean |
HitCallback(java.lang.String id,
char type,
int hit_location,
java.lang.String[] values)
Not for public use. |
boolean |
HitCallback(java.lang.String id,
char type,
java.lang.String[] values)
Not for public use. |
void |
HitHandleCallback(int hit,
int off,
int len)
Not for public use. |
boolean |
isSortEnabled()
Get the sort enablement for the open folder's criteria, true/false. |
void |
open()
This method will open the folder. |
void |
printDocs(java.util.Vector hits,
java.lang.String printer)
Print the specified hits from this folder. |
void |
retrieve(com.ibm.edms.od.ODCallback odCallback)
This method will retrieve the current hits, i.e., those returned from the last successful search method call. |
void |
retrieve(java.lang.String[] ids,
com.ibm.edms.od.ODCallback odCallback)
This method will retrieve the specified documents from this folder. |
void |
retrieve(java.util.Vector hits,
com.ibm.edms.od.ODCallback odCallback)
This method will retrieve the specified hits from this folder. |
java.util.Vector |
search()
This method will search the folder. |
java.util.Vector |
search(com.ibm.edms.od.ODCallback odCallback)
This method will search the folder. |
java.util.Vector |
search(com.ibm.edms.od.ODCallback odCallback,
boolean use_docloc_hit_callback)
This method will search the folder. |
java.util.Vector |
search(java.lang.String sql)
This method will search the folder. |
java.util.Vector |
search(java.lang.String sql,
com.ibm.edms.od.ODCallback cb)
If you use this method the SQL query is used to search the folder rather than any folder field name/value pairs. |
java.util.Vector |
search(java.lang.String sql,
java.lang.String date1,
java.lang.String date2)
This method will search the folder. |
java.util.Vector |
search(java.lang.String sql,
java.lang.String date1,
java.lang.String date2,
com.ibm.edms.od.ODCallback cb)
If you use this method the SQL query is used to search the folder rather than any folder field name/value pairs. |
java.util.Vector |
search(java.lang.String sql,
java.lang.String date1,
java.lang.String date2,
java.lang.String dateFmt)
This method will search the folder. |
java.util.Vector |
search(java.lang.String sql,
java.lang.String date1,
java.lang.String date2,
java.lang.String dateFmt,
com.ibm.edms.od.ODCallback odCallback)
If you use this method the SQL query is used to search the folder rather than any folder field name/value pairs. |
void |
searchWithCallback(com.ibm.edms.od.ODCallback odCallback)
Deprecated. |
void |
searchWithCallback(java.lang.String sql,
com.ibm.edms.od.ODCallback cb)
Deprecated. |
void |
searchWithCallback(java.lang.String sql,
java.lang.String date1,
java.lang.String date2,
com.ibm.edms.od.ODCallback odCallback)
Deprecated. |
protected void |
setDescription(java.lang.String desc)
|
protected void |
setDisplayOrder(java.lang.String[] displayOrder)
|
protected void |
setFolderSortOrder(java.lang.String[] critName,
java.lang.String[] sortOrder,
java.lang.String[] Ascending)
|
void |
setSortEnabled(boolean sort)
Set the sort enablement for the folder's criteria. |
Methods inherited from class com.ibm.edms.od.ODCallback |
cancel, isDone, setServer, setThread, waitForOperation |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected ODFolder(com.ibm.edms.od.ODServer server, java.lang.String name)
protected ODFolder(com.ibm.edms.od.ODServer server, java.lang.String name, java.lang.String desc)
Method Detail |
public void open() throws java.lang.Exception
java.lang.Exception
public void close()
public java.util.Vector search() throws java.lang.Exception
java.lang.Exception
ODHit
public void searchWithCallback(com.ibm.edms.od.ODCallback odCallback) throws java.lang.Exception
getHits
after the search is complete.
java.lang.Exception
search(ODCallback)
,
getHits()
,
ODCallback
public java.util.Vector search(com.ibm.edms.od.ODCallback odCallback) throws java.lang.Exception
java.lang.Exception
ODCallback
public java.util.Vector search(com.ibm.edms.od.ODCallback odCallback, boolean use_docloc_hit_callback) throws java.lang.Exception
use_docloc_hit_callback
- Indicates whether (true) or not (false)
to return a parameter specifying the document location to the
HitCallback method.
java.lang.Exception
ODCallback
public java.util.Vector search(java.lang.String sql) throws java.lang.Exception
sql
- An sql string containing the search directive.
java.lang.Exception
ODHit
public void searchWithCallback(java.lang.String sql, com.ibm.edms.od.ODCallback cb) throws java.lang.Exception
getHits
after the search is complete.
sql
- An sql string containing the search directive.cb
- An instance of an ODCallback object.
java.lang.Exception
search(String, ODCallback)
,
getHits()
,
ODCallback
public java.util.Vector search(java.lang.String sql, com.ibm.edms.od.ODCallback cb) throws java.lang.Exception
sql
- An sql string containing the search directive.cb
- An instance of an ODCallback object.
java.lang.Exception
ODCallback
public java.util.Vector search(java.lang.String sql, java.lang.String date1, java.lang.String date2) throws java.lang.Exception
sql
- An sql string containing the search directive.date1
- Use to specify the beginning date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.date2
- Use to specify the ending date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.
java.lang.Exception
ODHit
public java.util.Vector search(java.lang.String sql, java.lang.String date1, java.lang.String date2, java.lang.String dateFmt) throws java.lang.Exception
sql
- An sql string containing the search directive.date1
- Use to specify the beginning date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.date2
- Use to specify the ending date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.dateFmt
- Used to specify the format of the dates.
java.lang.Exception
ODHit
public void searchWithCallback(java.lang.String sql, java.lang.String date1, java.lang.String date2, com.ibm.edms.od.ODCallback odCallback) throws java.lang.Exception
getHits
after the search is complete.
sql
- An sql string containing the search directive.date1
- Use to specify the beginning date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.date2
- Use to specify the ending date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.odCallback
- ODCallback object.
java.lang.Exception
search(String, String, String, ODCallback)
,
getHits()
,
ODCallback
public java.util.Vector search(java.lang.String sql, java.lang.String date1, java.lang.String date2, com.ibm.edms.od.ODCallback cb) throws java.lang.Exception
sql
- An sql string containing the search directive.date1
- Use to specify the beginning date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.date2
- Use to specify the ending date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.cb
- An instance of an ODCallback object.
java.lang.Exception
ODCallback
public java.util.Vector search(java.lang.String sql, java.lang.String date1, java.lang.String date2, java.lang.String dateFmt, com.ibm.edms.od.ODCallback odCallback) throws java.lang.Exception
sql
- An sql string containing the search directive.date1
- Use to specify the beginning date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.date2
- Use to specify the ending date in a range of dates to
search. The format of the date string that you specify
must match the display format of the folder field.dateFmt
- Used to specify the format of the dates.odCallback
- ODCallback object.
java.lang.Exception
ODCallback
public void retrieve(com.ibm.edms.od.ODCallback odCallback) throws java.lang.Exception
odCallback
- ODCallback object.
java.lang.Exception
ODCallback
public void retrieve(java.util.Vector hits, com.ibm.edms.od.ODCallback odCallback) throws java.lang.Exception
hits
- A vector of ODHit objects to retrieve.odCallback
- ODCallback object.
java.lang.Exception
ODCallback
public void retrieve(java.lang.String[] ids, com.ibm.edms.od.ODCallback odCallback) throws java.lang.Exception
ids
- An array of document ids.odCallback
- ODCallback object.
java.lang.Exception
ODCallback
public void printDocs(java.util.Vector hits, java.lang.String printer) throws java.lang.Exception
hits
- Subset of hits returned during the last search method.printer
- The name of a server printer defined within OnDemand.
java.lang.Exception
public java.util.Vector getHits()
ODHit
public java.lang.String getSearchMessage()
public java.lang.String getName()
public java.lang.String getDescription()
protected void setDescription(java.lang.String desc)
protected void setFolderSortOrder(java.lang.String[] critName, java.lang.String[] sortOrder, java.lang.String[] Ascending) throws java.lang.Exception
java.lang.Exception
protected void setDisplayOrder(java.lang.String[] displayOrder) throws java.lang.Exception
java.lang.Exception
public void setSortEnabled(boolean sort) throws java.lang.Exception
java.lang.Exception
public boolean getSortEnabled() throws java.lang.Exception
java.lang.Exception
public boolean isSortEnabled() throws java.lang.Exception
java.lang.Exception
public java.util.ArrayList getFolderSortOrder()
public java.lang.String[] getDisplayOrder()
public int getNumCriteria()
public int getNumApplGroups()
public java.lang.Object[] getApplGroups()
public java.util.Enumeration getCriteria()
ODCriteria
public com.ibm.edms.od.ODCriteria getCriteria(java.lang.String name)
ODCriteria
protected void done()
done
in class ODCallback
public boolean HitCallback(java.lang.String id, char type, java.lang.String[] values) throws java.lang.Exception
HitCallback
in class ODCallback
id
- Persistent document identifier.type
- Document type.values
- Hit field values.
java.lang.Exception
ODCallback.HitCallback(String, char, String[])
public boolean HitCallback(java.lang.String id, char type, int hit_location, java.lang.String[] values) throws java.lang.Exception
HitCallback
in class ODCallback
id
- Persistent document identifier.type
- Document type.hit_location
- document location, cache, etc.values
- Hit field values.
java.lang.Exception
ODCallback.HitCallback(String, char, int, String[])
public void HitHandleCallback(int hit, int off, int len)
HitHandleCallback
in class ODCallback
hit
- The hit number.off
- Offset of the data to be returned.len
- Length of the data to be returned.
ODCallback.HitHandleCallback(int, int, int)
public boolean DataCallback(byte[] data)
DataCallback
in class ODCallback
data
- Document data for the requested hit(s).
ODCallback.DataCallback(byte[])
public boolean hasODCallback()
ODCallback
public boolean addHit(java.lang.String id, char type, java.lang.String[] values) throws java.lang.Exception
java.lang.Exception
retrieve(ODCallback)
,
ODCallback.HitCallback(String, char, String[])
public boolean addHit(java.lang.String id, char type, int hit_location, java.lang.String[] values) throws java.lang.Exception
java.lang.Exception
retrieve(ODCallback)
,
ODCallback.HitCallback(String, char, int, String[])
|
CM OnDemand V7 WEK Java APIs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |