Class NSLicenseInfo

Represents all licenses for this owner at this site.

Syntax

Constructors

NSLicenseInfo()

Initializes a new instance of the NSLicenseInfo class.

Declaration

NSLicenseInfo

Methods

GetAdminWarningDate()

Represents all licenses for this owner at this site.

Declaration

DateTime GetAdminWarningDate()

Returns

Type	Description
DateTime	When should nagging begin (for instance, during login to SoAdmin).

Examples

NSLicenseInfo thing;
DateTime adminWarningDate = thing.GetAdminWarningDate();

GetCompanyName()

Represents all licenses for this owner at this site.

Declaration

String GetCompanyName()

Returns

Type	Description
String	Name of the database owner company.

Examples

NSLicenseInfo thing;
String companyName = thing.GetCompanyName();

GetDeploymentType()

Represents all licenses for this owner at this site.

Declaration

Integer GetDeploymentType()

Returns

Type	Description
Integer	Type of deployment.

Examples

NSLicenseInfo thing;
Integer deploymentType = thing.GetDeploymentType();

GetExpiryDate()

Represents all licenses for this owner at this site.

Declaration

DateTime GetExpiryDate()

Returns

Type	Description
DateTime	Expiration date, 0 = forever.

Examples

NSLicenseInfo thing;
DateTime expiryDate = thing.GetExpiryDate();

GetExtraFlags()

Represents all licenses for this owner at this site.

Declaration

Integer GetExtraFlags()

Returns

Type	Description
Integer	Unspecified extra flags of license, part of checksum.

Examples

NSLicenseInfo thing;
Integer extraFlags = thing.GetExtraFlags();

GetExtraInfo()

Represents all licenses for this owner at this site.

Declaration

String GetExtraInfo()

Returns

Type	Description
String

GetGraceDate()

Represents all licenses for this owner at this site.

Declaration

DateTime GetGraceDate()

Returns

Type	Description
DateTime	Real expiration date, when the given module actually stops working.

Remarks

Modules that normally update data should switch to read-only mode. Modules that only read anyway, should disable themselves in some other way

Examples

NSLicenseInfo thing;
DateTime graceDate = thing.GetGraceDate();

GetLicenseUrl()

Represents all licenses for this owner at this site.

Declaration

String GetLicenseUrl()

Returns

Type	Description
String	The URL that will provide keycodes for all modules owned by this owner.

Examples

NSLicenseInfo thing;
String licenseUrl = thing.GetLicenseUrl();

GetLicenseVersion()

Represents all licenses for this owner at this site.

Declaration

String GetLicenseVersion()

Returns

Type	Description
String	The URL that will provide keycodes for all modules owned by this owner.

Examples

NSLicenseInfo thing;
String licenseVersion = thing.GetLicenseVersion();

GetMaintenanceDate()

Represents all licenses for this owner at this site.

Declaration

DateTime GetMaintenanceDate()

Returns

Type	Description
DateTime	Expiration date for maintenance. After this date, upgrades should refuse to install.

Examples

NSLicenseInfo thing;
DateTime maintenanceDate = thing.GetMaintenanceDate();

GetModuleLicenses()

Represents all licenses for this owner at this site.

Declaration

NSModuleLicense[] GetModuleLicenses()

Returns

Type	Description
NSModuleLicense[]	The module licenses.

Examples

NSLicenseInfo thing;
NSModuleLicense[] moduleLicenses = thing.GetModuleLicenses();

GetNextCheckDate()

Represents all licenses for this owner at this site.

Declaration

DateTime GetNextCheckDate()

Returns

Type	Description
DateTime	When should the system next check with the license issuer.

Examples

NSLicenseInfo thing;
DateTime nextCheckDate = thing.GetNextCheckDate();

GetOwnerDescription()

Represents all licenses for this owner at this site.

Declaration

String GetOwnerDescription()

Returns

Type	Description
String	Human-readable description of owner, shown in GUI, default language.

Remarks

Additional languages can be added to LocaleText, resource type 26

Examples

NSLicenseInfo thing;
String ownerDescription = thing.GetOwnerDescription();

