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 voidLoadOffPeakSettingsL(CMsvOffPeakTimes &, CRepository &)
IMPORT_C voidLoadScheduleSettingsL(CMsvScheduleSettings &, CRepository &)
IMPORT_C voidLoadSendErrorSettingsL(CMsvSendErrorActions &, CRepository &)
IMPORT_C voidLoadSysAgentSettingsL(CMsvSysAgentActions &, CRepository &)
IMPORT_C voidSaveOffPeakSettingsL(const CMsvOffPeakTimes &, CRepository &)
IMPORT_C voidSaveScheduleSettingsL(const CMsvScheduleSettings &, CRepository &)
IMPORT_C voidSaveSendErrorSettingsL(const CMsvSendErrorActions &, CRepository &)
IMPORT_C voidSaveSysAgentSettingsL(const CMsvSysAgentActions &, CRepository &)
Private Member Functions
voidLoadSendErrorActionL(TUint32, TMsvSendErrorAction &, CRepository &)
voidSaveSendErrorActionL(TUint32, const TMsvSendErrorAction &, CRepository &)
Public Member Enumerations
enumTMsvScheduleSendSettingTypes { EScheduleSettings = 0x00010000, EOffPeakTimeSettings = 0x00020000, ESendErrorActionSettings = 0x00030000, ESystemAgentActionSettings = 0x00040000 }
Private Member Enumerations
enumTMsvOffPeakSettingsCenRepId {
EOffPeakTimesVersionId = 0x00020000, EOffPeakTimesCountId = 0x00020001, EOffPeakTimes = 0x00021000, EOffPeakVersion = 0x00000000, EOffPeakDay = 0x00000001, EOffPeakHour = 0x00000002, EOffPeakMinute = 0x00000003, EOffPeakValidityPeriod = 0x00000004
}
enumTMsvScheduleSettingsCenRepId {
EScheduleVersionId = 0x00010000, ESchedulePriorityId = 0x00010001, EScheduleValidityPeriodId = 0x00010002, EScheduleIntervalTypeId = 0x00010003, EScheduleLatencyId = 0x00010004, EScheduleLongIntervalId = 0x00010005, EScheduleShortIntervalId = 0x00010006, EScheduleVariableIntervalsCountId = 0x00010007, ESchedulePendingConditionsTimeoutId = 0x00010008, EScheduleVariableIntervals = 0x00011000
}
enumTMsvSendErrorActionsCenRepId {
ESendErrorActionsVersionId = 0x00030000, ESendErrorActionsCountId = 0x00030001, ESendErrorDefaultAction = 0x00031000, ESendErrorActions = 0x00032000, ESendErrorVersion = 0x00000000, ESendErrorError = 0x00000001, ESendErrorMaxRetries = 0x00000002, ESendErrorRetries = 0x00000003, ESendErrorAction = 0x00000004, ESendErrorRetrySpacing = 0x00000005
}
enumTMsvSysAgentActionsCenRepId {
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 voidLoadOffPeakSettingsL(CMsvOffPeakTimes &aOffPeakTimes,
CRepository &aRepository
)[static]

Loads Off Peak Times from CenRep.

Parameters

CMsvOffPeakTimes & aOffPeakTimesOff Peak Times
CRepository & aRepositoryRepository to Load settings from.

LoadScheduleSettingsL(CMsvScheduleSettings &, CRepository &)

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

Loads Schedule Settings from CenRep.

Parameters

CMsvScheduleSettings & aScheduleSettingsSchedule settings
CRepository & aRepositoryRepository to Load settings from.

LoadSendErrorActionL(TUint32, TMsvSendErrorAction &, CRepository &)

voidLoadSendErrorActionL(TUint32aErrorActionId,
TMsvSendErrorAction &aErrorAction,
CRepository &aRepository
)[private, static]

Loads a Send Error Action from CenRep.

Parameters

TUint32 aErrorActionIdCenRep Id
TMsvSendErrorAction & aErrorActionSend Error Action
CRepository & aRepositoryRepository to Load settings from.

LoadSendErrorSettingsL(CMsvSendErrorActions &, CRepository &)

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

Loads Send Error Actions from CenRep.

Parameters

CMsvSendErrorActions & aErrorActionsSend Error Actions
CRepository & aRepositoryRepository to Load settings from.

LoadSysAgentSettingsL(CMsvSysAgentActions &, CRepository &)

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

Loads System Agent Actions from CenRep.

Parameters

CMsvSysAgentActions & aSysAgentActionsSystem Agent Actions
CRepository & aRepositoryRepository to Load settings from.

SaveOffPeakSettingsL(const CMsvOffPeakTimes &, CRepository &)

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

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

Parameters

const CMsvOffPeakTimes & aOffPeakTimesOff Peak Times
CRepository & aRepositoryRepository to save settings to.

SaveScheduleSettingsL(const CMsvScheduleSettings &, CRepository &)

IMPORT_C voidSaveScheduleSettingsL(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 & aScheduleSettingsSchedule settings
CRepository & aRepositoryRepository to save settings to.

SaveSendErrorActionL(TUint32, const TMsvSendErrorAction &, CRepository &)

voidSaveSendErrorActionL(TUint32aErrorActionId,
const TMsvSendErrorAction &aErrorAction,
CRepository &aRepository
)[private, static]

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

Parameters

TUint32 aErrorActionIdCenRep Id
const TMsvSendErrorAction & aErrorActionSend Error Action
CRepository & aRepositoryRepository to save settings to.

SaveSendErrorSettingsL(const CMsvSendErrorActions &, CRepository &)

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

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

Parameters

const CMsvSendErrorActions & aErrorActionsSend Error Actions
CRepository & aRepositoryRepository to save settings to.

SaveSysAgentSettingsL(const CMsvSysAgentActions &, CRepository &)

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

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

Parameters

const CMsvSysAgentActions & aSysAgentActionsSystem Agent Actions
CRepository & aRepositoryRepository 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