|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: INNER | 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, 2002. All Rights Reserved
Method Summary | |
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 workin set of hits. |
void |
close()
This method will close the folder. |
boolean |
DataCallback(byte[] data)
Not for public use. |
java.util.Enumeration |
getCriteria()
Get the search criteria for this folder. |
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.Vector |
getHits()
Return the hits obtained from the last search method call. |
java.lang.String |
getName()
The name of the folder. |
int |
getNumCriteria()
Get the number of search criteria for this folder. |
java.lang.String |
getSearchMessage()
Message returned from server during search operation. |
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. |
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(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,
ODCallback odCallback)
This method will retrieve the specified documents from this folder. |
void |
retrieve(java.util.Vector hits,
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(ODCallback odCallback)
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,
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,
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,
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(ODCallback odCallback)
Deprecated. |
void |
searchWithCallback(java.lang.String sql,
ODCallback cb)
Deprecated. |
void |
searchWithCallback(java.lang.String sql,
java.lang.String date1,
java.lang.String date2,
ODCallback odCallback)
Deprecated. |
Methods inherited from class com.ibm.edms.od.ODCallback |
cancel,
isDone,
waitForOperation |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Method Detail |
public void open() throws java.lang.Exception
public void close()
public java.util.Vector search() throws java.lang.Exception
ODHit
public void searchWithCallback(ODCallback odCallback) throws java.lang.Exception
getHits
after the search is complete.ODCallback
- An instance of the ODCallback
object.
This object will allow the calling application to cancel/wait
for the search to complete.search(ODCallback)
,
getHits()
,
ODCallback
public java.util.Vector search(ODCallback odCallback) throws java.lang.Exception
ODCallback
- An instance of the ODCallback
object.
This object will allow the calling application to cancel the
search.ODCallback
public java.util.Vector search(java.lang.String sql) throws java.lang.Exception
sql
- An sql string containing the search directive.ODHit
public void searchWithCallback(java.lang.String sql, 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.search(String, ODCallback)
,
getHits()
,
ODCallback
public java.util.Vector search(java.lang.String sql, ODCallback cb) throws java.lang.Exception
sql
- An sql string containing the search directive.cb
- An instance of an ODCallback object.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.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.ODHit
public void searchWithCallback(java.lang.String sql, java.lang.String date1, java.lang.String date2, 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.dateFmt
- Used to specify the format of the dates.odCallback
- ODCallback object.search(String, String, String, ODCallback)
,
getHits()
,
ODCallback
public java.util.Vector search(java.lang.String sql, java.lang.String date1, java.lang.String date2, 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.ODCallback
public java.util.Vector search(java.lang.String sql, java.lang.String date1, java.lang.String date2, java.lang.String dateFmt, 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.ODCallback
public void retrieve(ODCallback odCallback) throws java.lang.Exception
odCallback
- ODCallback object.ODCallback
public void retrieve(java.util.Vector hits, ODCallback odCallback) throws java.lang.Exception
hits
- A vector of ODHit objects to retrieve.odCallback
- ODCallback object.ODCallback
public void retrieve(java.lang.String[] ids, ODCallback odCallback) throws java.lang.Exception
ids
- An array of document ids.odCallback
- ODCallback object.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.public java.util.Vector getHits()
ODHit
public java.lang.String getSearchMessage()
public java.lang.String getName()
public java.lang.String getDescription()
public java.lang.String[] getDisplayOrder()
public int getNumCriteria()
public java.util.Enumeration getCriteria()
ODCriteria
public ODCriteria getCriteria(java.lang.String name)
ODCriteria
public boolean HitCallback(java.lang.String id, char type, java.lang.String[] values) throws java.lang.Exception
ODCallback.HitCallback(String, char, String[])
public void HitHandleCallback(int hit, int off, int len)
ODCallback.HitHandleCallback(int, int, int)
public boolean DataCallback(byte[] data)
ODCallback.DataCallback(byte[])
public boolean addHit(java.lang.String id, char type, java.lang.String[] values) throws java.lang.Exception
retrieve(ODCallback)
,
ODCallback.HitCallback(String, char, String[])
|
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |