Class NSTimeZoneAgent

TimeZone maintenance.

Syntax

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

Returns

Type	Description
Bool

Examples

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

DeleteTimeZones()

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

Declaration

Void DeleteTimeZones()

Returns

Type	Description
Void

Examples

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

GetBaseTimeZoneId()

Gets the base timezone ID.

Declaration

Integer GetBaseTimeZoneId()

Returns

Type	Description
Integer

Examples

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

GetDefaultTimeZonePreference()

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

Declaration

Integer GetDefaultTimeZonePreference()

Returns

Type	Description
Integer

Examples

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

InitializeTimeZoneData()

Initializes the NSTimeZoneData

Declaration

NSTimeZoneData[] InitializeTimeZoneData()

Returns

Type	Description
NSTimeZoneData[]

Examples

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

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

Examples

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

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

Examples

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

SetBaseTimeZoneId(Integer)

Sets the base timezone ID.

Declaration

Bool SetBaseTimeZoneId(Integer timezoneId)

Parameters

Type	Name	Description
Integer	timezoneId

Returns

Type	Description
Bool

Examples

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

TimeOfLastTimeZoneUpdate()

Gets the time time zone data was last updated

Declaration

DateTime TimeOfLastTimeZoneUpdate()

Returns

Type	Description
DateTime

Examples

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

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

Examples

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

UpdateTimeZoneData()

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

Declaration

Bool UpdateTimeZoneData()

Returns

Type	Description
Bool

Examples

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