ServoyApi (serverside)

(servoyApi)

Overview

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.

Methods Summarized

Type	Name	Summary
Boolean	addFoundSetFilterParam(foundset, query, filterName)	Add a filter parameter that is permanent per user session to limit a specified foundset of records.
Object	copyObject(value)	Can be used to deep copy a custom value.
JSDataSet	createEmptyDataSet()	Creates an empty JSDataSet
JSEvent	createJSEvent()	This will create a JSEvent filled with component information.
JSDataSet	getDataSetByQuery(query, max_returned_rows)	Performs a sql query with a query builder object.
Array	getDatasourcePKs(datasource)	This will generate a list of primary keys names for the given data source.
JSFoundSet	getFoundSet(query)
String	getMediaUrl(bytes)	This will generate a url from a byte array so that the client can get the bytes from that url.
QBSelect	getQuerySelect(dataSource)	Get select query for dataSource
JSFoundSet	getViewFoundSet(name, query)
Boolean	hideForm(formName)	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.
Boolean	showForm(nameOrUUID)	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.
Boolean	showForm(nameOrUUID, relationName)	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.

Methods Detailed

addFoundSetFilterParam(foundset, query, filterName)

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

copyObject(value)

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

var eventSourceCopy = servoyApi.copyObject(eventSource);

createEmptyDataSet()

Creates an empty JSDataSet

Returns: JSDataSet an empty JSDataSet

createJSEvent()

This will create a JSEvent filled with component information.

Returns: JSEvent the jsevent

Sample

var event = servoyApi.createJSEvent();

getDataSetByQuery(query, max_returned_rows)

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

var dataset = servoyApi.getDataSetByQuery(qbselect, 10);

getDatasourcePKs(datasource)

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

var pkNames = servoyApi.getDatasourcePKs(datasource);

getFoundSet(query)

Parameters

• QBSelect query ;

Returns: JSFoundSet

getMediaUrl(bytes)

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

var url = servoyApi.getMediaUrl(bytes);

getQuerySelect(dataSource)

Get select query for dataSource

Parameters

• String dataSource the dataSource

Returns: QBSelect QB select for the dataSource

getViewFoundSet(name, query)

Parameters

• String name ;

• QBSelect query ;

Returns: JSFoundSet

hideForm(formName)

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

servoyApi.hideForm(formToHideName)

showForm(nameOrUUID)

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.

Parameters

• String nameOrUUID the form to show

Returns: Boolean true if the form was marked as visible

Sample

servoyApi.showForm(formToShowName)

showForm(nameOrUUID, relationName)

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.

Parameters

• String nameOrUUID the form to show

• String relationName the parent container

Returns: Boolean true if the form was marked as visible

Sample

servoyApi.showForm(formToShowName)