Class NSModuleLicense

Represents a single module license info.

Syntax

Constructors

NSModuleLicense()

Initializes a new instance of the NSModuleLicense class.

Declaration

NSModuleLicense

Methods

GetAllowedUserType()

Represents a single module license info.

Declaration

Integer GetAllowedUserType()

Returns

Type	Description
Integer	Allowed associate type for user licenses internal(0), external(4).

Examples

NSModuleLicense thing;
Integer allowedUserType = thing.GetAllowedUserType();

GetExtraFlags()

Represents a single module license info.

Declaration

Integer GetExtraFlags()

Returns

Type	Description
Integer	Unspecified extra flags of license, part of checksum. Value=1 means this a 'user plan'; such licenses cause the admin gui to switch to radiobutton view.

Examples

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

GetExtraInfo()

Represents a single module license info.

Declaration

String GetExtraInfo()

Returns

Type	Description
String	Free field, can be used by the module owner (for example host domain, for Service).

Remarks

For rows with extraFlags=1 this field contains the list of modules that this plan comprises

Examples

NSModuleLicense thing;
String extraInfo = thing.GetExtraInfo();

GetIsHidden()

Represents a single module license info.

Declaration

Bool GetIsHidden()

Returns

Type	Description
Bool	If true, then this module should not appear in GUI and is not assignable by users.

Examples

NSModuleLicense thing;
Bool isHidden = thing.GetIsHidden();

GetLicenseType()

Represents a single module license info.

Declaration

Integer GetLicenseType()

Returns

Type	Description
Integer	Entire system, per database, or per associate. See LicenseType.

Examples

NSModuleLicense thing;
Integer licenseType = thing.GetLicenseType();

GetModuleDescription()

Represents a single module license info.

Declaration

String GetModuleDescription()

Returns

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

Remarks

Additional languages can be added to LocaleText, resource type 25

Examples

NSModuleLicense thing;
String moduleDescription = thing.GetModuleDescription();

GetModuleName()

Represents a single module license info.

Declaration

String GetModuleName()

Returns

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

Remarks

This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please.

Examples

NSModuleLicense thing;
String moduleName = thing.GetModuleName();

GetModuleTooltip()

Represents a single module license info.

Declaration

String GetModuleTooltip()

Returns

Type	Description
String	Tooltip text, anything you want; shown when the cursor hovers over the line in the GUI. Default language.

Remarks

Additional languages can be added to LocaleText, resource type 27

Examples

NSModuleLicense thing;
String moduleTooltip = thing.GetModuleTooltip();

GetModuleVersion()

Represents a single module license info.

Declaration

String GetModuleVersion()

Returns

Type	Description
String	Version string for this module.

Examples

NSModuleLicense thing;
String moduleVersion = thing.GetModuleVersion();

GetNumberOfLicenses()

Represents a single module license info.

Declaration

Integer GetNumberOfLicenses()

Returns

Type	Description
Integer	Number of licenses purchased.

Examples

NSModuleLicense thing;
Integer numberOfLicenses = thing.GetNumberOfLicenses();

GetOwnerName()

Represents a single module license info.

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

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

GetPrerequisiteModuleName()

Represents a single module license info.

Declaration

String GetPrerequisiteModuleName()

Returns

Type	Description
String	If set, specifies a module license needed before this license can be granted.

Examples

NSModuleLicense thing;
String prerequisiteModuleName = thing.GetPrerequisiteModuleName();

GetSignature()

Represents a single module license info.

Declaration

String GetSignature()

Returns

Type	Description
String	Signature that verifies that this row is correctly transferred from SuperLicense.

Examples

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

GetSortOrder()

Represents a single module license info.

Declaration

Integer GetSortOrder()

Returns

Type	Description
Integer	Ordering value, generated by SuperLicense and transferred here. Must be followed for signatures to be correct.

Examples

NSModuleLicense thing;
Integer sortOrder = thing.GetSortOrder();

GetUnrestricted()

Represents a single module license info.

Declaration

Bool GetUnrestricted()

Returns

Type	Description
Bool	If true, then there is no licenseNumber limit on how many of these modules may be assigned.

Examples

NSModuleLicense thing;
Bool unrestricted = thing.GetUnrestricted();

SetAllowedUserType(Integer)

Represents a single module license info.

Declaration

Void SetAllowedUserType(Integer allowedUserType)

Parameters

Type	Name	Description
Integer	allowedUserType	Allowed associate type for user licenses internal(0), external(4). See AssociateType.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
Integer allowedUserType;
thing.SetAllowedUserType(allowedUserType);

SetExtraFlags(Integer)

