CAdmin

Functions

Delete

Description
Deletes a record from the database.

Syntax
x = CAdmin.Delete (Optional oLocation As cLocation, Optional oPriority As CPriority, Optional oSkill As CSkill, Optional oTech As CTech)

 Parameters
Optional  oLocation as cLocation
Optional  oPriority as CPriority
Optional  oSkill as CSkill
Optional  oTech as CTech

Remarks
Although this method accepts three parameters, only one is accepted at any time. If more than one parameter is passed in, the method fails. Because each parameter is optional you must use named parameters to pass in the appropriate object. This method is not exposed to the HDUser or HDTech applications for data integrity reasons. For a further explanation , see "The HelpDesk Sample: Overview of an Automated Solution."

ExtrPKId

Description
Extracts the PKId from a previously formatted string.

Syntax
x = CAdmin.ExtrPKId (ByVal sFmtPKid As String)

 Parameters
ByVal sFmtPKid as String

Return type
Integer

Remarks
This method expects the input string to be in the format of a FmtPKId result string.

FmtPKId

Description
Generates a predetermined string code that can be used to search the HelpDesk collections for a record's PKId.

Syntax
x = CAdmin.FmtPKId (ByVal iPKid As Integer)

 Parameters
ByVal iPKid as Integer

Return type
String

Remarks
Visual Basic collections cannot be searched using a numeric key. This function generates a string using a predetermined format, thus allowing a collection to be searched for a "stringized" numeric value.

GetRequest

Description
Given a request's tracking number, retrieves the request from the database .

Syntax
set obj = CAdmin.GetRequest (ByVal lTrackNo As Long)

 Parameters
ByVal lTrackNo as Long

Return type
CRequest

GetRequestsByTechId

Description
Given a technician's PKId, retrieves all the specified technician's requests, from the database, in the form of a collection.

Syntax
set obj = CAdmin.GetRequestsByTechId (ByVal lTechId As Long)

Parameters
ByVal lTechId as Long

Return type
Collection

Init

Description
Initializes the HelpDesk sample and validates the user.

Syntax
x = CAdmin.Init (ByVal sAlias As String, ByVal iLoggedInType As Integer)

 Parameters
ByVal sAlias as String
ByVal iLoggedInType as Integer

Return type
Boolean

Remarks
The alias passed in is validated against the tbTech table. The LoggedInType parameter determines whether the user is a technician or a user.

Insert

Description
Inserts a record into one of the domains.

Syntax
x = CAdmin.Insert (Optional oLocation As cLocation, Optional oPriority As CPriority, Optional oSkill As CSkill, Optional oTech As CTech)

Parameters
Optional  oLocation as cLocation
Optional  oPriority as CPriority
Optional  oSkill as CSkill
Optional  oTech as CTech

Return type
Boolean

Remarks
Although this method accepts three parameters, only one is accepted at any time. If more than one parameter is passed in, the method fails. Because each parameter is optional, you must use named parameters to pass in the appropriate object. This method is not exposed to the HDUser or HDTech applications for data integrity reasons. For a further explanation, see "The HelpDesk Sample: Overview of an Automated Solution."

Update

Description
Updates an existing record in one of the domains.

Syntax
x = CAdmin.Update (Optional oLocation As cLocation, Optional oPriority As CPriority, Optional oSkill As CSkill, Optional oTech As CTech)

 Parameters
Optional  oLocation as cLocation
Optional  oPriority as CPriority
Optional  oSkill as CSkill
Optional  oTech as CTech

Return type
Boolean

Remarks
Although this method accepts three parameters, only one is accepted at any time. If more than one parameter is passed in, the method fails. Because each parameter is optional, you must use named parameters to pass in the appropriate object. This method is not exposed to the HDUser or HDTech applications for data integrity reasons. For a further explanation, see "The HelpDesk Sample: Overview of an Automated Solution."

Subroutines

Term

Description
Terminates and cleans up all internal data structures.

Syntax
CAdmin.Term ()

Remarks
Use this method prior to releasing any CAdmin objects.

Refresh

Description
Refreshes the internal collections with new data.

Syntax
CAdmin.Refresh ()