Routines for org_brdb.kb


GetAssetPreferenceID

File Name

org_brdb.kb

Syntax

GetAssetPreferenceID(VAL assetPreferenceName: STRING): INTEGER

Parameters

assetPreferenceName - the name of the Asset preference

Returns

Integer

Side Effects

None

Description

This function retrieves the preference ID for the preference name.

Dialog Forms Called

None


GetAssetPreferenceName

File Name

org_brdb.kb

Syntax

GetAssetPreferenceName(VAL assetPreferenceID: INTEGER): STRING

Parameters

assetPreferenceID - the preference ID for the asset preference

Returns

String

Side Effects

None

Description

This function retrieves the preference ID for the preference name provided.

Dialog Forms Called

None


GetAssetPreferenceNameList

File Name

org_brdb.kb

Syntax

GetAssetPreferenceNameList: LIST OF STRING

Parameters

None

Returns

List of string

Side Effects

None

Description

This function retrieves the name of all the asset preferences in alphabetical order.

Dialog Forms Called

None


GetOrganization

File Name

org_brdb.kb

Syntax

GetOrganization(REF org: OrganizationRec,VAL ID: STRING): INTEGER

Parameters

org - organization record

ID - organization ID

Returns

Integer

Side Effects

None

Description

This function gets the organization record based on the organization ID.

Dialog Forms Called

None


GetOrganizationList

File Name

org_brdb.kb

Syntax

GetOrganizationList ( VAL People_ID: INTEGER ): LIST OF Org_MembershipRec

Parameters

people_id - primary key identifer for people records

Returns

List of string

Side Effects

None

Description

This function gets the organization member records for the people ID.

Dialog Forms Called

None


GetOrgCapabilities

File Name

org_brdb.kb

Syntax

GetOrgCapabilities(VAL organization_ID: STRING, REF org_cap: Eweb_Org_RightsRec): INTEGER

Parameters

organization_ID - he organization ID for which the capabilities are retrieved

org_cap - the data that is retrieved

Returns

Integer

Side Effects

None

Description

This function retrieves the organization capabilities for the organization ID.

Dialog Forms Called

None


GetOrgID

File Name

org_brdb.kb

Syntax

GetOrgID( VAL name: STRING ): STRING

Parameters

name - organization name

Returns

String

Side Effects

None

Description

This function gets the organization ID based on the organization name.

Dialog Forms Called

None


GetOrgMemberRecs

File Name

org_brdb.kb

Syntax

GetOrgMemberRecs(VAL people_id: INTEGER, REF lst: LIST OF Org_MembershipRec): INTEGER

Parameters

people_id - integer identifier for a person

Returns

Integer

Side Effects

None

Description

This function gets the organization member records for the people ID.

Dialog Forms Called

None


GetOrgMemberViewList

File Name

org_brdb.kb

Syntax

GetOrgMemberViewList(REF lst: LIST OF OrgMemberViewRec, VAL organization_id: STRING, VAL sel_string: STRING ): INTEGER

Parameters

lst - list of organization record

organization_id - identifier of organization ID

sel_string - where clause with which to select organizations

Returns

String

Side Effects

None

Description

This function gets the list of organization member records based on the select string.

Dialog Forms Called

None


GetOrgName

File Name

org_brdb.kb

Syntax

GetOrgName(VAL id: STRING): STRING

Parameters

id - identifier of organization ID

Returns

String

Side Effects

None

Description

This function gets the organization name based on the organization ID.

Dialog Forms Called

None


GetOrgPreference

File Name

org_brdb.kb

Syntax

GetOrgPreference(VAL organization_ID: STRING, VAL paramName: STRING): STRING

Parameters

organization_ID - the organization ID for which the setting is retrieved

ParamName - specifies the type of setting to retrieve

Returns

String

Side Effects

None

Description

This function retrieves the organization setting for the organization ID and parameter provided. If the organization does not have a setting, it recursively travels up the tree and tries to get the setting from the organization's parent. If there are multiple parents, nothing is returned. If there are no parents and paramName is ASSETPREF, 1 is returned to indicate the PUBLIC preferences. If there are no parents and the paramName is not ASSETPREF, nothing is returned.

Dialog Forms Called

None


GetOrgSetting

File Name

org_brdb.kb

Syntax

GetOrgSetting(VAL organization_ID: STRING, VAL ParamName: STRING, REF orgSetting: OrgSettingRec): INTEGER

Parameters

organization_ID - the organization ID for which the setting is retrieved

ParamName - specifies the type of setting to retrieve

orgSetting - the data that is retrieved

Returns

String

Side Effects

None

Description

This function retrieves the organization settings for the organization ID and parameter provided.

Dialog Forms Called

None


GetSomeOrgList

File Name

org_brdb.kb

Syntax

GetSomeOrgList(REF lst: LIST OF OrganizationRec, VAL where: STRING): INTEGER

Parameters

lst - list of organization record

where - where clause with which to select organizations

Returns

Integer

Side Effects

None

Description

This function gets the list of organization records based on the where clause.

Dialog Forms Called

None


IsDefaultMembership

File Name

org_brdb.kb

Syntax

IsDefaultMembership(VAL people_id, org_member_id: INTEGER): BOOLEAN

Parameters

people_id - integer identifier for person

org_member_id - integer identifier for org_membership record

Returns

TRUE if organization is the persons default, FALSE otherwise

Side Effects

None

Description

This function checks whether the organization is the default organization of which the person is a member.

Dialog Forms Called

None


IsOnlyMembership

File Name

org_brdb.kb

Syntax

IsOnlyMembership(VAL people_id, org_member_id: INTEGER): BOOLEAN

Parameters

people_id - integer identifier for person

org_member_id - integer identifier for org_membership record

Returns

TRUE if organization only membership, FALSE otherwise

Side Effects

None

Description

This function checks if the organization is the only one of which the person is a member.

Dialog Forms Called

None


OrgIsRoot

File Name

org_brdb.kb

Syntax

OrgIsRoot(VAL organization_id: STRING): BOOLEAN

Parameters

organization_id - integer identifier for organization

Returns

TRUE if organization is a root node, FALSE otherwise

Side Effects

None

Description

This function gets the organization member records for the people ID.

Dialog Forms Called

None