GetOwnerName()

Represents all licenses for this owner at this site.

Declaration

String GetOwnerName()

Returns

Type	Description
String	The name of the module owner, not visible in GUI but used in the code.

Remarks

OwnerName SUPEROFFICE is reserved and may NEVER be used by partners. This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please.

Examples

NSLicenseInfo thing;
String ownerName = thing.GetOwnerName();

GetProductDescription()

Represents all licenses for this owner at this site.

Declaration

String GetProductDescription()

Returns

Type	Description
String	Description of type of product.

Examples

NSLicenseInfo thing;
String productDescription = thing.GetProductDescription();

GetProductType()

Represents all licenses for this owner at this site.

Declaration

String GetProductType()

Returns

Type	Description
String	Type of product.

Examples

NSLicenseInfo thing;
String productType = thing.GetProductType();

GetPublicKey()

Represents all licenses for this owner at this site.

Declaration

NSSignedPublicKey GetPublicKey()

Returns

Type	Description
NSSignedPublicKey	The public key used to verify licenses owned by this owner.

Examples

NSLicenseInfo thing;
NSSignedPublicKey publicKey = thing.GetPublicKey();

GetSerialNr()

Represents all licenses for this owner at this site.

Declaration

String GetSerialNr()

Returns

Type	Description
String	Serial number. For example, 1010000014.

Examples

NSLicenseInfo thing;
String serialNr = thing.GetSerialNr();

GetSignature()

Represents all licenses for this owner at this site.

Declaration

String GetSignature()

Returns

Type	Description
String	Signature of all non-zero-amount moduleLicense rows referring to this owner.

Examples

NSLicenseInfo thing;
String signature = thing.GetSignature();

SetAdminWarningDate(DateTime)

Represents all licenses for this owner at this site.

Declaration

Void SetAdminWarningDate(DateTime adminWarningDate)

Parameters

Type	Name	Description
DateTime	adminWarningDate	When should nagging begin (for instance, during login to SoAdmin).

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
DateTime adminWarningDate;
thing.SetAdminWarningDate(adminWarningDate);

SetCompanyName(String)

Represents all licenses for this owner at this site.

Declaration

Void SetCompanyName(String companyName)

Parameters

Type	Name	Description
String	companyName	Name of the database owner company.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
String companyName;
thing.SetCompanyName(companyName);

SetDeploymentType(Integer)

Represents all licenses for this owner at this site.

Declaration

Void SetDeploymentType(Integer deploymentType)

Parameters

Type	Name	Description
Integer	deploymentType	Type of deployment.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
Integer deploymentType;
thing.SetDeploymentType(deploymentType);

SetExpiryDate(DateTime)

Represents all licenses for this owner at this site.

Declaration

Void SetExpiryDate(DateTime expiryDate)

Parameters

Type	Name	Description
DateTime	expiryDate	Expiration date, 0 = forever.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
DateTime expiryDate;
thing.SetExpiryDate(expiryDate);

SetExtraFlags(Integer)

Represents all licenses for this owner at this site.

Declaration

Void SetExtraFlags(Integer extraFlags)

Parameters

Type	Name	Description
Integer	extraFlags	Unspecified extra flags of license, part of checksum.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
Integer extraFlags;
thing.SetExtraFlags(extraFlags);

SetExtraInfo(String)

Represents all licenses for this owner at this site.

Declaration

Void SetExtraInfo(String extraInfo)

Parameters

Type	Name	Description
String	extraInfo

Returns

Type	Description
Void

SetGraceDate(DateTime)

Represents all licenses for this owner at this site.

Declaration

Void SetGraceDate(DateTime graceDate)

Parameters

Type	Name	Description
DateTime	graceDate	Real expiration date, when the given module actually stops working.

Returns

Type	Description
Void

Remarks

Modules that normally update data should switch to read-only mode. Modules that only read anyway, should disable themselves in some other way

Examples

NSLicenseInfo thing;
DateTime graceDate;
thing.SetGraceDate(graceDate);

SetLicenseUrl(String)

Represents all licenses for this owner at this site.

Declaration

