Show / Hide Table of Contents

Class ModuleLicenseLink

License assignments carrier

Carrier object for ModuleLicenseLink. Services for the ModuleLicenseLink Carrier is available from the ILicenseAgent.
Inheritance
Object
ModuleLicenseLink
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class ModuleLicenseLink : Carrier

Constructors

ModuleLicenseLink()

Default constructor

Declaration
public ModuleLicenseLink()
See Also
LicenseAgent
ILicenseAgent

Properties

Assigned

Is the module license assigned to a given user?

Declaration
public virtual bool Assigned { get; set; }
Property Value
Type Description
Boolean
See Also
LicenseAgent
ILicenseAgent

CanAssign

Can a specific user assign this module license

Declaration
public virtual bool CanAssign { get; set; }
Property Value
Type Description
Boolean
See Also
LicenseAgent
ILicenseAgent

Description

The description of the module license

Declaration
public virtual string Description { get; set; }
Property Value
Type Description
String
See Also
LicenseAgent
ILicenseAgent

ExtraFlags

License flags. 1 = user plan

Declaration
public virtual int ExtraFlags { get; set; }
Property Value
Type Description
Int32
See Also
LicenseAgent
ILicenseAgent

Free

The number of licenses that are free to be assigned

Declaration
public virtual int Free { get; set; }
Property Value
Type Description
Int32
See Also
LicenseAgent
ILicenseAgent

InUse

The total number of licenses (of a given license module) that are occupied

Declaration
public virtual int InUse { get; set; }
Property Value
Type Description
Int32
See Also
LicenseAgent
ILicenseAgent

IsHidden

Is hidden from UI

Declaration
public virtual bool IsHidden { get; set; }
Property Value
Type Description
Boolean
See Also
LicenseAgent
ILicenseAgent

ModuleLicenseId

The identifier of the module license

Declaration
public virtual int ModuleLicenseId { get; set; }
Property Value
Type Description
Int32
See Also
LicenseAgent
ILicenseAgent

Name

The name of the module license

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
See Also
LicenseAgent
ILicenseAgent

PrerequisiteModuleName

Name of module that must be active for this license to be used.

Declaration
public virtual string PrerequisiteModuleName { get; set; }
Property Value
Type Description
String
See Also
LicenseAgent
ILicenseAgent

SortOrder

Sort order of licenses.

Declaration
public virtual int SortOrder { get; set; }
Property Value
Type Description
Int32
See Also
LicenseAgent
ILicenseAgent

Tooltip

The tooltip to be shown in some gui with details on the module license

Declaration
public virtual string Tooltip { get; set; }
Property Value
Type Description
String
See Also
LicenseAgent
ILicenseAgent

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

Declaration
public virtual int Total { get; set; }
Property Value
Type Description
Int32
See Also
LicenseAgent
ILicenseAgent

Unrestricted

Is this module license restricted or unrestricted

Declaration
public virtual bool Unrestricted { get; set; }
Property Value
Type Description
Boolean
See Also
LicenseAgent
ILicenseAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

See Also
LicenseAgent
ILicenseAgent

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)

Returns
Type Description
String

The carrier contents.

See Also
LicenseAgent
ILicenseAgent

See Also

LicenseAgent
ILicenseAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top