Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Overview
Excerpt |
---|
A related list represents a list of records present on a form. |
Like a form, a related list has getters to access lower level elements such as the fields that exist on the related list.
Like a lookup, a related list supports search handlers being added to it.
Methods
getField
Code Block |
---|
B25.FormField getField(SObjectField fieldToken) |
This method will return a Field object for the specified SObjectField. The SObjectField must be an existing reservation field.
Return value:B25.FormField
Parameters:
Name | Type | Description |
---|---|---|
fieldToken | The field |
getLookup
Code Block |
---|
B25.Lookup getLookup(SObjectField fieldToken) |
Similar to getField, but instead this method will return a Lookup object for the specified SObjectField. The SObjectField must be an existing lookup field on reservation.
Parameters: SObjectField
getFieldonSearch
Code Block |
---|
void onSearch(B25.FormField getField(SObjectField fieldToken) |
Description. Describe what the method does, what it expects, and what it outputs. Describe any cases in which the method might not work as expected. Describe any exceptions that this method is likely to throw.
Return value: ReturnType (link to relevant doc)SearchContext.SearchHandler handler) |
Adds a search handler to this related list. This handler will be called when the user searches in this related list. Note: calling this method outside of the customize method (defined in B25.Form.Customizer) has no effect.
Parameters: B25.SearchAPI.SearchHandler
Parameters:
Name | Type | Description |
---|---|---|
handler | B25.SearchContext.SearchHandler | The handler to generate results when the user searches in this list. |
onAdd (without parameters)
Code Block |
---|
List<B25.FormEventHandler> onAdd() |
Returns a reference to the list of handlers that have been defined to trigger when a record is added to the list by the user. Because this method returns a reference to the actual list (and not a copy), any changes you make to this list will directly affect the defined handlers. This method is intended to be used in the customize method defined in your implementation of the B25.Form.Customizer interface. Using it anywhere else, such as inside one of your event handlers, will not have any effect.
Return value: List<B25.FormEventHandler>
onAdd (with parameter)
Code Block |
---|
void onAdd(B25.FormEventHandler handler) |
Adds the given handler to the list of handlers that have been defined to trigger when a record is added to the list by the user. This method is a convenience method, and is identical to calling onAdd().add(B25.FormEventHandler handler)
.
Parameters:
Name | Type | Description |
---|---|---|
param1 | ParameterType (link to relevant doc) | The first parameter. |
param2 | ParameterType (link to relevant doc) | The second parameter. |
methodTwo
Code Block |
---|
ReturnType methodTwo(ParameterType param1, ParameterType param2) |
Description. Describe what the method does, what it expects, and what it outputs. Describe any cases in which the method might not work as expected. Describe any exceptions that this method is likely to throw.
Return value: ReturnType (link to relevant doc)handler | The handler to trigger when a record is added to this list. |
onRemove (without parameters)
Code Block |
---|
List<B25.FormEventHandler> onRemove() |
Returns a reference to the list of handlers that have been defined to trigger when a record is removed from the list by the user. Because this method returns a reference to the actual list (and not a copy), any changes you make to this list will directly affect the defined handlers. This method is intended to be used in the customize method defined in your implementation of the B25.Form.Customizer interface. Using it anywhere else, such as inside one of your event handlers, will not have any effect.
Return value: List<B25.FormEventHandler>
onRemove (with parameter)
Code Block |
---|
void onRemove(B25.FormEventHandler handler) |
Adds the given handler to the list of handlers that have been defined to trigger when a record is removed from the list by the user. This method is a convenience method, and is identical to calling onAdd().add(B25.FormEventHandler handler)
.
Parameters:
Name | Type | Description | ||
---|---|---|---|---|
param1 | ParameterType (link to relevant doc) | The first parameter. | ||
param2 | ParameterType (link to relevant doc) | The second parameterhandler | The handler to trigger when a record is removed from this list. |
On this page | |
---|---|
|