Class NSArea

Carrier object for Area.

Syntax

Constructors

NSArea()

Initializes a new instance of the NSArea class.

Declaration

NSArea

Methods

GetAreaId()

Carrier object for Area.

Declaration

Integer GetAreaId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetFreetextEnabeled()

Carrier object for Area.

Declaration

Bool GetFreetextEnabeled()

Returns

Type	Description
Bool

Examples

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

GetMaxDataAge()

Carrier object for Area.

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()

Carrier object for Area.

Declaration

String GetName()

Returns

Type	Description
String	Area name.

Examples

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

GetNumberOfLogins()

Carrier object for Area.

Declaration

Integer GetNumberOfLogins()

Returns

Type	Description
Integer

Examples

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

GetNumberOfUsers()

Carrier object for Area.

Declaration

Integer GetNumberOfUsers()

Returns

Type	Description
Integer

Examples

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

SetAreaId(Integer)

Carrier object for Area.

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)

Carrier object for Area.

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)

Carrier object for Area.

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)

Carrier object for Area.

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)

Carrier object for Area.

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)

Carrier object for Area.

Declaration

Void SetNumberOfUsers(Integer numberOfUsers)

Parameters

Type	Name	Description
Integer	numberOfUsers

Returns

Type	Description
Void

Examples

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