Routines for loc_brdb.kb


DoesLocationRecordExist

File Name

loc_brdb.kb

Syntax

DoesLocationRecordExist( VAL location_id: STRING, VAL location_name: STRING ): INTEGER

Parameters

location_id - identifier for locations

location_name - location name

Returns

Integer indicating number of locations that exist with the location_id

and location_name provided

Side Effects

None

Description

This function returns the number of locations that exist with the location ID and location name provided.

Dialog Forms Called

None


GetaLocationRec

File Name

loc_brdb.kb

Syntax

GetaLocationRec(REF Loc: LocationRec): INTEGER

Parameters

loc - location record

Returns

Return code from database transaction

Side Effects

None

Description

This function gets a location based on the location ID.

Dialog Forms Called

None


GetLocationID

File Name

loc_brdb.kb

Syntax

GetLocationID(VAL loc_name: STRING): STRING

Parameters

loc_name - location name

Returns

String

Side Effects

None

Description

This function gets the location ID based on the location name

Dialog Forms Called

None


GetLocationIDEqualLocationName

File Name

loc_brdb.kb

Syntax

GetLocationIDEqualLocationName( VAL loc_name: STRING ): STRING

Parameters

loc_name - location name

Returns

String

Side Effects

None

Description

This function returns a location ID where the location name and location ID are equal.

Dialog Forms Called

None


GetLocationList

File Name

loc_brdb.kb

Syntax

GetLocationList(REF lst: LIST OF LocationRec): INTEGER

Parameters

lst - list of location records

Returns

Integer

Side Effects

None

Description

This function gets the full list of location records.

Dialog Forms Called

None


GetLocName

File Name

loc_brdb.kb

Syntax

GetLocName(VAL id: STRING): STRING

Parameters

id - location id

Returns

String

Side Effects

None

Description

This function returns a location name based on the location ID.

Dialog Forms Called

None


GetSomeLocationList

File Name

loc_brdb.kb

Syntax

GetSomeLocationList(REF lst: LIST OF LocationRec, VAL where: STRING, VAL wHdl: WINDOW, VAL organizationID: STRING): INTEGER

Parameters

lst - list of location records

where - where clause to select locations with

wHdl - the window handle of the calling dialog

organizationID - the organization ID to which the select is restricted

Returns

Integer

Side Effects

None

Description

This function returns a list of location records based on the where clause. If multi-customer support is enabled, then the select is also restricted by the organization or the list of locations that the user supports.

Dialog Forms Called

None


GetTimezoneList

File Name

loc_brdb.kb

Syntax

GetTimezoneList(REF tzList: LIST OF STRING): INTEGER

Parameters

tzList - list of time zones

Returns

None

Side Effects

None

Description

This function gets the full list of time zones.

Dialog Forms Called

None