Class NSArea

Carrier object for Area.

Syntax

Constructors

NSArea()

Initializes a new instance of the NSArea class.

Introduced or updated in version: 7

Declaration

NSArea

Methods

GetAreaId()

Introduced or updated in version: 7

Declaration

Integer GetAreaId()

Returns

Type	Description
Integer	Primary key.

Examples

NSArea thing;
Integer areaId = thing.GetAreaId();

GetFreetextEnabeled()

Introduced or updated in version: 7

Declaration

Bool GetFreetextEnabeled()

Returns

Type	Description
Bool

Examples

NSArea thing;
Bool freetextEnabeled = thing.GetFreetextEnabeled();

GetMaxDataAge()

Introduced or updated in version: 7

Declaration

Integer GetMaxDataAge()

Returns

Type	Description
Integer	Max age of data when generating databases based on this area.

Examples

NSArea thing;
Integer maxDataAge = thing.GetMaxDataAge();

GetName()

Introduced or updated in version: 7

Declaration

String GetName()

Returns

Type	Description
String	Area name.

Examples

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

GetNumberOfLogins()

Introduced or updated in version: 7

Declaration

Integer GetNumberOfLogins()

Returns

Type	Description
Integer

Examples

NSArea thing;
Integer numberOfLogins = thing.GetNumberOfLogins();

GetNumberOfUsers()

Introduced or updated in version: 7

Declaration

Integer GetNumberOfUsers()

Returns

Type	Description
Integer

Examples

NSArea thing;
Integer numberOfUsers = thing.GetNumberOfUsers();

SetAreaId(Integer)

Introduced or updated in version: 7

Declaration

Void SetAreaId(Integer areaId)

Parameters

Type	Name	Description
Integer	areaId	Primary key.

Returns

Type	Description
Void

Examples

NSArea thing;
Integer areaId;
thing.SetAreaId(areaId);

SetFreetextEnabeled(Bool)

Introduced or updated in version: 7

Declaration

Void SetFreetextEnabeled(Bool freetextEnabeled)

Parameters

Type	Name	Description
Bool	freetextEnabeled

Returns

Type	Description
Void

Examples

NSArea thing;
Bool freetextEnabeled;
thing.SetFreetextEnabeled(freetextEnabeled);

SetMaxDataAge(Integer)

Introduced or updated in version: 7

Declaration

Void SetMaxDataAge(Integer maxDataAge)

Parameters

Type	Name	Description
Integer	maxDataAge	Max age of data when generating databases based on this area.

Returns

Type	Description
Void

Examples

NSArea thing;
Integer maxDataAge;
thing.SetMaxDataAge(maxDataAge);

SetName(String)

Introduced or updated in version: 7

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Area name.

Returns

Type	Description
Void

Examples

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

SetNumberOfLogins(Integer)

Introduced or updated in version: 7

Declaration

Void SetNumberOfLogins(Integer numberOfLogins)

Parameters

Type	Name	Description
Integer	numberOfLogins

Returns

Type	Description
Void

Examples

NSArea thing;
Integer numberOfLogins;
thing.SetNumberOfLogins(numberOfLogins);

SetNumberOfUsers(Integer)

Introduced or updated in version: 7

Declaration

Void SetNumberOfUsers(Integer numberOfUsers)

Parameters

Type	Name	Description
Integer	numberOfUsers

Returns

Type	Description
Void

Examples

NSArea thing;
Integer numberOfUsers;
thing.SetNumberOfUsers(numberOfUsers);