Class NSSystemEventEntity

Entity for system events.

Syntax

Constructors

NSSystemEventEntity()

Initializes a new instance of the NSSystemEventEntity class.

Declaration

NSSystemEventEntity

Methods

GetActivatedBy()

Entity for system events.

Declaration

NSAssociate GetActivatedBy()

Returns

Type	Description
NSAssociate	The associate that first created the SystemEvent.

Examples

NSSystemEventEntity thing;
NSAssociate activatedBy = thing.GetActivatedBy();

GetEta()

Entity for system events.

Declaration

DateTime GetEta()

Returns

Type	Description
DateTime	Estimated Time of Arrival, i.e., when will this event finish?

Examples

NSSystemEventEntity thing;
DateTime eta = thing.GetEta();

GetEventkey()

Entity for system events.

Declaration

String GetEventkey()

Returns

Type	Description
String	Event key, predefined in code.

Examples

NSSystemEventEntity thing;
String eventkey = thing.GetEventkey();

GetEventmess()

Entity for system events.

Declaration

String GetEventmess()

Returns

Type	Description
String	Message to be shown, entered by administrator.

Examples

NSSystemEventEntity thing;
String eventmess = thing.GetEventmess();

GetExtraInfo()

Entity for system events.

Declaration

Integer GetExtraInfo()

Returns

Type	Description
Integer	Extra information (area ID for prototype rebuild, etc).

Examples

NSSystemEventEntity thing;
Integer extraInfo = thing.GetExtraInfo();

GetOwner()

Entity for system events.

Declaration

Integer GetOwner()

Returns

Type	Description
Integer	0, 0, group_id, assoc id (see over).

Examples

NSSystemEventEntity thing;
Integer owner = thing.GetOwner();

GetRegistered()

Entity for system events.

Declaration

DateTime GetRegistered()

Returns

Type	Description
DateTime	Registered when.

Examples

NSSystemEventEntity thing;
DateTime registered = thing.GetRegistered();

GetScope()

Entity for system events.

Declaration

Integer GetScope()

Returns

Type	Description
Integer	See SystemEventScope

Examples

NSSystemEventEntity thing;
Integer scope = thing.GetScope();

GetSystemEventId()

Entity for system events.

Declaration

Integer GetSystemEventId()

Returns

Type	Description
Integer	Primary key.

Examples

NSSystemEventEntity thing;
Integer systemEventId = thing.GetSystemEventId();

GetUpdatedCount()

Entity for system events.

Declaration

Integer GetUpdatedCount()

Returns

Type	Description
Integer	Number of updates made to this record.

Examples

NSSystemEventEntity thing;
Integer updatedCount = thing.GetUpdatedCount();

SetActivatedBy(NSAssociate)

Entity for system events.

Declaration

Void SetActivatedBy(NSAssociate activatedBy)

Parameters

Type	Name	Description
NSAssociate	activatedBy	The associate that first created the SystemEvent.

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
NSAssociate activatedBy;
thing.SetActivatedBy(activatedBy);

SetEta(DateTime)

Entity for system events.

Declaration

Void SetEta(DateTime eta)

Parameters

Type	Name	Description
DateTime	eta	Estimated Time of Arrival, i.e., when will this event finish?

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
DateTime eta;
thing.SetEta(eta);

SetEventkey(String)

Event key, predefined in code

Declaration

Void SetEventkey(String eventkey)

Parameters

Type	Name	Description
String	eventkey	Event key, predefined in code\

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
String eventkey;
thing.SetEventkey(eventkey);

SetEventmess(String)

Entity for system events.

Declaration

Void SetEventmess(String eventmess)

Parameters

Type	Name	Description
String	eventmess	Message to be shown, entered by administrator.

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
String eventmess;
thing.SetEventmess(eventmess);

SetExtraInfo(Integer)

Entity for system events.

Declaration

Void SetExtraInfo(Integer extraInfo)

Parameters

Type	Name	Description
Integer	extraInfo	Extra information (area id for prototype rebuild, etc).

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
Integer extraInfo;
thing.SetExtraInfo(extraInfo);

SetOwner(Integer)

Entity for system events.

Declaration

Void SetOwner(Integer owner)

Parameters

Type	Name	Description
Integer	owner	0, 0, group_id, assoc id (see over).

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
Integer owner;
thing.SetOwner(owner);

SetRegistered(DateTime)

Entity for system events.

Declaration

Void SetRegistered(DateTime registered)

Parameters

Type	Name	Description
DateTime	registered	Registered when.

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
DateTime registered;
thing.SetRegistered(registered);

SetScope(Integer)

Entity for system events.

Declaration

Void SetScope(Integer scope)

Parameters

Type	Name	Description
Integer	scope	See SystemEventScope.

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
Integer scope;
thing.SetScope(scope);

SetSystemEventId(Integer)

Entity for system events.

Declaration

Void SetSystemEventId(Integer systemEventId)

Parameters

Type	Name	Description
Integer	systemEventId	Primary key.

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
Integer systemEventId;
thing.SetSystemEventId(systemEventId);

SetUpdatedCount(Integer)

Entity for system events.

Declaration

Void SetUpdatedCount(Integer updatedCount)

Parameters

Type	Name	Description
Integer	updatedCount	Number of updates made to this record.

Returns

Type	Description
Void

Examples

NSSystemEventEntity thing;
Integer updatedCount;
thing.SetUpdatedCount(updatedCount);