Class NSModuleLicenseLink

Carrier object for ModuleLicenseLink.

Syntax

Constructors

NSModuleLicenseLink()

Initializes a new instance of the NSModuleLicenseLink class.

Declaration

NSModuleLicenseLink

Methods

GetAssigned()

Carrier object for ModuleLicenseLink.

Declaration

Bool GetAssigned()

Returns

Type	Description
Bool	Is the module license assigned to a given user.

Examples

NSModuleLicenseLink thing;
Bool assigned = thing.GetAssigned();

GetCanAssign()

Carrier object for ModuleLicenseLink.

Declaration

Bool GetCanAssign()

Returns

Type	Description
Bool	Can a specific user assign this module license.

Examples

NSModuleLicenseLink thing;
Bool canAssign = thing.GetCanAssign();

GetDescription()

Carrier object for ModuleLicenseLink.

Declaration

String GetDescription()

Returns

Type	Description
String	The description of the module license.

Examples

NSModuleLicenseLink thing;
String description = thing.GetDescription();

GetFree()

Carrier object for ModuleLicenseLink.

Declaration

Integer GetFree()

Returns

Type	Description
Integer	The number of licenses that are free to be assigned.

Examples

NSModuleLicenseLink thing;
Integer free = thing.GetFree();

GetInUse()

Carrier object for ModuleLicenseLink.

Declaration

Integer GetInUse()

Returns

Type	Description
Integer	The total number of licenses (of a given license module) that are occupied.

Examples

NSModuleLicenseLink thing;
Integer inUse = thing.GetInUse();

GetIsHidden()

Carrier object for ModuleLicenseLink.

Declaration

Bool GetIsHidden()

Returns

Type	Description
Bool	Is hidden from Ui.

Examples

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

GetModuleLicenseId()

Carrier object for ModuleLicenseLink.

Declaration

Integer GetModuleLicenseId()

Returns

Type	Description
Integer	The identifier of the module license.

Examples

NSModuleLicenseLink thing;
Integer moduleLicenseId = thing.GetModuleLicenseId();

GetName()

Carrier object for ModuleLicenseLink.

Declaration

String GetName()

Returns

Type	Description
String	The name of the module license.

Examples

NSModuleLicenseLink thing;
String name = thing.GetName();

GetPrerequisiteModuleName()

Carrier object for ModuleLicenseLink.

Declaration

String GetPrerequisiteModuleName()

Returns

Type	Description
String

Examples

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

GetSortOrder()

Carrier object for ModuleLicenseLink.

Declaration

Integer GetSortOrder()

Returns

Type	Description
Integer

Examples

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

GetTooltip()

Carrier object for ModuleLicenseLink.

Declaration

String GetTooltip()

Returns

Type	Description
String	The tooltip to be shown in some gui with details on the module license.

Examples

NSModuleLicenseLink thing;
String tooltip = thing.GetTooltip();

GetTotal()

Carrier object for ModuleLicenseLink.

Declaration

Integer GetTotal()

Returns

Type	Description
Integer	The total number of module licenses. In other words the number of free license added to the number of licenses in use equals the total number of licenses.

Examples

NSModuleLicenseLink thing;
Integer total = thing.GetTotal();

GetUnrestricted()

Carrier object for ModuleLicenseLink.

Declaration

Bool GetUnrestricted()

Returns

Type	Description
Bool	Is this module license restricted or unrestricted.

Examples

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

SetAssigned(Bool)

Carrier object for ModuleLicenseLink.

Declaration

Void SetAssigned(Bool assigned)

Parameters

Type	Name	Description
Bool	assigned	Is the module license assigned to a given user.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
Bool assigned;
thing.SetAssigned(assigned);

SetCanAssign(Bool)

Carrier object for ModuleLicenseLink.

Declaration

Void SetCanAssign(Bool canAssign)

Parameters

Type	Name	Description
Bool	canAssign	Can a specific user assign this module license.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
Bool canAssign;
thing.SetCanAssign(canAssign);

SetDescription(String)

Carrier object for ModuleLicenseLink.

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	The description of the module license.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
String description;
thing.SetDescription(description);

SetFree(Integer)

Carrier object for ModuleLicenseLink.

Declaration

Void SetFree(Integer free)

Parameters

Type	Name	Description
Integer	free	The number of licenses that are free to be assigned.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
Integer free;
thing.SetFree(free);

SetInUse(Integer)

Carrier object for ModuleLicenseLink.

Declaration

Void SetInUse(Integer inUse)

Parameters

Type	Name	Description
Integer	inUse	The total number of licenses (of a given license module) that are occupied.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
Integer inUse;
thing.SetInUse(inUse);

SetIsHidden(Bool)

Carrier object for ModuleLicenseLink.

Declaration

Void SetIsHidden(Bool isHidden)

Parameters

Type	Name	Description
Bool	isHidden	Is hidden from Ui.

Returns

Type	Description
Void

Examples

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

SetModuleLicenseId(Integer)

Carrier object for ModuleLicenseLink.

Declaration

Void SetModuleLicenseId(Integer moduleLicenseId)

Parameters

Type	Name	Description
Integer	moduleLicenseId	The identifier of the module license.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
Integer moduleLicenseId;
thing.SetModuleLicenseId(moduleLicenseId);

SetName(String)

Carrier object for ModuleLicenseLink.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The name of the module license.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
String name;
thing.SetName(name);

SetPrerequisiteModuleName(String)

Carrier object for ModuleLicenseLink.

Declaration

Void SetPrerequisiteModuleName(String prerequisiteModuleName)

Parameters

Type	Name	Description
String	prerequisiteModuleName

Returns

Type	Description
Void

Examples

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

SetSortOrder(Integer)

Carrier object for ModuleLicenseLink.

Declaration

Void SetSortOrder(Integer sortOrder)

Parameters

Type	Name	Description
Integer	sortOrder

Returns

Type	Description
Void

Examples

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

SetTooltip(String)

Carrier object for ModuleLicenseLink.

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	The tooltip to be shown in some gui with details on the module license.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
String tooltip;
thing.SetTooltip(tooltip);

SetTotal(Integer)

Carrier object for ModuleLicenseLink.

Declaration

Void SetTotal(Integer total)

Parameters

Type	Name	Description
Integer	total	The total number of module licenses. In other words the number of free license added to the number of licenses in use equals the total number of licenses.

Returns

Type	Description
Void

Examples

NSModuleLicenseLink thing;
Integer total;
thing.SetTotal(total);

SetUnrestricted(Bool)

Carrier object for ModuleLicenseLink.

Declaration

Void SetUnrestricted(Bool unrestricted)

Parameters

Type	Name	Description
Bool	unrestricted	Is this module license restricted or unrestricted.

Returns

Type	Description
Void

Examples

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