Class NSArea

Carrier object for Area.

Constructors

NSArea()

Initializes a new instance of the NSArea class.

Declaration

NSArea

Methods

GetAreaId()

Declaration

Integer GetAreaId()

Examples

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

Returns

Type	Description
Integer	Primary key.

GetFreetextEnabeled()

Declaration

Bool GetFreetextEnabeled()

Examples

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

Returns

Type	Description
Bool

GetMaxDataAge()

Declaration

Integer GetMaxDataAge()

Examples

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

Returns

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

GetName()

Declaration

String GetName()

Examples

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

Returns

Type	Description
String	Area name.

GetNumberOfLogins()

Declaration

Integer GetNumberOfLogins()

Examples

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

Returns

Type	Description
Integer

GetNumberOfUsers()

Declaration

Integer GetNumberOfUsers()

Examples

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

Returns

Type	Description
Integer

SetAreaId(Integer)

Declaration

Void SetAreaId(Integer areaId)

Examples

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

Parameters

Type	Name	Description
Integer	areaId	Primary key.

Returns

Type	Description
Void

SetFreetextEnabeled(Bool)

Declaration

Void SetFreetextEnabeled(Bool freetextEnabeled)

Examples

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

Parameters

Type	Name	Description
Bool	freetextEnabeled

Returns

Type	Description
Void

SetMaxDataAge(Integer)

Declaration

Void SetMaxDataAge(Integer maxDataAge)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

Type	Name	Description
String	name	Area name.

Returns

Type	Description
Void

SetNumberOfLogins(Integer)

Declaration

Void SetNumberOfLogins(Integer numberOfLogins)

Examples

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

Parameters

Type	Name	Description
Integer	numberOfLogins

Returns

Type	Description
Void

SetNumberOfUsers(Integer)

Declaration

Void SetNumberOfUsers(Integer numberOfUsers)

Examples

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

Parameters

Type	Name	Description
Integer	numberOfUsers

Returns

Type	Description
Void