Void SetLicenseUrl(String licenseUrl)

Parameters

Type	Name	Description
String	licenseUrl	The URL that will provide keycodes for all modules owned by this owner.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
String licenseUrl;
thing.SetLicenseUrl(licenseUrl);

SetLicenseVersion(String)

Represents all licenses for this owner at this site.

Declaration

Void SetLicenseVersion(String licenseVersion)

Parameters

Type	Name	Description
String	licenseVersion	The URL that will provide keycodes for all modules owned by this owner.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
String licenseVersion;
thing.SetLicenseVersion(licenseVersion);

SetMaintenanceDate(DateTime)

Represents all licenses for this owner at this site.

Declaration

Void SetMaintenanceDate(DateTime maintenanceDate)

Parameters

Type	Name	Description
DateTime	maintenanceDate	Expiration date for maintenance. After this date, upgrades should refuse to install.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
DateTime maintenanceDate;
thing.SetMaintenanceDate(maintenanceDate);

SetModuleLicenses(NSModuleLicense[])

Represents all licenses for this owner at this site.

Declaration

Void SetModuleLicenses(NSModuleLicense[] moduleLicenses)

Parameters

Type	Name	Description
NSModuleLicense[]	moduleLicenses	The module licenses.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
NSModuleLicense[] moduleLicenses;
thing.SetModuleLicenses(moduleLicenses);

SetNextCheckDate(DateTime)

Represents all licenses for this owner at this site.

Declaration

Void SetNextCheckDate(DateTime nextCheckDate)

Parameters

Type	Name	Description
DateTime	nextCheckDate	When should the system next check with the license issuer.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
DateTime nextCheckDate;
thing.SetNextCheckDate(nextCheckDate);

SetOwnerDescription(String)

Represents all licenses for this owner at this site.

Declaration

Void SetOwnerDescription(String ownerDescription)

Parameters

Type	Name	Description
String	ownerDescription	Human-readable description of owner, shown in GUI, default language.

Returns

Type	Description
Void

Remarks

Additional languages can be added to LocaleText, resource type 26

Examples

NSLicenseInfo thing;
String ownerDescription;
thing.SetOwnerDescription(ownerDescription);

SetOwnerName(String)

Represents all licenses for this owner at this site.

Declaration

Void SetOwnerName(String ownerName)

Parameters

Type	Name	Description
String	ownerName	The name of the module owner, not visible in GUI but used in the code.

Returns

Type	Description
Void

Remarks

OwnerName SUPEROFFICE is reserved and may NEVER be used by partners. This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please.

Examples

NSLicenseInfo thing;
String ownerName;
thing.SetOwnerName(ownerName);

SetProductDescription(String)

Represents all licenses for this owner at this site.

Declaration

Void SetProductDescription(String productDescription)

Parameters

Type	Name	Description
String	productDescription	Description of type of product.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
String productDescription;
thing.SetProductDescription(productDescription);

SetProductType(String)

Represents all licenses for this owner at this site.

Declaration

Void SetProductType(String productType)

Parameters

Type	Name	Description
String	productType	Type of product.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
String productType;
thing.SetProductType(productType);

SetPublicKey(NSSignedPublicKey)

Represents all licenses for this owner at this site.

Declaration

Void SetPublicKey(NSSignedPublicKey publicKey)

Parameters

Type	Name	Description
NSSignedPublicKey	publicKey	The public key used to verify licenses owned by this owner.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
NSSignedPublicKey publicKey;
thing.SetPublicKey(publicKey);

SetSerialNr(String)

Represents all licenses for this owner at this site.

Declaration

Void SetSerialNr(String serialNr)

Parameters

Type	Name	Description
String	serialNr	Serial number. For example, 1010000014.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
String serialNr;
thing.SetSerialNr(serialNr);

SetSignature(String)

Represents all licenses for this owner at this site.

Declaration

Void SetSignature(String signature)

Parameters

Type	Name	Description
String	signature	Signature of all non-zero-amount moduleLicense rows referring to this owner.

Returns

Type	Description
Void

Examples

NSLicenseInfo thing;
String signature;
thing.SetSignature(signature);