YellowPageModel class | QSYS API Reference Guide
Estimated reading time: 8 minutes
Defines YellowPageModel class and provides a base for the ‘Yellow’ Page Model
Namespace: ASNA.QSys.Expo.Model Assembly: ASNA.QSys.Expo.Model.dll
Inheritance: Object –> PageModel
Remarks
The Web & Application Server components of the Application Architecture have two sub-components that are conveniently identified by the designers with colors: yellow-component and blue-component (basic color theory shows how combining yellow and blue colors renders green). Green Web & Application Server are defined by the Yellow component plus the Blue component.
The YellowPageModel is the class that provides the Yellow component services in the Web & Application Server](/concepts/architecture/application-architecture.html#interactive-job-architecture).
Properties
| Type | Name | Description |
|---|---|---|
| DataSet | ActiveDataSet | Gets the Active DataSet for the Active Displayfile |
| WebDisplayFileProxy | ActiveDisplayFile | Gets the Active Web Displayfile |
| ExpoAjaxRequest | ajaxReq | Gets or sets a value indicating wether the request context type was application AJAX |
| Boolean | creatingFakeData | Internal use. |
| Boolean | InputDataAvailable | When true, derived class defines that data is available on input |
| Int32 | JobHandleForBrowser | Gets the handle for the Job’s session store when using MultiJobOnBrowser. |
| Boolean | renderingFakeData | Internal use. |
| SessionStorage | SessionStore | Gets the SessionStorage instance (creates a new one if it does not exist) |
| Boolean | UserDataIsInvalid | Derived class implements to determine if the user input data is valid |
Methods
| Signature | Description |
|---|---|
| AjaxGetIconCollectionActionResult() | Gets the JsonResult for a “getIconCollection” AJAX request |
| AjaxGetRecordsActionResult() | Gets the JsonResult for a “getRecords” AJAX request |
| ClearModelProperties() | Derived class implements method to Clear all model properties |
| ClearSubfilesInSession() | Clears cached Session storage entries related to All Subfiles. |
| CommitJobSession() | Store the job session in the data store. |
| DumpModelPropertiesToDataSet() | Derived class implements method to Dump Model properties into the DataSet |
| GetFirstSubfileRow(String) | For multiple-row subfile records, gets a string that contains only the fields that will show in the top row, dropping the rest |
| GetSessionTransactionID() | Gets a string value that represents the Transaction ID from the Session storage. |
| GetSubfileRecord(String, Int32) | Gets a cached (in the Session storage) record data for a particular record format, identified by RRN |
| LoadFeedbackValues() | Derived class implements method to load the Displayfile Feedback Area values. |
| LoadModelPropertiesFromDataSet(Boolean) | Derived class implements method to load properties from the DataSet, and which properties |
| MyAjaxActionResult() | Gets the JsonResult with a un-successful response code |
| MyAjaxActionResult(RedirectedException) | Gets the JsonResult with a un-successful response code (redirect parameter ignored) |
| OnCopyBrowserToDspFile() | Callback method right before the data submitted from the Client (browser) is copied to the workstation data on the Web Server. |
| OnCopyDspFileToBrowser() | Callback method right before the workstation data is sent from the Web Server to the Client (browser) |
| OnGet() | Gets the User’s Page’s request response |
| OnGetFake() | Gets the Fake (prototyping) Page request’s response |
| OnJobEnding() | Callback method notifying the server that a Job is ending |
| OnPost() | Gets the Post Request’s Response |
| OnPostFake() | Gets the Fake (prototyping) Post Request’s Response |
| SelectMyAction(Boolean) | Gets the IActionResult as a Page render |
| SetResponseIndicators() | Derived class implements method to set the Response Indicators |
| SetSubfileRecord(String, Int32, String) | Sets the HTML for a record that needs to be cached in the Session Storage |
| StoreHostFilePath(String) | Sets the full path for a particular host file in the Session Storage |
JsonResult AjaxGetIconCollectionActionResult()
Gets the JsonResult for a “getIconCollection” AJAX request
JsonResult AjaxGetIconCollectionActionResult()
JsonResult AjaxGetRecordsActionResult()
Gets the JsonResult for a “getRecords” AJAX request
JsonResult AjaxGetRecordsActionResult()
void ClearModelProperties()
Derived class implements method to Clear all model properties
void ClearModelProperties()
void ClearSubfilesInSession()
Clears cached Session storage entries related to All Subfiles.
void ClearSubfilesInSession()
void CommitJobSession()
Store the job session in the data store.
void CommitJobSession()
void DumpModelPropertiesToDataSet()
Derived class implements method to Dump Model properties into the DataSet
void DumpModelPropertiesToDataSet()
string GetFirstSubfileRow(string recordHTML)
For multiple-row subfile records, gets a string that contains only the fields that will show in the top row, dropping the rest
string GetFirstSubfileRow(string recordHTML)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | recordHTML | full record in HTML |
Returns
| Type | Description |
|---|---|
| String | the HTML with only fields showing in the first row |
string GetSessionTransactionID()
Gets a string value that represents the Transaction ID from the Session storage.
string GetSessionTransactionID()
string GetSubfileRecord(string formatName, int rrn)
Gets a cached (in the Session storage) record data for a particular record format, identified by RRN
string GetSubfileRecord(string formatName, int rrn)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | record format name |
| Int32 | rrn | relative record number |
Returns
| Type | Description |
|---|---|
| String | the HTML text for the subfile record cached |
bool LoadFeedbackValues()
Derived class implements method to load the Displayfile Feedback Area values.
bool LoadFeedbackValues()
void LoadModelPropertiesFromDataSet(bool onlyNonPostedFields)
Derived class implements method to load properties from the DataSet, and which properties
void LoadModelPropertiesFromDataSet(bool onlyNonPostedFields)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Boolean | onlyNonPostedFields | true if only the non-posted properties are loaded. Defaults to false |
JsonResult MyAjaxActionResult()
Gets the JsonResult with a un-successful response code
JsonResult MyAjaxActionResult()
JsonResult MyAjaxActionResult(RedirectedException redirect)
Gets the JsonResult with a un-successful response code (redirect parameter ignored)
JsonResult MyAjaxActionResult(RedirectedException redirect)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| RedirectedException | redirect | Redirected Exception |
Returns
| Type | Description |
|---|---|
| JsonResult | the JsonResult |
void OnCopyBrowserToDspFile()
Callback method right before the data submitted from the Client (browser) is copied to the workstation data on the Web Server.
void OnCopyBrowserToDspFile()
void OnCopyDspFileToBrowser()
Callback method right before the workstation data is sent from the Web Server to the Client (browser)
void OnCopyDspFileToBrowser()
IActionResult OnGet()
Gets the User’s Page’s request response
IActionResult OnGet()
IActionResult OnGetFake()
Gets the Fake (prototyping) Page request’s response
IActionResult OnGetFake()
void OnJobEnding()
Callback method notifying the server that a Job is ending
void OnJobEnding()
IActionResult OnPost()
Gets the Post Request’s Response
IActionResult OnPost()
IActionResult OnPostFake()
Gets the Fake (prototyping) Post Request’s Response
IActionResult OnPostFake()
IActionResult SelectMyAction(bool valid)
Gets the IActionResult as a Page render
IActionResult SelectMyAction(bool valid)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| Boolean | valid | Ignored |
Returns
| Type | Description |
|---|---|
| IActionResult | the Action result |
void SetResponseIndicators()
Derived class implements method to set the Response Indicators
void SetResponseIndicators()
void SetSubfileRecord(string formatName, int rrn, string recordHtml)
Sets the HTML for a record that needs to be cached in the Session Storage
void SetSubfileRecord(string formatName, int rrn, string recordHtml)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | formatName | record format name |
| Int32 | rrn | relative record number |
| String | recordHtml | HTML text |
string StoreHostFilePath(string hostFilePath)
Sets the full path for a particular host file in the Session Storage
string StoreHostFilePath(string hostFilePath)
Parameters
| Type | Parameter name | Description |
|---|---|---|
| String | hostFilePath | The host file full path. |
Returns
| Type | Description |
|---|---|
| String | The ID for the stored host file. |