Class NSTimeZoneAgent

TimeZone maintenance.

Examples

NSTimeZoneAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSTimeZoneAgent()

TimeZone maintenance.

Declaration

NSTimeZoneAgent

Examples

NSTimeZoneAgent agent;
agent.callMethod(arg1, arg2);

Methods

CheckNewTimeZoneDataAvailable()

Checks to see if new timezone data is available

Declaration

Bool CheckNewTimeZoneDataAvailable()

Examples

NSTimeZoneAgent agent;
Bool res = agent.CheckNewTimeZoneDataAvailable();

Returns

Type Description
Bool

DeleteTimeZones()

Deletes all time zone data (locations and rules) from the database

Declaration

Void DeleteTimeZones()

Returns

Type Description
Void

GetBaseTimeZoneId()

Gets the base timezone ID.

Declaration

Integer GetBaseTimeZoneId()

Examples

NSTimeZoneAgent agent;
Integer res = agent.GetBaseTimeZoneId();

Returns

Type Description
Integer

GetDefaultTimeZonePreference()

Returns the ID of the default timezone preference with deflevel system wide

Declaration

Integer GetDefaultTimeZonePreference()

Examples

NSTimeZoneAgent agent;
Integer res = agent.GetDefaultTimeZonePreference();

Returns

Type Description
Integer

InitializeTimeZoneData()

Initializes the NSTimeZoneData

Declaration

NSTimeZoneData[] InitializeTimeZoneData()

Returns

Type Description
NSTimeZoneData[]

SetActiveTimeZoneRow(Integer,Bool)

Sets active state of singe row in the TZLocation table

Declaration

Void SetActiveTimeZoneRow(Integer id, Bool active)

Parameters

Type Name Description
Integer id
Bool active

Returns

Type Description
Void

SetActiveTimeZonesByFilter(String,Bool)

Toggles active state of a single row in the TZLocation table

Declaration

Void SetActiveTimeZonesByFilter(String filter, Bool active)

Parameters

Type Name Description
String filter
Bool active

Returns

Type Description
Void

SetBaseTimeZoneId(Integer)

Sets the base timezone ID.

Declaration

Bool SetBaseTimeZoneId(Integer timezoneId)

Examples

NSTimeZoneAgent agent;
Integer timezoneId;
Bool res = agent.SetBaseTimeZoneId(timezoneId);

Parameters

Type Name Description
Integer timezoneId

Returns

Type Description
Bool

TimeOfLastTimeZoneUpdate()

Gets the time time zone data was last updated

Declaration

DateTime TimeOfLastTimeZoneUpdate()

Examples

NSTimeZoneAgent agent;
DateTime res = agent.TimeOfLastTimeZoneUpdate();

Returns

Type Description
DateTime

ToggleActiveTimeZoneRow(Integer)

Toggles active state of a single row in the TZLocation table

Declaration

Void ToggleActiveTimeZoneRow(Integer id)

Parameters

Type Name Description
Integer id

Returns

Type Description
Void

UpdateTimeZoneData()

Retrieves time zone data from the SuperOffice server and update TimeZone data in the database

Declaration

Bool UpdateTimeZoneData()

Examples

NSTimeZoneAgent agent;
Bool res = agent.UpdateTimeZoneData();

Returns

Type Description
Bool