ServoyApi (serverside)
Last updated
Last updated
(servoyApi)
It provides utility methods for web object (NG / Titanium client components or services) server side scripting to interact with the Servoy environment. These will be used by the internal implementation of those web-objects when needed.
| Type | Name | Summary |
|---|---|---|
Add a filter parameter that is permanent per user session to limit a specified foundset of records. This is similar as calling foundset.js_addFoundSetFilterParam, but the main difference is that this works also on related foundsets.
Parameters
JSFoundSet foundset The foundset to add the filter param/query to
QBSelect query The query repesenting the filter
String filterName a name given to this foundset filter
Returns: Boolean
Can be used to deep copy a custom value.
Parameters
Object value the value to be copied
Returns: Object a copy of the value object, the same as constructing the object in javascript from scratch
Sample
Creates an empty JSDataSet
Returns: JSDataSet an empty JSDataSet
This will create a JSEvent filled with component information.
Returns: JSEvent the jsevent
Sample
Performs a sql query with a query builder object. Will throw an exception if anything did go wrong when executing the query. Will use any data filter defined on table.
Parameters
QBSelect query QBSelect query.
Number max_returned_rows The maximum number of rows returned by the query.
Returns: JSDataSet The JSDataSet containing the results of the query.
Sample
This will generate a list of primary keys names for the given data source.
Parameters
String datasource the data source
Returns: Array a list of primary key names
Sample
Parameters
QBSelect query ;
Returns: JSFoundSet
This will generate a url from a byte array so that the client can get the bytes from that url.
Parameters
Array bytes The value where an url should be created for
Returns: String the url where the bytes can be downloaded from
Sample
Get select query for dataSource
Parameters
String dataSource the dataSource
Returns: QBSelect QB select for the dataSource
Parameters
Returns: JSFoundSet
Hide a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip for hiding the form through the browser's component.
Parameters
Object formName the form to hide
Returns: Boolean true if the form was hidden
Sample
Show a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip for showing the form through the browser's component.
NOTE: Make sure this isn't called with a form name that can direclty come from the client, because this call allows all forms to be shown!
Parameters
String nameOrUUID the form to show
Returns: Boolean true if the form was marked as visible
Sample
Show a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip for showing the form through the browser's component.
NOTE: Make sure this isn't called with a form name that can direclty come from the client, because this call allows all forms to be shown!
Parameters
Returns: Boolean true if the form was marked as visible
Sample
Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Can be used to deep copy a custom value.
Creates an empty JSDataSet
This will create a JSEvent filled with component information.
Performs a sql query with a query builder object.
This will generate a list of primary keys names for the given data source.
This will generate a url from a byte array so that the client can get the bytes from that url.
Get select query for dataSource
Hide a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip for hiding the form through the browser's component.
Show a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip for showing the form through the browser's component.
Show a form directly on the server for instance when a tab will change on the client, so it won't need to do a round trip for showing the form through the browser's component.