File Name
Syntax
DeleteActionForEntity( REF entity: EntityRecord , REF action: SystemActionsRecord): INTEGER
Parameters
entity - EntityRecord
action - a system action record
Returns
None
Side Effects
None
Description
This function deletes an entity_action records. It removes the relationship between the entity and a system action.
Dialog Forms Called
None
File Name
Syntax
DeleteAssignmentForProfile( REF profileAssign: ProfileAssignRecord): INTEGER
Parameters
profileAssign - profileAssignRecord
Returns
Integer
Side Effects
None
Description
This function will update the user or group to have no profile assigned.
Dialog Forms Called
None
File Name
Syntax
DeleteEntity(REF entity: EntityRecord): INTEGER
Parameters
entity - EntityRecord
Returns
Integer
Side Effects
None
Description
This function deletes the entity record and returns the SQL return code.
Dialog Forms Called
None
File Name
Syntax
DeleteEntityForProfile( REF profile: ProfileRecord , REF entity: EntityRecord): INTEGER
Parameters
profile - profileRecord
entity - EntityRecord
Returns
Integer
Side Effects
None
Description
This function will delete the profile_entity record for the profile and entity provided.
Dialog Forms Called
None
File Name
Syntax
DeleteIcon(REF icon: IconBarRecord): INTEGER
Parameters
icon - IconBarRecord
Returns
Integer
Side Effects
None
Description
This function deletes an icon from the iconbar table.
Dialog Forms Called
None
File Name
Syntax
DeleteMenu(REF menu: MenuBarRecord): INTEGER
Parameters
menu - MenuBarRecord
Returns
Integer
Side Effects
None
Description
This function will delete the menu provided.
Dialog Forms Called
None
File Name
Syntax
DeleteProfile(REF profile: ProfileRecord): INTEGER
Parameters
profile - profileRecord
Returns
Integer
Side Effects
None
Description
This function will delete the profile provided. Deleting the profile will also delete the icons and menus for this profile.
Dialog Forms Called
None
File Name
Syntax
DeleteSystemAction(REF action: SystemActionsRecord): INTEGER
Parameters
action - a system action record
Returns
Integer
Side Effects
None
Description
This function returns the SQLdelete integer return code to the calling function
Dialog Forms Called
None
File Name
Syntax
DuplicateActionName(VAL action_name: STRING, VAL action_id: INTEGER): BOOLEAN
Parameters
action_name - action name
action_id - action ID
Returns
TRUE or FALSE
Side Effects
None
Description
This function returns TRUE if the action name is already being used, FALSE otherwise.
Dialog Forms Called
None
File Name
Syntax
DuplicateEntityName(VAL entity_name: STRING, VAL entity_id: INTEGER): BOOLEAN
Parameters
entity_name - entity name
entity_id - entity ID
Returns
TRUE or FALSE
Side Effects
None
Description
This function returns TRUE if the entity name is already being used, FALSE otherwise.
Dialog Forms Called
None
File Name
Syntax
DuplicateProfileName(VAL profile_name: STRING, VAL profile_id: INTEGER): BOOLEAN
Parameters
profile_name - profile name
profile_id - profile ID
Returns
TRUE if another profile with the same name exists,
FALSE otherwise
Side Effects
None
Description
This function checks whether there is another profile with the same name.
Dialog Forms Called
None
File Name
Syntax
InsertActionsForEntity( VAL entity: EntityRecord , REF actionList: LIST OF SystemActionsRecord): INTEGER
Parameters
entity - EntityRecord
actionList - list of system action records
Returns
None
Side Effects
None
Description
This function inserts the entity_action records and establishes the relationship between the entities and system actions.
Dialog Forms Called
None
File Name
Syntax
InsertAssignmentsForProfile(VAL profile: ProfileRecord , REF profileAssignList: LIST OF ProfileAssignRecord): INTEGER
Parameters
profile - profileRecord
profileAssignList - List of ProfileAssignRecord
Returns
None
Side Effects
None
Description
This function assigns the users and groups in the profileAssignList by updating the user and group table appropriately. Each user and group may only have one profile assigned.
Dialog Forms Called
None
File Name
Syntax
InsertEntitiesForProfile( VAL profile: ProfileRecord , REF entityList: LIST OF EntityRecord): INTEGER
Parameters
profile - profileRecord
entityList - list of EntityRecord
Returns
None
Side Effects
None
Description
This function will associate the profiles the entities in the entityList by inserting a record in the profile_entity table.
Dialog Forms Called
None
File Name
Syntax
InsertEntity(REF entity: EntityRecord): INTEGER
Parameters
entity - EntityRecord
Returns
Integer
Side Effects
None
Description
This function inserts the entity record and returns the SQL return code.
Dialog Forms Called
None
File Name
Syntax
InsertIcon(REF icon: IconBarRecord): INTEGER
Parameters
icon - IconBarRecord
Returns
Integer
Side Effects
None
Description
This function inserts icons into the iconbar table.
Dialog Forms Called
None
File Name
Syntax
InsertMenu(REF menu: MenuBarRecord): INTEGER
Parameters
menu - MenuBarRecord
Returns
integer sql code from sqlinsert
Side Effects
None
Description
This function inserts the menu provided.
Dialog Forms Called
None
File Name
Syntax
InsertProfile(REF profile: ProfileRecord): INTEGER
Parameters
profile - profileRecord
Returns
Integer
Side Effects
None
Description
This function will insert the profile provided.
Dialog Forms Called
None
File Name
Syntax
InsertSystemAction(REF action: SystemActionsRecord): INTEGER
Parameters
action - a system action record
Returns
Integer
Side Effects
None
Description
This function returns the SQLinsert integer return code to the calling function.
Dialog Forms Called
None
File Name
Syntax
MakeDefaultProfile(REF profile: ProfileRecord)
Parameters
profile - profileRecord
Returns
None
Side Effects
None
Description
This procedure will update the profile table and make the profile provided the default.
Dialog Forms Called
None
File Name
Syntax
UpdateActionsForEntity( REF entity: EntityRecord , REF actionList: LIST OF SystemActionsRecord): INTEGER
Parameters
entity - EntityRecord
actionList - list of system action records
Returns
None
Side Effects
None
Description
This function inserts entity_action records for new system actions for this entity and deletes entity_action records for those removed from this entity. It establishes the relationship between the entities and system actions.
Dialog Forms Called
None
File Name
Syntax
UpdateAssignmentsForProfile(REF profile: ProfileRecord , REF profileAssignList: LIST OF ProfileAssignRecord): INTEGER
Parameters
profile - profileRecord
profileAssignList - LIST OF ProfileAssignRecord
Returns
None
Side Effects
None
Description
This function associate the users and groups in the profileAssignList with the profile provided by updating the user/group with the profile. Those users/groups that are not in the profileAssignList but are currently assigned this profile will be updated to not have this profile.
Dialog Forms Called
None
File Name
Syntax
UpdateEntitiesForProfile( REF profile: ProfileRecord , REF entityList: LIST OF EntityRecord): INTEGER
Parameters
profile - profileRecord
entityList - List of EntityRecord
Returns
None
Side Effects
None
Description
This function associate the entities in the entityList with the profile provided by inserting a profile_entity record for those that do not have a relationship and deleting those that have a relationship but are not in the list.
Dialog Forms Called
None
File Name
Syntax
UpdateEntity( REF oldEntity: EntityRecord, REF entity: EntityRecord): INTEGER
Parameters
oldEntity - EntityRecord
entity - EntityRecord
Returns
Integer
Side Effects
None
Description
This function updates the entity record and returns the SQL return code.
Dialog Forms Called
None
File Name
Syntax
UpdateIcon(REF oldIcon: IconBarRecord, REF icon: IconBarRecord): INTEGER
Parameters
oldIcon - IconBarRecord
icon - IconBarRecord
Returns
Integer
Side Effects
None
Description
This function updates the icon record in the iconbar table. This function uses passive concurrency.
Dialog Forms Called
None
File Name
Syntax
UpdateMenu(REF oldMenu: MenuBarRecord, REF menu: MenuBarRecord): INTEGER
Parameters
oldMenu - MenuBarRecord
menu - MenuBarRecord
Returns
Integer
Side Effects
None
Description
This function will update the menu provided. This function uses passive concurrency on update.
Dialog Forms Called
None
File Name
Syntax
UpdateProfile(REF oldProfile: ProfileRecord, REF profile: ProfileRecord): INTEGER
Parameters
oldProfile,profile - profileRecord
Returns
Integer
Side Effects
None
Description
This function will update the profile provided. It will use passive concurrency.
Dialog Forms Called
None
File Name
Syntax
UpdateSystemAction(REF oldAction: SystemActionsRecord, REF action: SystemActionsRecord): INTEGER
Parameters
action - the new system action record
oldAction - the old system action record
Returns
Integer
Side Effects
None
Description
This function returns the SQLupdate integer return code to the calling function.
Dialog Forms Called
None