TMsvScheduleSettingsUtils Class Reference

class TMsvScheduleSettingsUtils

Schedule Send settings utility class.

Provides functionality to load/save Schedule Send settings in Central Repository.

Public Member Functions
IMPORT_C void LoadOffPeakSettingsL ( CMsvOffPeakTimes &, CRepository &)
IMPORT_C void LoadScheduleSettingsL ( CMsvScheduleSettings &, CRepository &)
IMPORT_C void LoadSendErrorSettingsL ( CMsvSendErrorActions &, CRepository &)
IMPORT_C void LoadSysAgentSettingsL ( CMsvSysAgentActions &, CRepository &)
IMPORT_C void SaveOffPeakSettingsL (const CMsvOffPeakTimes &, CRepository &)
IMPORT_C void SaveScheduleSettingsL (const CMsvScheduleSettings &, CRepository &)
IMPORT_C void SaveSendErrorSettingsL (const CMsvSendErrorActions &, CRepository &)
IMPORT_C void SaveSysAgentSettingsL (const CMsvSysAgentActions &, CRepository &)
Private Member Functions
void LoadSendErrorActionL ( TUint32 , TMsvSendErrorAction &, CRepository &)
void SaveSendErrorActionL ( TUint32 , const TMsvSendErrorAction &, CRepository &)
Public Member Enumerations
enum TMsvScheduleSendSettingTypes { EScheduleSettings  = 0x00010000, EOffPeakTimeSettings  = 0x00020000, ESendErrorActionSettings  = 0x00030000, ESystemAgentActionSettings  = 0x00040000 }
Private Member Enumerations
enum TMsvOffPeakSettingsCenRepId {
EOffPeakTimesVersionId  = 0x00020000, EOffPeakTimesCountId  = 0x00020001, EOffPeakTimes  = 0x00021000, EOffPeakVersion  = 0x00000000, EOffPeakDay  = 0x00000001, EOffPeakHour  = 0x00000002, EOffPeakMinute  = 0x00000003, EOffPeakValidityPeriod  = 0x00000004
}
enum TMsvScheduleSettingsCenRepId {
EScheduleVersionId  = 0x00010000, ESchedulePriorityId  = 0x00010001, EScheduleValidityPeriodId  = 0x00010002, EScheduleIntervalTypeId  = 0x00010003, EScheduleLatencyId  = 0x00010004, EScheduleLongIntervalId  = 0x00010005, EScheduleShortIntervalId  = 0x00010006, EScheduleVariableIntervalsCountId  = 0x00010007, ESchedulePendingConditionsTimeoutId  = 0x00010008, EScheduleVariableIntervals  = 0x00011000
}
enum TMsvSendErrorActionsCenRepId {
ESendErrorActionsVersionId  = 0x00030000, ESendErrorActionsCountId  = 0x00030001, ESendErrorDefaultAction  = 0x00031000, ESendErrorActions  = 0x00032000, ESendErrorVersion  = 0x00000000, ESendErrorError  = 0x00000001, ESendErrorMaxRetries  = 0x00000002, ESendErrorRetries  = 0x00000003, ESendErrorAction  = 0x00000004, ESendErrorRetrySpacing  = 0x00000005
}
enum TMsvSysAgentActionsCenRepId {
ESysAgentActionsVersionId  = 0x00040000, ESysAgentActionsCountId  = 0x00040001, ESysAgentDefaultSendErrorAction  = 0x00041000, ESysAgentActions  = 0x00042000, ESysAgentSendErrorActions  = 0x00043000, ESysAgentVersion  = 0x00000000, ESysAgentVariable  = 0x00000001, ESysAgentState  = 0x00000002, ESysAgentType  = 0x00000003, ESysAgentDefault  = 0x00000004
}

Member Functions Documentation

LoadOffPeakSettingsL(CMsvOffPeakTimes &, CRepository &)

IMPORT_C void LoadOffPeakSettingsL ( CMsvOffPeakTimes & aOffPeakTimes,
CRepository & aRepository
) [static]

Loads Off Peak Times from CenRep.

Parameters

CMsvOffPeakTimes & aOffPeakTimes Off Peak Times
CRepository & aRepository Repository to Load settings from.

LoadScheduleSettingsL(CMsvScheduleSettings &, CRepository &)

IMPORT_C void LoadScheduleSettingsL ( CMsvScheduleSettings & aScheduleSettings,
CRepository & aRepository
) [static]

Loads Schedule Settings from CenRep.

Parameters

CMsvScheduleSettings & aScheduleSettings Schedule settings
CRepository & aRepository Repository to Load settings from.

LoadSendErrorActionL(TUint32, TMsvSendErrorAction &, CRepository &)

void LoadSendErrorActionL ( TUint32 aErrorActionId,
TMsvSendErrorAction & aErrorAction,
CRepository & aRepository
) [private, static]

Loads a Send Error Action from CenRep.

Parameters

TUint32 aErrorActionId CenRep Id
TMsvSendErrorAction & aErrorAction Send Error Action
CRepository & aRepository Repository to Load settings from.

LoadSendErrorSettingsL(CMsvSendErrorActions &, CRepository &)

IMPORT_C void LoadSendErrorSettingsL ( CMsvSendErrorActions & aErrorActions,
CRepository & aRepository
) [static]

Loads Send Error Actions from CenRep.

Parameters

