Availability
This routine is available starting with SIL Engine 4.8.0.8.
Syntax
admGetScreensFromScheme(screenSchemeName)
Description
Retrieves a list of screen operations and corresponding screens for a given Screen Scheme.
Parameters
Parameter name | Type | Required | Description |
|---|---|---|---|
screenSchemeName | string | true | The name of screen screen used to retrieve the underlying configurations. |
Return type
JGeneric[] (array of JGenerics)
Returns an array of key/value pairs representing the values of a Screen Scheme, where the key is the screen operation (Default, Create, Edit, View) and the value is the associated screen.
Example
JGeneric[] screens = admGetScreensFromScheme("TEST: Scrum Default Screen Scheme");
return screens;
// String representation
// Default|TEST: Scrum Default Issue Screen Default|Create|TEST: Scrum Default Issue Screen Create|Edit|TEST: Scrum Default Issue Screen Edit|View|TEST: Scrum Default Issue Screen View
// JSON representation
/*
[{
"name": "Default",
"value": "TEST: Scrum Default Issue Screen Default"
}, {
"name": "Create",
"value": "TEST: Scrum Default Issue Screen Create"
}, {
"name": "Edit",
"value": "TEST: Scrum Default Issue Screen Edit"
}, {
"name": "View",
"value": "TEST: Scrum Default Issue Screen View"
}]
*/