licenseObject

This function creates a helper object that you can use to view and modify license information and expiration information.

Version

1.6

Constructors

Parameter Type Description
licNumber string State license number of the reference licensed professional to link to the license object.
capId (optional) CapIDModel Record ID to use for the license object. Identifies the record from which to load renewal information.

Notes

This constructor populates the licenseObject for the license number specified and the currently loaded capId. If licNumber has a value, the helper object attempts to replicate changes to a reference license professional, as well as the record.

Parameters

Parameter Description
refProf The referenced licensed professional.
b1Exp Contains the b1 record (renewal status on record).
b1ExpDate Returns the license expiration date in mm/dd/yyyy format (read only).
b1ExpCode Returns the expiration code.
b1Status Returns the license renewal status (read only).
refExpDate Returns the license professional expiration date in mm/dd/yyyy format (read only).
licNum The license number.

Example

var licObj = licenseObject("1234");

Methods

  • getCode

    Gets the expiration status of the record.

    • Parameters

      None

    • Return

      Returns the expiration code configured for the license.

    • Example

      var licObj = licenseObject("1234"); 
var code = licObj.getCode();

  • getStatus

    Gets the expiration status of the record.

    • Parameters

      None

    • Return

      Returns the expiration status

    • Example

      var licObj = licenseObject("1234"); 
var status = licObj.getStatus();

  • setExpiration

    Sets the expiration date on the license record and associate reference license professional to the provided value.

    • Parameters

      Parameter Type Description
      expDate string Expiration date in string format.

    • Example

      licObj.setExpiration("01/01/2020");

  • setIssued

    Sets the issued date on the license record and associate reference license professional to the provided value.

    • Parameters

      Parameter Type Description
      issDate string Issued date in string format.

    • Example

      licObj.setIssued("01/01/2000");

  • setLastRenewal

    Sets the renewed date on the license record and associate reference license professional to the provided value.

    • Parameters

      Parameter Type Description
      renewDate string Renewed date in string format.

    • Example

      licObj.setLastRenewal("01/01/2000");