CMsvSendErrorActions & aErrorActions Send Error Actions
CRepository & aRepository Repository to Load settings from.

LoadSysAgentSettingsL(CMsvSysAgentActions &, CRepository &)

IMPORT_C void LoadSysAgentSettingsL ( CMsvSysAgentActions & aSysAgentActions,
CRepository & aRepository
) [static]

Loads System Agent Actions from CenRep.

Parameters

CMsvSysAgentActions & aSysAgentActions System Agent Actions
CRepository & aRepository Repository to Load settings from.

SaveOffPeakSettingsL(const CMsvOffPeakTimes &, CRepository &)

IMPORT_C void SaveOffPeakSettingsL ( const CMsvOffPeakTimes & aOffPeakTimes,
CRepository & aRepository
) [static]

Saves Off Peak Times to CenRep. This function must be used within a CenRep Transaction.

Parameters

const CMsvOffPeakTimes & aOffPeakTimes Off Peak Times
CRepository & aRepository Repository to save settings to.

SaveScheduleSettingsL(const CMsvScheduleSettings &, CRepository &)

IMPORT_C void SaveScheduleSettingsL ( const CMsvScheduleSettings & aScheduleSettings,
CRepository & aRepository
) [static]

Saves Schedule Settings to the Central Repository. This function must be used within a CenRep Transaction.

Parameters

const CMsvScheduleSettings & aScheduleSettings Schedule settings
CRepository & aRepository Repository to save settings to.

SaveSendErrorActionL(TUint32, const TMsvSendErrorAction &, CRepository &)

void SaveSendErrorActionL ( TUint32 aErrorActionId,
const TMsvSendErrorAction & aErrorAction,
CRepository & aRepository
) [private, static]

Saves Send Error Action to CenRep. This function must be used within a CenRep Transaction.

Parameters

TUint32 aErrorActionId CenRep Id
const TMsvSendErrorAction & aErrorAction Send Error Action
CRepository & aRepository Repository to save settings to.

SaveSendErrorSettingsL(const CMsvSendErrorActions &, CRepository &)

IMPORT_C void SaveSendErrorSettingsL ( const CMsvSendErrorActions & aErrorActions,
CRepository & aRepository
) [static]

Saves Send Error Actions to CenRep. This function must be used within a CenRep Transaction.

Parameters

const CMsvSendErrorActions & aErrorActions Send Error Actions
CRepository & aRepository Repository to save settings to.

SaveSysAgentSettingsL(const CMsvSysAgentActions &, CRepository &)

IMPORT_C void SaveSysAgentSettingsL ( const CMsvSysAgentActions & aSysAgentActions,
CRepository & aRepository
) [static]

Saves System Agent Actions to CenRep. This function must be used within a CenRep Transaction.

Parameters

const CMsvSysAgentActions & aSysAgentActions System Agent Actions
CRepository & aRepository Repository to save settings to.

Member Enumerations Documentation

Enum TMsvOffPeakSettingsCenRepId

Enumerators

EOffPeakTimesVersionId = 0x00020000
EOffPeakTimesCountId = 0x00020001
EOffPeakTimes = 0x00021000
EOffPeakVersion = 0x00000000
EOffPeakDay = 0x00000001
EOffPeakHour = 0x00000002
EOffPeakMinute = 0x00000003
EOffPeakValidityPeriod = 0x00000004

Enum TMsvScheduleSendSettingTypes

Schedule Send Setting Types.

CenRep ID 0x10000 to 0x90000 is reserved for Schedule Send Settings.

Enumerators

EScheduleSettings = 0x00010000
EOffPeakTimeSettings = 0x00020000
ESendErrorActionSettings = 0x00030000
ESystemAgentActionSettings = 0x00040000

Enum TMsvScheduleSettingsCenRepId

Enumerators

EScheduleVersionId = 0x00010000
ESchedulePriorityId = 0x00010001
EScheduleValidityPeriodId = 0x00010002
EScheduleIntervalTypeId = 0x00010003
EScheduleLatencyId = 0x00010004
EScheduleLongIntervalId = 0x00010005
EScheduleShortIntervalId = 0x00010006
EScheduleVariableIntervalsCountId = 0x00010007
ESchedulePendingConditionsTimeoutId = 0x00010008
EScheduleVariableIntervals = 0x00011000

Enum TMsvSendErrorActionsCenRepId

Enumerators

ESendErrorActionsVersionId = 0x00030000
ESendErrorActionsCountId = 0x00030001
ESendErrorDefaultAction = 0x00031000
ESendErrorActions = 0x00032000
ESendErrorVersion = 0x00000000
ESendErrorError = 0x00000001
ESendErrorMaxRetries = 0x00000002
ESendErrorRetries = 0x00000003
ESendErrorAction = 0x00000004
ESendErrorRetrySpacing = 0x00000005

Enum TMsvSysAgentActionsCenRepId

Enumerators

ESysAgentActionsVersionId = 0x00040000
ESysAgentActionsCountId = 0x00040001
ESysAgentDefaultSendErrorAction = 0x00041000
ESysAgentActions = 0x00042000
ESysAgentSendErrorActions = 0x00043000
ESysAgentVersion = 0x00000000
ESysAgentVariable = 0x00000001
ESysAgentState = 0x00000002
ESysAgentType = 0x00000003
ESysAgentDefault = 0x00000004