com.ibm.gre.IRMQuery Class
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.

Access: Public
Base Classes: Object
  Members Description  
    IRMQuery Constructor

 
    Initialize Call the Initialize method immediately after the class has been constructed to generate the internal representation of the query.

 
    runQuery Calls the QueryController runQuery using the mofified query values. Saves the result internally. Call ResultList to retreive the XML return value.

 
    QueryResultOptions Get or Set the queryResultOption paramater for the QueryController runQuery method. Default value is IRMConstants.QueryResultOptions.INCLUDE_COLUMNS.

 
    TotalResults Return the total result count for the query

 
    ResultList Return the XML string result from the last call to the QueryController runQuery method.

 
    BlockStart Block Start where 0 is the first element.

 
    BlockSize The number of elements to return where 0 indicates ALL.

 
    ClientSession The encapsulated ClientSession

 
    QueryType The Query Type. See IRMConstants.QueryTypes

 
    LineCount The total number of lines that will be displayed to draw a Query Form

 
    getLine Gets the Line object for the specified index.

 
    setFieldValue Sets the XML element value for the element named by the unique key value.

 
    getFieldValue Gets the string value for the XML element represented by the unique key.

 
    ModifiedQuery The XML string representing a new Saved Query with modified values.

 
    Condition The Condition element of the saved query.

 
    Query The Query element of the saved query.

 
    ReportTemplate The ReportTemplate of the saved query.

 
    FlPlnCmpntDefName The File Plan Component Definition Name for the saved query.

 
    validateByType Validates string value according to File Plan Component Attribute Definition Type.

 
    makeProfileFields Recusively process all the elements contained in the Condition element and any nested Condition elements.

 
    makeLineType Converts a string charachter to a LineType

 
    getOperation Gets a character string for a line type.

 
    GetFieldValue Helper method to extract an element value for a specified FlPlnCmpntAttrDefColNm

 
    getCaption This method gets the Caption given a column name. It is by no means optimized! Captions will be problematic in a multi language environment. There will need to be a way to map default captions to their translations

 
    getDataType Helper method

 
    getAttrCntrlMsk Helper method

 
    getPickListId Helper method.

 
    getComponentName Gets the Component Definition Name given a Component Definition ID.

 
    checkDisplayStatus    
    checkStatus    
    m_fieldCount    
    m_FlPlnCmpntDefID    
    m_QueryNm    
    m_strScope    
    m_doc    
    m_root    
    m_QueryImage    
    m_ReportTemplate    
    m_Query    
    m_Condition    
    m_BlockSize    
    m_BlockStart    
    m_bIsInitialized    
    m_rootReportTemplate    
    m_tab    
    m_nQueryType    
    m_fieldvalues    
    m_DisplayItems    
    m_addDisplayInfo    
    m_session    
    m_strResultList    
    m_totalResults    
    m_nQueryResultOptions