3.2.4.2.30.1 Commit (Opnum 11)

The Commit method is implemented as one of the methods for the IFsrmObject interface (section 3.2.4.2.10). This method has the same behavior as described in section 3.2.4.2.10.5 with the following additional behavior:

  • If Blocked file groups is an empty list, the server MUST return FSRM_E_INVALID_DATASCREEN_DEFINITION.

  • If FSRM Base Object.Deleted is set to true for this Non-Persisted File Screen Template Instance (section 3.2.1.3.3.2), the server MUST remove the Persisted File Screen Template (section 3.2.1.3.3.1) from the List of Persisted File Screen Templates (section 3.2.1.3) that has the same File Screen Template.Name as this Non-Persisted File Screen Template Instance, if one exists. This removal MUST occur even if other changes were made to the configuration of the Non-Persisted File Screen Template Instance. If there is no Persisted File Screen Template in the List of Persisted File Screen Templates that has the same File Screen Template.Name as this Non-Persisted File Screen Template Instance being deleted, the server does not perform any action and MUST return zero. The server MUST return a nonzero error code if removal fails.

  • If FSRM Base Object.Deleted is set to false for this Non-Persisted File Screen Template Instance, the server MUST update the configuration data of the Persisted File Screen Template in the List of Persisted File Screen Templates that has the same File Screen Template.Name as this Non-Persisted File Screen Template Instance, if one exists, with the configuration data from this instance.

  • If a Persisted File Screen Template does not exist with the same File Screen Template.Name and FSRM Base Object.Deleted is set to false, the server MUST perform the following actions:

    • Create a new Persisted File Screen Template.

    • Populate its configuration with the configuration from this Non-Persisted File Screen Template Instance.

    • Add the new Persisted File Screen Template to the List of Persisted File Screen Templates.

  • If a Persisted File Screen Template exists on the server with the same name as the imported file screen template and its File Screen.Overwrite on commit property set to true, the existing Persisted File Screen Template is overwritten with the imported file screen template.

To update or populate the configuration data from a Non-Persisted File Screen Template Instance to a Persisted File Screen Template, the server MUST assign the values of all the properties shown in the list that follows of the Non-Persisted File Screen Template Instance to the corresponding properties of the Persisted File Screen Template.

  • FSRM Base Object.Description

  • File Screen Template.Name

  • Blocked file groups

  • Notifications (Actions) for each notification in the list, the server MUST assign the values of all properties that apply to the notification, depending on the type of action. See section 3.2.1.4 for details on the possible action types and the set of notification properties maintained for each type of action.

  • File screen mode