|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.gre.samples.collectionhelpers.IRMQuery
The IRMQuery class forms the basis for Easy Inteligent Query dialogs. IRMQuery objects are constructed using QueryControllerEJB saved query XML values. The class contains methods to assist in displaying Query Forms. There are methods to execute Queries with modified values.
Constructor Summary | |
---|---|
IRMQuery(java.lang.String queryXML,
ClientSession session,
java.lang.String strScope,
boolean addDisplayInfo)
Constructor |
Method Summary | |
---|---|
int |
getBlockSize()
Gets the value indicating the number of elements that will be returned. |
int |
getBlockStart()
Get the Block Start value. |
java.lang.String |
getCondition()
The Condition element of the saved query. |
java.lang.String |
getFieldValue(java.lang.String key)
Gets the string value for the XML element represented by the unique key |
java.lang.String |
getFlPlnCmpntDefName()
The File Plan Component Definition Name for the saved query. |
Line |
getLine(int index)
Gets the Line object for the specified index. |
int |
getLineCount()
The total number of lines that will be displayed to draw a Query Form. |
java.lang.String |
getModifiedQuery()
The XML string representing a new Saved Query with modified values. |
java.lang.String |
getQuery()
The Query element of the saved query |
int |
getQueryResultOptions()
Gets the queryResultOption paramater for the QueryController runQuery method. |
int |
getQueryType()
The Query Type. |
java.lang.String |
getReportTemplate()
The ReportTemplate of the saved query. |
java.lang.String |
getResultList()
Return the XML string result from the last call to the QueryController runQuery method. |
ClientSession |
getSession()
The encapsulated ClientSession. |
int |
getTotalResults()
Return the total result count for the query. |
void |
Initialize()
Call the Initialize method immediately after the class has been constructed to generate the internal representation of the query. |
int |
runQuery(int nBlockStart,
int nBlockSize)
Calls the QueryController runQuery using the mofified query values. |
void |
setBlockSize(int value)
Sets the value indicating the number of elements that will be returned. |
void |
setBlockStart(int value)
Set the Block Start where 0 is the first element. |
boolean |
setFieldValue(java.lang.String key,
java.lang.String val)
Sets the XML element value for the element named by the unique key value. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public IRMQuery(java.lang.String queryXML, ClientSession session, java.lang.String strScope, boolean addDisplayInfo) throws com.ibm.gre.engine.util.RecordManagerException, java.lang.Exception
queryXML
- he XML string containing the values making up the Query.
This string can be a saved query value returned by the QueryControllerEJB.getQueryById method.session
- A ClientSession object containing references to the Records Manager API objects.strScope
- The full path string indicating the scope of the query.addDisplayInfo
- Set to true if you wish to use this object to generate display information.
com.ibm.gre.engine.util.RecordManagerException
java.lang.Exception
Method Detail |
public void Initialize() throws java.rmi.RemoteException, com.ibm.gre.engine.util.RecordManagerException, java.lang.Exception
java.rmi.RemoteException
com.ibm.gre.engine.util.RecordManagerException
java.lang.Exception
public int runQuery(int nBlockStart, int nBlockSize) throws java.rmi.RemoteException, com.ibm.gre.engine.util.RecordManagerException, java.lang.Exception
nBlockStart
- The index value return a block of values from. 0 indicates the first value.nBlockSize
- The number of values to return. 0 indicates return all values.
java.rmi.RemoteException
com.ibm.gre.engine.util.RecordManagerException
java.lang.Exception
public int getQueryResultOptions() throws java.lang.Exception
java.lang.Exception
public int getTotalResults() throws java.lang.Exception
java.lang.Exception
public java.lang.String getResultList() throws java.lang.Exception
java.lang.Exception
public int getBlockStart()
public void setBlockStart(int value)
value
- public int getBlockSize()
public void setBlockSize(int value)
value
- public ClientSession getSession()
public int getQueryType()
public int getLineCount() throws java.lang.Exception
java.lang.Exception
public Line getLine(int index) throws java.lang.Exception
index
-
java.lang.Exception
public boolean setFieldValue(java.lang.String key, java.lang.String val) throws java.lang.Exception
key
- The unique key identifying the element to set the value for.val
- The value to set.
java.lang.Exception
public java.lang.String getFieldValue(java.lang.String key) throws java.lang.Exception
key
- The unique value identifying the XML element to get the value for.
java.lang.Exception
public java.lang.String getModifiedQuery() throws java.lang.Exception
java.lang.Exception
public java.lang.String getCondition()
public java.lang.String getQuery()
public java.lang.String getReportTemplate()
public java.lang.String getFlPlnCmpntDefName() throws java.rmi.RemoteException, com.ibm.gre.engine.util.RecordManagerException, java.lang.Exception
java.rmi.RemoteException
com.ibm.gre.engine.util.RecordManagerException
java.lang.Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |