com.tivoli.twg.engine
Class TWGDbQueryReply

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGDbQueryReply
All Implemented Interfaces:
java.io.Serializable

public class TWGDbQueryReply
extends java.lang.Object
implements java.io.Serializable

The TWGDbQueryReply class is used for sending information about a query through the IPC. It is sent as a response to the get queries command.

See Also:
Serialized Form

Constructor Summary
TWGDbQueryReply(byte[] buf)
          This method is public as an implementation side effect.
TWGDbQueryReply(long qId, java.lang.String id_string, java.lang.String queryDisplayName, java.util.Vector tablesUsed, java.util.Vector tokenNames, java.util.Vector realNames, java.util.Vector types, java.util.Vector lengths, java.util.Vector fullNames, java.util.Vector columnDisplayNames, java.lang.String userId, java.lang.String graphic, boolean isDefaultQuery, boolean isSave, boolean isTranslation, int format, TWGDbColumnFilter column_filter)
          Constructor for the reply.
TWGDbQueryReply(long qId, java.lang.String id_string, java.lang.String queryDisplayName, java.util.Vector tablesUsed, java.util.Vector tokenNames, java.util.Vector realNames, java.util.Vector types, java.util.Vector lengths, java.util.Vector fullNames, java.util.Vector columnDisplayNames, java.lang.String userId, java.lang.String graphic, boolean isDefaultQuery, boolean isSave, boolean isTranslation, int format, TWGDbColumnFilter column_filter, java.lang.String group_name)
          Constructor for the reply.
 
Method Summary
protected  int getBufLen()
          The method is to be used only in the IBM Director engine.
 java.util.Vector getColumnDisplayNames()
          Get the list of column display names selected in the query.
 TWGDbColumnFilter getColumnFilter()
          Get the query column filter.
 java.util.Vector getColumnLengths()
          Get thelist of the lengths of the selected columns in the query.
 java.util.Vector getColumnRealNames()
          Get the list of the real names of the selected columns in the query.
 java.util.Vector getColumnTokenNames()
          Gets the list of the token names of the selected columns in the query.
 java.util.Vector getColumnTypes()
          Get the list of the data type names of the selected columns in the query.
 boolean getDefault()
          Is the query a default query?
 java.util.Vector getFullColumnNames()
          Get the a list of the names of selected columns in the query.
 java.lang.String getGroupName()
          Get the query group name.
 java.lang.String getIdString()
          Get the unique id string for a default query
 java.lang.String getQueryDisplayName()
          Gets the displayable name for the query.
 int getQueryFormat()
          Get the query format.
 java.lang.String getQueryGraphic()
          Get the name of the icon for the query
 long getQueryId()
          Get the persistent object id for the query
 boolean getSave()
          Is the query a saved query
 java.util.Vector getTablesUsed()
          Get list of table token names for tables used in the query.
 boolean getTranslation()
          Is the query a translated query?
 java.lang.String getUserId()
          Gets the user id for the query.
protected  void setBufferParms(Command cmd)
          The constructor is to be used only in the IBM Director engine.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TWGDbQueryReply

public TWGDbQueryReply(long qId,
                       java.lang.String id_string,
                       java.lang.String queryDisplayName,
                       java.util.Vector tablesUsed,
                       java.util.Vector tokenNames,
                       java.util.Vector realNames,
                       java.util.Vector types,
                       java.util.Vector lengths,
                       java.util.Vector fullNames,
                       java.util.Vector columnDisplayNames,
                       java.lang.String userId,
                       java.lang.String graphic,
                       boolean isDefaultQuery,
                       boolean isSave,
                       boolean isTranslation,
                       int format,
                       TWGDbColumnFilter column_filter)
Constructor for the reply.

Parameters:
qId - - the persistent object id for the query
queryDisplayName - - suggested query title to be used in printout and displays.
tablesUsed - - the table tokens used in the query
tokenNames - - the token names of the columns specified in the query 'SELECT' statement.
realNames - - the real names of the columns specified in the query 'SELECT' statement.
types - - the list of data type names of the columns specified in the query 'SELECT' statement.
lengths - - the length in characters if a column is charactor type, 0 if the column isn't.
fullNames - - a vector to store a list of table name plus column token names for the columns in the query.
columnDisplayNames - - the display names for the query columns
userId - - user id for the query
graphic - - icon to be displayed on the inventory console for the query.
isDefaultQuery - - is the query a default query?
isSave - - is the query a saved query?
isTranslation - - is the query column translated using resource bundles
format - - the query format.
column_filter - - column filter for the query.

TWGDbQueryReply

public TWGDbQueryReply(long qId,
                       java.lang.String id_string,
                       java.lang.String queryDisplayName,
                       java.util.Vector tablesUsed,
                       java.util.Vector tokenNames,
                       java.util.Vector realNames,
                       java.util.Vector types,
                       java.util.Vector lengths,
                       java.util.Vector fullNames,
                       java.util.Vector columnDisplayNames,
                       java.lang.String userId,
                       java.lang.String graphic,
                       boolean isDefaultQuery,
                       boolean isSave,
                       boolean isTranslation,
                       int format,
                       TWGDbColumnFilter column_filter,
                       java.lang.String group_name)
