Routines for rmod_db.kb


EnableadHocEntry

File Name

rmod_db.kb

Syntax

EnableadHocEntry( VAL category: STRING ): INTEGER;

Parameters

category - category ID

Returns

Integer

Side Effects

None

Description

This routine sets the "AdHoc" column for the given category to TRUE.

Dialog Forms Called

None


R_CheckForDupModelApprovers

File Name

rmod_db.kb

Syntax

R_CheckForDupModelApprovers (VAL thisApproval: R_MO_APPROVAL_REC, VAL R_G_SModel: R_MODEL_STATE_REC ): BOOLEAN

Parameters

thisApproval - Model approval record

R_G_SModel - Model record

Returns

Boolean

Side Effects

None

Description

This routine checks for duplicate model approvers. If a duplicate model approval requirement is found then TRUE is returned, otherwise FALSE is returned.

Dialog Forms Called

None


R_DetermineTheRootModel

File Name

rmod_db.kb

Syntax

R_DetermineTheRootModel(VAL PassedIn_Model_ID: INTEGER, REF root_model_id: INTEGER, REF approval_method: STRING) IS

Parameters

PassedIn_Model_ID - Current model ID

root_model_id - root model ID (to be discoverd.)

approval_method - approval method (to be discoverd.)

Returns

Nothing

Side Effects

None

Description

Given a change_id, this procedure will find the high-level model ID and it's approval method. It supports the Business Rule that All activities will have the same approval method as their high-level model parent.

Dialog Forms Called

None


R_FindModelInList

File Name

rmod_db.kb

Syntax

R_FindModelInList(VAL ID: INTEGER, VAL ModelList: LIST OF R_MODEL_REC ): R_MODEL_REC IS

Parameters

ID - Model ID to find

ModelList - List of models to search

Returns

R_MODEL_REC

Side Effects

None

Description

This routine finds the model with the specified ID.

Dialog Forms Called

None


R_FindModelSchedInList

File Name

rmod_db.kb

Syntax

R_FindModelSchedInList(VAL Sched_Name: STRING, VAL TaskList: LIST OF R_MODEL_TASK_REC ): R_MODEL_TASK_REC IS

Parameters

Sched_Name - Schedule name to find (Sched_Name is the primary key)

TaskList - List of schedules to search

Returns

R_MODEL_TASK_REC

Side Effects

None

Description

This routine finds the Schedule with the specified name.

Dialog Forms Called

None


R_LoadActivitiesForModel

File Name

rmod_db.kb

Syntax

R_LoadActivitiesForModel: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves model activities from the database.

Dialog Forms Called

None


R_LoadAllModelTrees

File Name

rmod_db.kb

Syntax

R_LoadAllModelTrees(REF treeList: LIST OF R_MTREE_REC): INTEGER IS

Parameters

treeList - List of tree records

Returns

Integer

Side Effects

None

Description

This routine retrieves all model trees from the database.

Dialog Forms Called

None


R_LoadApprovalsForModel

File Name

rmod_db.kb

Syntax

R_LoadApprovalsForModel: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves model approvals from the database.

Dialog Forms Called

None


R_LoadAttachedFilesForModel

File Name

rmod_db.kb

Syntax

R_LoadAttachedFilesForModel: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves all file attachments for a model.

Dialog Forms Called

None


R_LoadChangeTextForModel

File Name

rmod_db.kb

Syntax

R_LoadChangeTextForModel (REF otherText: LIST OF R_CHANGE_TEXT_REC ): INTEGER IS

Parameters

otherText - list of change text records

Returns

Integer

Side Effects

None

Description

This routine retrieves change_text records from the database for a model.

Dialog Forms Called

None


R_LoadCommandsForModel

File Name

rmod_db.kb

Syntax

R_LoadCommandsForModel (REF commands: LIST OF R_MO_SCHED_COMMANDS_REC ): INTEGER IS

Parameters

commands - task commands

Returns

Integer

Side Effects

None

Description

This routine retrieves schedule commands from the database for a model.

Dialog Forms Called

None


R_LoadCommandsForModelSchedule

File Name

rmod_db.kb

Syntax

R_LoadCommandsForModelSchedule: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves commands from the database for a scheduled task.

Dialog Forms Called

None


R_LoadDependenciesForModel

File Name

rmod_db.kb

Syntax

