com.ibm.task.api

Interface QueryTableMetaData

All Superinterfaces:
java.io.Serializable

  1. public interface QueryTableMetaData
  2. extends java.io.Serializable
Provides the meta data of a query table.
Since:
7.0

Field Summary

Modifier and Type Field and Description
  1. static
  2. java.lang.String
COPYRIGHT

Method Summary

Modifier and Type Method and Description
  1. java.util.List
getAttributeMetaData()
Returns information about the attributes that are defined on the query table.
  1. AuthorizationInfo
getAuthorizationInfo()
Returns information about the authorization that is defined for the query table.
  1. java.lang.String
getDescription(java.util.Locale locale)
Returns the description of the query table in the requested locale.
  1. java.lang.String
getDisplayName(java.util.Locale locale)
Returns the display name of the query table in the requested locale.
  1. java.util.List
getKeyAttributeInfo()
Returns information about the key attributes of the query table.
  1. QueryTableKind
getKind()
Returns the kind of the query table.
  1. java.util.Locale
getLocale()
Returns the locale that is calculated for the system variable $LOCALE.
  1. java.util.Locale[]
getLocales()
Returns the locales of available display names and descriptions.
  1. java.lang.String
getName()
Returns the name of the query table.
  1. java.lang.String
getPrimaryQueryTableName()
Returns the name of the primary query table.

Field Detail

  1. static final java.lang.String COPYRIGHT
See Also:

Method Detail

getName

  1. java.lang.String getName()
Returns the name of the query table. For example, the name of a predefined query table like TASK or the name of a composite or supplemental query table whose name format is PREFIX.NAME.
Returns:
The name of the query table.

getPrimaryQueryTableName

  1. java.lang.String getPrimaryQueryTableName( )
Returns the name of the primary query table. For example, the name of a predefined query table like TASK.
Returns:
The name of the primary query table.

getKind

  1. QueryTableKind getKind()
Returns the kind of the query table.
Returns:
The kind of the query table. Refer to QueryTableKind.

getDisplayName

  1. java.lang.String getDisplayName( java.util.Locale locale)
Returns the display name of the query table in the requested locale. If there is no display name for the particular locale, the best available match is returned.

Parameters:
locale - The locale for which the display name is to be provided.
Returns:
The display name of the query table.

getDescription

  1. java.lang.String getDescription( java.util.Locale locale)
Returns the description of the query table in the requested locale. If there is no description for the particular locale, the best available match is returned.

Parameters:
locale - The locale for which the description is to be provided.
Returns:
The description of the query table.

getLocales

  1. java.util.Locale[] getLocales()
Returns the locales of available display names and descriptions. Returns an empty array when there are no display names and descriptions.
Returns:
The locales of the display names and descriptions.

getLocale

  1. java.util.Locale getLocale()
Returns the locale that is calculated for the system variable $LOCALE.
Returns:
The locale that is set for $LOCALE.

getKeyAttributeInfo

  1. java.util.List getKeyAttributeInfo( )
Returns information about the key attributes of the query table.

Returns:
A list of AttributeInfo objects that describe the key attributes of the query table. Refer to AttributeInfo.

getAttributeMetaData

  1. java.util.List getAttributeMetaData( )
Returns information about the attributes that are defined on the query table.

Returns:
A list of AttributeMetaData objects that describe the selected attributes of the query table. Refer to AttributeMetaData.

getAuthorizationInfo

  1. AuthorizationInfo getAuthorizationInfo( )
Returns information about the authorization that is defined for the query table.

Returns:
The authorization information - refer to AuthorizationInfo.