Constructor for the reply.

Parameters:
qId - - the persistent object id for the query
queryDisplayName - - suggested query title to be used in printout and displays.
tablesUsed - - the table tokens used in the query
tokenNames - - the token names of the columns specified in the query 'SELECT' statement.
realNames - - the real names of the columns specified in the query 'SELECT' statement.
types - - the list of data type names of the columns specified in the query 'SELECT' statement.
lengths - - the length in characters if a column is charactor type, 0 if the column isn't.
fullNames - - a vector to store a list of table name plus column token names for the columns in the query.
columnDisplayNames - - the display names for the query columns
userId - - user id for the query
graphic - - icon to be displayed on the inventory console for the query.
isDefaultQuery - - is the query a default query?
isSave - - is the query a saved query?
isTranslation - - is the query column translated using resource bundles
format - - the query format.
column_filter - - column filter for the query.
group_name - - group name for the query.

TWGDbQueryReply

public TWGDbQueryReply(byte[] buf)
                throws TWGDbException
This method is public as an implementation side effect. Do not call or change. Its interface may be changed in a later release.

Constructor for the TWGDbQueryReply class using an intel byte buffer format of a TWGDbQueryReply object as input

Parameters:
buf - - the intel byte buffer format of a TWGDbQueryReply object
Method Detail

getQueryId

public long getQueryId()
Get the persistent object id for the query

Returns:
the persistent object id

getIdString

public java.lang.String getIdString()
Get the unique id string for a default query

Returns:
the persistent object id. Null if no id string.

getUserId

public java.lang.String getUserId()
Gets the user id for the query.

Returns:
the user id

getQueryGraphic

public java.lang.String getQueryGraphic()
Get the name of the icon for the query

Returns:
the icon name

getQueryDisplayName

public java.lang.String getQueryDisplayName()
Gets the displayable name for the query.

Returns:
the display name

getDefault

public boolean getDefault()
Is the query a default query?

Returns:
true if the query is default, false if the query is user defined.

getSave

public boolean getSave()
Is the query a saved query

Returns:
True if the query is saved, false otherwise.

getTranslation

public boolean getTranslation()
Is the query a translated query?

Returns:
True if the query is translated false otherwise.

getTablesUsed

public java.util.Vector getTablesUsed()
Get list of table token names for tables used in the query.

Returns:
the table token names as Strings in a vector

getColumnTokenNames

public java.util.Vector getColumnTokenNames()
Gets the list of the token names of the selected columns in the query.

Returns:
the token names as Strings in a vector

getColumnRealNames

public java.util.Vector getColumnRealNames()
Get the list of the real names of the selected columns in the query.

Returns:
the real names as Strings in a vector

getColumnTypes

public java.util.Vector getColumnTypes()
Get the list of the data type names of the selected columns in the query.

Returns:
the column types as Integers in a vector

getColumnLengths

public java.util.Vector getColumnLengths()
Get thelist of the lengths of the selected columns in the query. If a column is not a character column, 0 is returned for the length.

Returns:
column lengths as Integers in a vector

getFullColumnNames

public java.util.Vector getFullColumnNames()
Get the a list of the names of selected columns in the query. The format of the column name is 'table_token_name.column_token_name'

Returns:
the full column names as Strings in a vector

getColumnDisplayNames

public java.util.Vector getColumnDisplayNames()
Get the list of column display names selected in the query. The format of the column display name is 'table_display_name.column_display_name.

Returns:
the display names for the columns as Strings in a vector

getQueryFormat

public int getQueryFormat()
Get the query format. Valid formats are found in TWGDatabaseQuery

Returns:
the format
See Also:
TWGDatabaseQuery

getGroupName

public java.lang.String getGroupName()
Get the query group name.

Returns:
the group name
See Also:
TWGDatabaseQuery

getColumnFilter

public TWGDbColumnFilter getColumnFilter()
Get the query column filter. Return Null value if there is no column filter for the query.

Returns:
TWGDbColumnFilter
See Also:
TWGDbColumnFilter

setBufferParms

protected void setBufferParms(Command cmd)
                       throws TWGDbException
The constructor is to be used only in the IBM Director engine.

Build IntelByteBuffer parms version of this command and add them to the IPC command This method should be called only in the Director server engine.

Parameters:
cmd - - the IPC command whose input parameters will be set by this method.
Throws:
TWGDbException

getBufLen

protected int getBufLen()
                 throws TWGDbException
The method is to be used only in the IBM Director engine.

Get length of buffer containing the all the information about the object.

Returns:
int
Throws:
TWGDbException

toString

public java.lang.String toString()