Represents a single module license info.

Declaration

Void SetExtraFlags(Integer extraFlags)

Parameters

Type	Name	Description
Integer	extraFlags	Unspecified extra flags of license, part of checksum. Value=1 means this a 'user plan'; such licenses cause the admin gui to switch to radiobutton view.

Returns

Type	Description
Void

Examples

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

SetExtraInfo(String)

Represents a single module license info.

Declaration

Void SetExtraInfo(String extraInfo)

Parameters

Type	Name	Description
String	extraInfo	Free field, can be used by the module owner (for example host domain, for Service).

Returns

Type	Description
Void

Remarks

For rows with extraFlags=1 this field contains the list of modules that this plan comprises

Examples

NSModuleLicense thing;
String extraInfo;
thing.SetExtraInfo(extraInfo);

SetIsHidden(Bool)

Represents a single module license info.

Declaration

Void SetIsHidden(Bool isHidden)

Parameters

Type	Name	Description
Bool	isHidden	If true, then this module should not appear in GUI and is not assignable by users.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
Bool isHidden;
thing.SetIsHidden(isHidden);

SetLicenseType(Integer)

Sets the licence type.

Declaration

Void SetLicenseType(Integer licenseType)

Parameters

Type	Name	Description
Integer	licenseType	The entire system, per database, or per associate. See LicenseType.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
Integer licenseType;
thing.SetLicenseType(licenseType);

SetModuleDescription(String)

Represents a single module license info.

Declaration

Void SetModuleDescription(String moduleDescription)

Parameters

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

Returns

Type	Description
Void

Remarks

Additional languages can be added to LocaleText, resource type 25

Examples

NSModuleLicense thing;
String moduleDescription;
thing.SetModuleDescription(moduleDescription);

SetModuleName(String)

Represents a single module license info.

Declaration

Void SetModuleName(String moduleName)

Parameters

Type	Name	Description
String	moduleName	The name of the module, not visible in GUI but used in the code. This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
String moduleName;
thing.SetModuleName(moduleName);

SetModuleTooltip(String)

Represents a single module license info.

Declaration

Void SetModuleTooltip(String moduleTooltip)

Parameters

Type	Name	Description
String	moduleTooltip	Tooltip text, anything you want; shown when the cursor hovers over the line in the GUI. Default language.

Returns

Type	Description
Void

Remarks

Additional languages can be added to LocaleText, resource type 27

Examples

NSModuleLicense thing;
String moduleTooltip;
thing.SetModuleTooltip(moduleTooltip);

SetModuleVersion(String)

Represents a single module license info.

Declaration

Void SetModuleVersion(String moduleVersion)

Parameters

Type	Name	Description
String	moduleVersion	Version string for this module.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
String moduleVersion;
thing.SetModuleVersion(moduleVersion);

SetNumberOfLicenses(Integer)

Represents a single module license info.

Declaration

Void SetNumberOfLicenses(Integer numberOfLicenses)

Parameters

Type	Name	Description
Integer	numberOfLicenses	Number of licenses purchased.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
Integer numberOfLicenses;
thing.SetNumberOfLicenses(numberOfLicenses);

SetOwnerName(String)

Represents a single module license info.

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. 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.

Returns

Type	Description
Void

Examples

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

SetPrerequisiteModuleName(String)

Represents a single module license info.

Declaration

Void SetPrerequisiteModuleName(String prerequisiteModuleName)

Parameters

Type	Name	Description
String	prerequisiteModuleName	If set, specifies a module license needed before this license can be granted.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
String prerequisiteModuleName;
thing.SetPrerequisiteModuleName(prerequisiteModuleName);

SetSignature(String)

Represents a single module license info.

Declaration

Void SetSignature(String signature)

Parameters

Type	Name	Description
String	signature	Signature that verifies that this row is correctly transferred from SuperLicense.

Returns

Type	Description
Void

Examples

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

SetSortOrder(Integer)

Represents a single module license info.

Declaration

Void SetSortOrder(Integer sortOrder)

Parameters

Type	Name	Description
Integer	sortOrder	Ordering value* generated by SuperLicense and transferred here. Must be followed for signatures to be correct.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
Integer sortOrder;
thing.SetSortOrder(sortOrder);

SetUnrestricted(Bool)

Represents a single module license info.

Declaration

Void SetUnrestricted(Bool unrestricted)

Parameters

Type	Name	Description
Bool	unrestricted	If true, then there is no licenseNumber limit on how many of these modules may be assigned.

Returns

Type	Description
Void

Examples

NSModuleLicense thing;
Bool unrestricted;
thing.SetUnrestricted(unrestricted);