R_LoadDependenciesForModel (REF dependencies: LIST OF R_MO_DEPENDENCY_REC

Parameters

dependencies - task dependencies

Returns

Integer

Side Effects

None

Description

This routine retrieves schedule dependencies from the database for a model.

Dialog Forms Called

None


R_LoadDependenciesForModelSchedule

File Name

rmod_db.kb

Syntax

R_LoadDependenciesForModelSchedule: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves dependencies from the database for a scheduled task.

Dialog Forms Called

None


R_LoadEntireModel

File Name

rmod_db.kb

Syntax

R_LoadEntireModel: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves an entire model from the database.

Dialog Forms Called

None


R_LoadImpactsForModel

File Name

rmod_db.kb

Syntax

R_LoadImpactsForModel: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves model impacts from the database.

Dialog Forms Called

None


R_LoadKeywordsForModel

File Name

rmod_db.kb

Syntax

R_LoadKeywordsForModel(REF keywords: LIST OF R_MO_KEYWORDS_REC ): INTEGER IS

Parameters

keywords - impact keywords

Returns

Integer

Side Effects

None

Description

This routine retrieves impact keywords from the database for a model.

Dialog Forms Called

None


R_LoadModelByCategory

File Name

rmod_db.kb

Syntax

R_LoadModelByCategory(VAL categoryId: STRING, REF this_Model: R_MODEL_REC): INTEGER IS

Parameters

categoryID - Selected category ID

this_model - Current model

Returns

Integer

Side Effects

None

Description

This routine retrieves models from the database by specified category.

Dialog Forms Called

None


R_LoadModelByID

File Name

rmod_db.kb

Syntax

R_LoadModelByID(REF this_Model: R_MODEL_REC): INTEGER IS

Parameters

this_Model - Current model record

Returns

Integer

Side Effects

None

Description

This routine retrieves a model from the database.

Dialog Forms Called

None


R_LoadModelImpactByCategory

File Name

rmod_db.kb

Syntax

R_LoadModelImpactByCategory(REF this_Impact: R_MO_IMPACT_REC ): INTEGER IS

Parameters

this_Impact - model impact

Returns

Integer

Side Effects

None

Description

This routine retrieves model impact from the database for an impact.

Dialog Forms Called

None


R_LoadModelImpacts

File Name

rmod_db.kb

Syntax

R_LoadModelImpacts(VAL w: WINDOW, REF found: BOOLEAN ): INTEGER

Parameters

w - Current window

found - Boolean variable

Returns

Integer

Side Effects

None

Description

This routine loads the model impacts for a given model ID.

Dialog Forms Called

None


R_LoadModelKeywordsForImpact

File Name

rmod_db.kb

Syntax

R_LoadModelKeywordsForImpact: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves impact keywords from the database.

Dialog Forms Called

None


R_LoadModels

File Name

rmod_db.kb

Syntax

R_LoadModels(VAL Model_SQL_String: STRING): INTEGER IS

Parameters

Model_SQL_String - Selection criteria string

Returns

Integer

Side Effects

None

Description

This routine retrieves models from the database.

Dialog Forms Called

None


R_LoadModelScheduleByName

File Name

rmod_db.kb

Syntax

R_LoadModelScheduleByName(REF this_Task: R_MODEL_TASK_REC ): INTEGER IS

Parameters

this_Task - model task

Returns

Integer

Side Effects

None

Description

This routine retrieves model scheduled task from the database for a schedule.

Dialog Forms Called

None


R_LoadModelTrees

File Name

rmod_db.kb

Syntax

R_LoadModelTrees(REF treeList: LIST OF R_MTREE_REC): INTEGER IS

Parameters

treeList - List of tree records

Returns

Integer

Side Effects

None

Description

This routine retrieves model trees from the database.

Dialog Forms Called

None


R_LoadModelTreesByChild

File Name

rmod_db.kb

Syntax

R_LoadModelTreesByChild(REF treeList: LIST OF R_MTREE_REC, VAL Model_ID: INTEGER): INTEGER IS

Parameters

treeList - List of tree records

Model_ID - Current model ID

Returns

Integer

Side Effects

None

Description

This routine retrieves model trees from the database for an ID.

Dialog Forms Called

None


R_LoadModelTreesByParent

File Name

rmod_db.kb

Syntax

R_LoadModelTreesByParent(REF treeList: LIST OF R_MTREE_REC, VAL Model_ID: INTEGER): INTEGER IS

Parameters

treeList - List of tree records

Model_ID - Current model ID

Returns

Integer

Side Effects

None

Description

This routine retrieves model trees from the database for an ID.

Dialog Forms Called

None


R_LoadRemainingModelActivities

File Name

rmod_db.kb

Syntax

R_LoadRemainingModelActivities( VAL w: Window, REF found: BOOLEAN, VAL AIndex: INTEGER ): INTEGER IS

Parameters

w - Current window

found - Boolean variable

Returns

Integer

Side Effects

None

Description

This routine loads any remaining model activities.

Dialog Forms Called

None


R_LoadResourcesForModel

File Name

rmod_db.kb

Syntax

R_LoadResourcesForModel (REF resourceList: LIST OF R_MO_RESOURCE_REC ): INTEGER IS

Parameters

resourceList - task resources

Returns

Integer

Side Effects

None

Description

This routine retrieves schedule resources from the database for a model.

Dialog Forms Called

None


R_LoadResourcesForModelSchedule

File Name

rmod_db.kb

Syntax

R_LoadResourcesForModelSchedule: INTEGER IS

Parameters

None

Returns

Integer

Side Effects

None

Description

This routine retrieves resources from the database for a scheduled task.

Dialog Forms Called

None


R_LoadSchedulesForModel

File Name

rmod_db.kb

Syntax

R_LoadSchedulesForModel: INTEGER IS

Parameters

None

Returns

Nothing

Side Effects

None

Description

This routine retrieves model scheduled tasks from the database.

Dialog Forms Called

None


R_ModelApprovalRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelApprovalRecordDatabase(VAL InTran: BOOLEAN, VAL this_Approval: R_MO_APPROVAL_REC, VAL old_Approval: R_MO_APPROVAL_REC ): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

this_Approval - Current approval record

old_Approval - Old record for database concurrency

Returns

Integer

Side Effects

None

Description

This routine controls the addition, modification, and removal of model approvals.

Dialog Forms Called

None


R_ModelAttachmentRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelAttachmentRecordDatabase(VAL InTran: BOOLEAN, VAL this: R_MO_ATTACHMENT_REC, VAL old: R_MO_ATTACHMENT_REC): INTEGER IS

Parameters

InTran - Flag to determine whether in a transaction

this - Current model attachment record

old - Old record for database concurrency

Returns

Integer

Side Effects

None

Description

This routine controls the addition, modification, and removal of attachments.

Dialog Forms Called

None


R_ModelImpactRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelImpactRecordDatabase(VAL InTran: BOOLEAN, VAL this_Impact: R_MO_IMPACT_REC, VAL old_Impact: R_MO_IMPACT_REC ): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

this_Impact - Current impact record

old_Impact - Old record for database concurrency

Returns

Integer

Side Effects

None

Description

This routine controls the addition, modification, and removal of model impacts.

Dialog Forms Called

None


R_ModelKeywordsRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelKeywordsRecordDatabase(VAL InTran: BOOLEAN, VAL this_ImpKeyword: R_MO_KEYWORDS_REC, VAL old_ImpKeyword: R_MO_KEYWORDS_REC ): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

this_ImpKeyword - Current impact keyword record

old_ImpKeyword - Old record for database concurrency

Returns

None

Side Effects

Integer

Description

This routine controls the addition, modification, and removal of impact keywords.

Dialog Forms Called

None


R_ModelRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelRecordDatabase(VAL InTran: BOOLEAN): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

Returns

None

Side Effects

None

Description

This routine controls the addition, modification, and removal of models.

Dialog Forms Called

None


R_ModelSchedCommandRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelSchedCommandRecordDatabase(VAL InTran: BOOLEAN, VAL this_SchedCommand: R_MO_SCHED_COMMANDS_REC, VAL old_SchedCommand: R_MO_SCHED_COMMANDS_REC ): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

this_SchedCommand - Current schedule command record

old_SchedCommand - Old record for database concurrency

Returns

Integer

Side Effects

None

Description

This routine controls the addition, modification, and removal of schedule commands.

Dialog Forms Called

None


R_ModelSchedDependencyRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelSchedDependencyRecordDatabase(VAL InTran: BOOLEAN, VAL this_Dependency: R_MO_DEPENDENCY_REC, VAL old_Dependency: R_MO_DEPENDENCY_REC ): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

this_Dependency - Current task dependency record

old_Dependency - Old record for database concurrency

Returns

Integer

Side Effects

None

Description

This routine controls the addition, modification, and removal of task dependencies.

Dialog Forms Called

None


R_ModelSchedResourceRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelSchedResourceRecordDatabase(VAL InTran: BOOLEAN, VAL this_Resource: R_MO_RESOURCE_REC, VAL old_Resource: R_MO_RESOURCE_REC ): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

this_Resource - Current schedule resource record

old_Resource - Old record for database concurrency

Returns

Integer

Side Effects

None

Description

This routine controls the addition, modification, and removal of schedule resources.

Dialog Forms Called

None


R_ModelScheduleRecordDatabase

File Name

rmod_db.kb

Syntax

R_ModelScheduleRecordDatabase(VAL InTran: BOOLEAN, VAL this_Task: R_MODEL_TASK_REC, VAL old_Schedule: R_MODEL_TASK_REC ): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

this_Task - Current scheduled task record

old_Schedule - Old record for database concurrency

Returns

Integer

Side Effects

None

Description

This routine controls the addition, modification, and removal of model schedule tasks.

Dialog Forms Called

None


R_MTreeRecordDatabase

File Name

rmod_db.kb

Syntax

R_MTreeRecordDatabase(VAL InTran: BOOLEAN, VAL this_MTree: R_MTREE_REC, VAL old_MTree: R_MTREE_REC): INTEGER IS

Parameters

InTran - Flag to determine if within a transaction

this_MTree - Current tree record

old_MTree - Old record for database concurrency

Returns

Integer

Side Effects

None

Description

This routine controls the addition, modification, and removal of model trees.

Dialog Forms Called

None


R_ReturnModelsList

File Name

rmod_db.kb

Syntax

R_ReturnModelsList( R_lastSQLSelect ): LIST OF R_MODEL_REC IS

Parameters

R_lastSQLSelect - SQL statement

Returns

List of R_Model_Rec

Side Effects

None

Description

This routine retrieves a list of models for the "Work With Models" dialog.

Dialog Forms Called

None