public interface DataspaceSetFilter
SchemaTypeName.OSD_DATASPACE_KEY
.
This filter is called:
SchemaTypeName.OSD_DATASPACE_KEY
.
The filter must be declared under the element
xs:annotation/xs:appinfo/osd:dataspaceSet
:
where<filter osd:class="com.foo.MyDataspaceFilter"/>
com.foo.MyDataspaceFilter
is
the fully qualified name of the class implementing this interface.
It is also possible to set additional JavaBean properties:
where<filter osd:class="com.foo.MyDataspaceFilter" /> <param1>...</param1> <param2>...</param2> </filter>
param1
and param2
are JavaBean properties of the specified class.
For more information, see the JavaBean specification.
setParam1(...)
and
setParam2(...)
);setup(DataspaceSetFilterSetupContext)
is called for the new instance.accept(HomeKey, DataspaceSetFilterContext)
is called each time an associated field has to be displayed in the user interface.
Modifier and Type | Method and Description |
---|---|
boolean |
accept(HomeKey aHomeKey,
DataspaceSetFilterContext aContext)
Returns whether the specified dataspace is included in the filter result.
|
void |
setup(DataspaceSetFilterSetupContext aContext)
Checks and prepares this instance if called while the data model is being loaded.
|
String |
toUserDocumentation(Locale userLocale,
ValueContext aContext)
Returns the end-user documentation for this filter.
|
boolean accept(HomeKey aHomeKey, DataspaceSetFilterContext aContext)
void setup(DataspaceSetFilterSetupContext aContext)
String toUserDocumentation(Locale userLocale, ValueContext aContext) throws InvalidSchemaException
This method returns null
if the specified locale is not handled by
the current implementation. The container tries several locales
when handling a partial internationalization of this method implementation and/or
a mismatch between the locales declared by the associated module and the locales supported
by EBX®. In such cases, locales are tried in the following order:
Session.getLocaleForSchemaNode(SchemaNode)
);module.xml
;For a single instance of this interface, this method may be called concurrently by several threads.
InvalidSchemaException
- if a dynamic condition in the data model prevents the execution of this method.