Class NSModuleLicenseLink
Carrier object for ModuleLicenseLink.
Constructors
NSModuleLicenseLink()
Initializes a new instance of the NSModuleLicenseLink class.
Declaration
NSModuleLicenseLinkMethods
GetAssigned()
Declaration
Bool GetAssigned()Examples
NSModuleLicenseLink thing;
Bool assigned = thing.GetAssigned();Returns
| Type | Description |
| Bool | Is the module license assigned to a given user. |
GetCanAssign()
Declaration
Bool GetCanAssign()Examples
NSModuleLicenseLink thing;
Bool canAssign = thing.GetCanAssign();Returns
| Type | Description |
| Bool | Can a specific user assign this module license. |
GetDescription()
Declaration
String GetDescription()Examples
NSModuleLicenseLink thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | The description of the module license. |
GetFree()
Declaration
Integer GetFree()Examples
NSModuleLicenseLink thing;
Integer free = thing.GetFree();Returns
| Type | Description |
| Integer | The number of licenses that are free to be assigned. |
GetInUse()
Declaration
Integer GetInUse()Examples
NSModuleLicenseLink thing;
Integer inUse = thing.GetInUse();Returns
| Type | Description |
| Integer | The total number of licenses (of a given license module) that are occupied. |
GetIsHidden()
Declaration
Bool GetIsHidden()Examples
NSModuleLicenseLink thing;
Bool isHidden = thing.GetIsHidden();Returns
| Type | Description |
| Bool | Is hidden from Ui. |
GetModuleLicenseId()
Declaration
Integer GetModuleLicenseId()Examples
NSModuleLicenseLink thing;
Integer moduleLicenseId = thing.GetModuleLicenseId();Returns
| Type | Description |
| Integer | The identifier of the module license. |
GetName()
Declaration
String GetName()Examples
NSModuleLicenseLink thing;
String name = thing.GetName();Returns
| Type | Description |
| String | The name of the module license. |
GetPrerequisiteModuleName()
Declaration
String GetPrerequisiteModuleName()Examples
NSModuleLicenseLink thing;
String prerequisiteModuleName = thing.GetPrerequisiteModuleName();Returns
| Type | Description |
| String |
GetSortOrder()
Declaration
Integer GetSortOrder()Examples
NSModuleLicenseLink thing;
Integer sortOrder = thing.GetSortOrder();Returns
| Type | Description |
| Integer |
GetTooltip()
Declaration
String GetTooltip()Examples
NSModuleLicenseLink thing;
String tooltip = thing.GetTooltip();Returns
| Type | Description |
| String | The tooltip to be shown in some gui with details on the module license. |
GetTotal()
Declaration
Integer GetTotal()Examples
NSModuleLicenseLink thing;
Integer total = thing.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. |
GetUnrestricted()
Declaration
Bool GetUnrestricted()Examples
NSModuleLicenseLink thing;
Bool unrestricted = thing.GetUnrestricted();Returns
| Type | Description |
| Bool | Is this module license restricted or unrestricted. |
SetAssigned(Bool)
Declaration
Void SetAssigned(Bool assigned)Examples
NSModuleLicenseLink thing;
Bool assigned;
thing.SetAssigned(assigned);Parameters
| Type | Name | Description |
| Bool | assigned | Is the module license assigned to a given user. |
Returns
| Type | Description |
| Void |
SetCanAssign(Bool)
Declaration
Void SetCanAssign(Bool canAssign)Examples
NSModuleLicenseLink thing;
Bool canAssign;
thing.SetCanAssign(canAssign);Parameters
| Type | Name | Description |
| Bool | canAssign | Can a specific user assign this module license. |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSModuleLicenseLink thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | The description of the module license. |
Returns
| Type | Description |
| Void |
SetFree(Integer)
Declaration
Void SetFree(Integer free)Examples
NSModuleLicenseLink thing;
Integer free;
thing.SetFree(free);Parameters
| Type | Name | Description |
| Integer | free | The number of licenses that are free to be assigned. |
Returns
| Type | Description |
| Void |
SetInUse(Integer)
Declaration
Void SetInUse(Integer inUse)Examples
NSModuleLicenseLink thing;
Integer inUse;
thing.SetInUse(inUse);Parameters
| Type | Name | Description |
| Integer | inUse | The total number of licenses (of a given license module) that are occupied. |
Returns
| Type | Description |
| Void |
SetIsHidden(Bool)
Declaration
Void SetIsHidden(Bool isHidden)Examples
NSModuleLicenseLink thing;
Bool isHidden;
thing.SetIsHidden(isHidden);Parameters
| Type | Name | Description |
| Bool | isHidden | Is hidden from Ui. |
Returns
| Type | Description |
| Void |
SetModuleLicenseId(Integer)
Declaration
Void SetModuleLicenseId(Integer moduleLicenseId)Examples
NSModuleLicenseLink thing;
Integer moduleLicenseId;
thing.SetModuleLicenseId(moduleLicenseId);Parameters
| Type | Name | Description |
| Integer | moduleLicenseId | The identifier of the module license. |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSModuleLicenseLink thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | The name of the module license. |
Returns
| Type | Description |
| Void |
SetPrerequisiteModuleName(String)
Declaration
Void SetPrerequisiteModuleName(String prerequisiteModuleName)Examples
NSModuleLicenseLink thing;
String prerequisiteModuleName;
thing.SetPrerequisiteModuleName(prerequisiteModuleName);Parameters
| Type | Name | Description |
| String | prerequisiteModuleName |
Returns
| Type | Description |
| Void |
SetSortOrder(Integer)
Declaration
Void SetSortOrder(Integer sortOrder)Examples
NSModuleLicenseLink thing;
Integer sortOrder;
thing.SetSortOrder(sortOrder);Parameters
| Type | Name | Description |
| Integer | sortOrder |
Returns
| Type | Description |
| Void |
SetTooltip(String)
Declaration
Void SetTooltip(String tooltip)Examples
NSModuleLicenseLink thing;
String tooltip;
thing.SetTooltip(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 |
SetTotal(Integer)
Declaration
Void SetTotal(Integer total)Examples
NSModuleLicenseLink thing;
Integer total;
thing.SetTotal(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 |