com.ibm.task.api
Class MetaDataOptions

java.lang.Object
  extended by com.ibm.task.api.MetaDataOptions
All Implemented Interfaces:
java.io.Serializable

public final class MetaDataOptions
extends java.lang.Object
implements java.io.Serializable

Describes filtering options for retrieving the meta data of query tables.

Since:
7.0
See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
 
Constructor Summary
MetaDataOptions()
          Default constructor to initialize the meta data options.
MetaDataOptions(java.lang.String primaryQueryTableFilter, java.lang.String sourceAttributeFilter, boolean userParametersAllowed, java.util.Locale locale)
          Constructor that creates meta data options from the passed values.
 
Method Summary
 boolean areUserParametersAllowed()
          Returns whether query tables that contain user parameters are to be considered.
 java.util.Locale getLocale()
          Returns the locale.
 java.lang.String getPrimaryQueryTableFilter()
          Returns the primary query table filter.
 java.lang.String getSourceAttributeFilter()
          Returns the source attribute filter.
 void setLocale(java.util.Locale locale)
          Sets the locale.
 void setPrimaryQueryTableFilter(java.lang.String primaryQueryTableFilter)
          Specifies the names of primary query tables.
 void setSourceAttributeFilter(java.lang.String sourceAttributeFilter)
          Specifies source attributes names.
 void setUserParametersAllowed(boolean userParametersAllowed)
          Specifies whether query tables that contain user parameters are to be considered when querying the meta data of query tables.
 java.lang.String toString()
          Returns a string representation of the MetaDataOptions object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Constructor Detail

MetaDataOptions

public MetaDataOptions()
Default constructor to initialize the meta data options. Using the default constructor means that no restrictions are specified. The meta data of all query tables are returned when these options are used - refer to findQueryTableMetaData.


MetaDataOptions

public MetaDataOptions(java.lang.String primaryQueryTableFilter,
                       java.lang.String sourceAttributeFilter,
                       boolean userParametersAllowed,
                       java.util.Locale locale)
Constructor that creates meta data options from the passed values.

Parameters:
primaryQueryTableFilter - A comma separated list of primary query table names. Only query tables that have one of the specified primary query tables as primary query table are considered.

If no restriction on primary query table names is to be applied, null must be specified.

sourceAttributeFilter - A comma separated list of source attribute names. Only query tables with all of the specified source attributes are considered.

The format of a source attribute name is QueryTableName.AttributeName in uppercase letters, for example, TASK.STATE or PROCESS_INSTANCE.NAME.

If no restriction on source attributes is to be applied, null must be specified.

userParametersAllowed - Specifies whether query tables that contain user parameters are to be considered.
True means that user parameters are allowed in the query tables. False means that user parameters are not allowed in the query tables.
locale - The locale for meta data such as query table display names. Locales are modified before the system variable $LOCALE is set. The returned meta data object for each query table contains a locale member which shows the value of the modified locale.
Method Detail

getPrimaryQueryTableFilter

public java.lang.String getPrimaryQueryTableFilter()
Returns the primary query table filter.

Returns:
A comma separated list of primary query tables. Returns null if there is no filter on primary query tables.

getSourceAttributeFilter

public java.lang.String getSourceAttributeFilter()
Returns the source attribute filter.

Returns:
A comma separated list of source attributes. Returns null if there is no filter on source attributes.

areUserParametersAllowed

public boolean areUserParametersAllowed()
Returns whether query tables that contain user parameters are to be considered.

Returns:
Specifies whether query tables that contain user parameters are to be considered.
True means that user parameters are allowed in the query table. False means that user parameters are not allowed in the query table.

getLocale

public java.util.Locale getLocale()
Returns the locale.

Returns:
The locale. Returns null if no locale is set.

setPrimaryQueryTableFilter

public void setPrimaryQueryTableFilter(java.lang.String primaryQueryTableFilter)
Specifies the names of primary query tables. Only query tables that use one of the specified primary query tables are considered.

Parameters:
primaryQueryTableFilter - A comma separated list of primary query table names, for example, "TASK, PROCESS_INSTANCE".

setSourceAttributeFilter

public void setSourceAttributeFilter(java.lang.String sourceAttributeFilter)
Specifies source attributes names. Only query tables that use all of the specified source attributes are considered.

Parameters:
sourceAttributeFilter - A comma separated list of source attribute names, The format of a source attribute name is QueryTableName.AttributeName in uppercase letters, for example, TASK.STATE or PROCESS_INSTANCE.NAME.

setUserParametersAllowed

public void setUserParametersAllowed(boolean userParametersAllowed)
Specifies whether query tables that contain user parameters are to be considered when querying the meta data of query tables.

Parameters:
userParametersAllowed - Sets whether query tables that contain user parameters are to be considered.
True means that user parameters are allowed in the query table. False means that user parameters are not allowed in the query table.

setLocale

public void setLocale(java.util.Locale locale)
Sets the locale.

Parameters:
locale - The locale. If no special locale is to be used, null must be specified. Note that this value overwrites the $LOCALE system variable.

toString

public java.lang.String toString()
Returns a string representation of the MetaDataOptions object.

Overrides:
toString in class java.lang.Object
Returns:
String - A string representation of the object.