de.tif.jacob.core.definition
Interface IAdhocBrowserDefinition

All Superinterfaces:

IBrowserDefinition, INamedObjectDefinition

public interface IAdhocBrowserDefinition
extends IBrowserDefinition

This interface represents an ad-hoc browser definition. In contrast to normal browser definition ad-hoc browser definition are mutual and not predefined at design-time. Ad-hoc browser definitions could be used to create dynamic result sets when performing a query on a table alias. To do something like that a corresponding IDataBrowser has to be requested by means of IDataAccessor.getBrowser(IBrowserDefinition).

Method Summary

void	addBrowserField(int index, java.lang.String tableAliasName, java.lang.String tableFieldName, java.lang.String label, SortOrder sortOrder) Adds a new browser table field to this browser definition, which will be inserted at the given position index.
void	addBrowserField(java.lang.String tableAliasName, java.lang.String tableFieldName, java.lang.String label, SortOrder sortOrder) Adds a new browser table field to this browser definition, which will be appended to already existing browser fields.
java.util.List	getBrowserFields() Returns the list of all browser fields.
int	getFieldNumber() Returns the number of browser fields of this browser definition.
IBrowserTableField	removeBrowserField(int index) Removes the browser field located at the given index.

Methods inherited from interface de.tif.jacob.core.definition.IBrowserDefinition

getBrowserField, getTableAlias

Methods inherited from interface de.tif.jacob.core.definition.INamedObjectDefinition

getDescription, getName, getProperty

Method Detail

getBrowserFields

java.util.List getBrowserFields()

Returns the list of all browser fields.

Note: Browser fields are always of type IBrowserTableField

Specified by:

getBrowserFields in interface IBrowserDefinition

Returns:

List of IBrowserTableField

See Also:

IBrowserDefinition.getBrowserFields()

removeBrowserField

IBrowserTableField removeBrowserField(int index)
                                      throws java.lang.IndexOutOfBoundsException

Removes the browser field located at the given index.

Parameters:

index - the index of the browser field to remove

Returns:

the browser table field which has just been removed

Throws:

java.lang.IndexOutOfBoundsException - if 0 <= index < getFieldNumber() is not fulfilled

getFieldNumber

int getFieldNumber()

Returns the number of browser fields of this browser definition.

Returns:

the number of browser fields

addBrowserField

void addBrowserField(java.lang.String tableAliasName,
                     java.lang.String tableFieldName,
                     java.lang.String label,
                     SortOrder sortOrder)
                     throws java.lang.NoSuchFieldException

Adds a new browser table field to this browser definition, which will be appended to already existing browser fields.

Parameters:

tableAliasName - the name of the table alias

tableFieldName - the name of the table field

label - the label of the browser field

sortOrder - the sort order of the browser field

Throws:

java.lang.NoSuchFieldException - if no such table field exists for the given table alias

addBrowserField

void addBrowserField(int index,
                     java.lang.String tableAliasName,
                     java.lang.String tableFieldName,
                     java.lang.String label,
                     SortOrder sortOrder)
                     throws java.lang.NoSuchFieldException,
                            java.lang.IndexOutOfBoundsException

Adds a new browser table field to this browser definition, which will be inserted at the given position index.

Parameters:

index - the index to insert the new browser table field

tableAliasName - the name of the table alias

tableFieldName - the name of the table field

label - the label of the browser field

sortOrder - the sort order of the browser field

Throws:

java.lang.NoSuchFieldException - if no such table field exists for the given table alias

java.lang.IndexOutOfBoundsException - if 0 <= index < getFieldNumber() is not fulfilled