oracle.jbo.datasource
Interface CtrlHintsSupport

All Known Implementing Classes:

SIEODataSourceImpl, SIVODataSourceImpl

public interface CtrlHintsSupport

Since:

11.1.1.1

Method Summary

java.util.List<java.lang.String>	getContextKey() Returns the list of attributes that is to be considered the context key attributes for looking up row-level UI hints.
java.util.List<AttrCtrlHints>	getControlHints(Row row, java.lang.String localeName) Returns the row-level UI hints for a given locale.
java.util.List<AttrCtrlHints>	getControlHints(java.lang.String localeName) Returns the base UI hints for a given locale.
boolean	isCtrlHintsSupported() Returns a flag specifying if the underlying datasource can retrieve the static control hints defined on the server-side EOs and VOs.
boolean	isRowCtrlHintsSupported() Returns a flag specifying if the underlying datasource can retrieve the row-specific control hints defined on the server-side EOs and VOs.
void	setDataSourceDef(DataSourceDef dsDef) Sets the DataSourceDef to be used with the instance.

Method Detail

isCtrlHintsSupported

boolean isCtrlHintsSupported()

Returns a flag specifying if the underlying datasource can retrieve the static control hints defined on the server-side EOs and VOs.

Returns:

true if the underlying datasource supports control hints and false otherwise.

getControlHints

java.util.List<AttrCtrlHints> getControlHints(java.lang.String localeName)

Returns the base UI hints for a given locale.

Parameters:

localeName - a locale name

Returns:

default control hints.

isRowCtrlHintsSupported

boolean isRowCtrlHintsSupported()

Returns a flag specifying if the underlying datasource can retrieve the row-specific control hints defined on the server-side EOs and VOs.

Returns:

true if the underlying datasource supports row-level specific control hints and false otherwise.

getContextKey

java.util.List<java.lang.String> getContextKey()

Returns the list of attributes that is to be considered the context key attributes for looking up row-level UI hints.

Returns:

context key attributes.

getControlHints

java.util.List<AttrCtrlHints> getControlHints(Row row,
                                              java.lang.String localeName)

Returns the row-level UI hints for a given locale.

Parameters:

row - the data row

localeName - a locale name

Returns:

row-level control hints.

setDataSourceDef

void setDataSourceDef(DataSourceDef dsDef)

Sets the DataSourceDef to be used with the instance.

Parameters:

dsDef - the datasource metadata