|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.bpe.api.MetaDataOptions
public final class MetaDataOptions
Describes filtering options for retrieving the meta data of query tables.
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 |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public MetaDataOptions()
findQueryTableMetaData
.
public MetaDataOptions(java.lang.String primaryQueryTableFilter, java.lang.String sourceAttributeFilter, boolean userParametersAllowed, java.util.Locale locale)
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.
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 |
---|
public java.lang.String getPrimaryQueryTableFilter()
public java.lang.String getSourceAttributeFilter()
public boolean areUserParametersAllowed()
public java.util.Locale getLocale()
public void setPrimaryQueryTableFilter(java.lang.String primaryQueryTableFilter)
primaryQueryTableFilter
- A comma separated list of primary query table names,
for example, "TASK, PROCESS_INSTANCE".public void setSourceAttributeFilter(java.lang.String sourceAttributeFilter)
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.public void setUserParametersAllowed(boolean userParametersAllowed)
userParametersAllowed
- Sets whether query tables that contain user parameters are to be considered.
public void setLocale(java.util.Locale locale)
locale
- The locale. If no special locale is to be used, null must be specified.
Note that this value overwrites the $LOCALE system variable.public java.lang.String toString()
toString
in class java.lang.Object
|
IBM WebSphere Application ServerTM Release 8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |