Class NSSystemEventEntity

Entity for system events.

Syntax

Constructors

NSSystemEventEntity()

Initializes a new instance of the NSSystemEventEntity class.

Introduced or updated in version: 7.5

Declaration

NSSystemEventEntity

Methods

GetActivatedBy()

Introduced or updated in version: 7.5

Declaration

NSAssociate GetActivatedBy()

Returns

Type	Description
NSAssociate	The associate that first created the SystemEvent.

Examples

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

GetEta()

Introduced or updated in version: 7.5

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

Introduced or updated in version: 7.5

Declaration

String GetEventkey()

Returns

Type	Description
String	Event key, predefined in code.

Examples

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

GetEventmess()

Introduced or updated in version: 7.5

Declaration

String GetEventmess()

Returns

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

Examples

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

GetExtraInfo()

Introduced or updated in version: 7.5

Declaration

Integer GetExtraInfo()

Returns

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

Examples

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

GetOwner()

Introduced or updated in version: 7.5

Declaration

Integer GetOwner()

Returns

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

Examples

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

GetRegistered()

Introduced or updated in version: 7.5

Declaration

DateTime GetRegistered()

Returns

Type	Description
DateTime	Registered when.

Examples

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

GetScope()

Introduced or updated in version: 7.5

Declaration

Integer GetScope()

Returns

Type	Description
Integer	See SystemEventScope

Examples

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

GetSystemEventId()

Introduced or updated in version: 7.5

Declaration

Integer GetSystemEventId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetUpdatedCount()

Introduced or updated in version: 7.5

Declaration

Integer GetUpdatedCount()

Returns

Type	Description
Integer	Number of updates made to this record.

Examples

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

SetActivatedBy(NSAssociate)

Introduced or updated in version: 7.5

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)

Introduced or updated in version: 7.5

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

Introduced or updated in version: 7.5

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)

Introduced or updated in version: 7.5

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)

Introduced or updated in version: 7.5

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)

Introduced or updated in version: 7.5

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)

Introduced or updated in version: 7.5

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)

Introduced or updated in version: 7.5

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)

Introduced or updated in version: 7.5

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)

Introduced or updated in version: 7.5

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