Class MaintenanceInfoResult

• Defined in File Maintenance.h

Inheritance Relationships

Base Type

• public csp::systems::ResultBase (Class ResultBase)

Class Documentation

class MaintenanceInfoResult : public csp::systems::ResultBase

Data class used to contain information when a Response is received from Maintenance Window Server.

Public Functions

csp::common::Array<MaintenanceInfo> &GetMaintenanceInfoResponses()

Retrieves response data from the Maintenance Window Server.

Returns

csp::common::Array<MaintenanceInfo> : return all maintenance information available in date order

const csp::common::Array<MaintenanceInfo> &GetMaintenanceInfoResponses() const

Retrieves response data from the Maintenance Window Server.

Returns

csp::common::Array<MaintenanceInfo> : return all maintenance information available in date order

bool HasAnyMaintenanceWindows() const

Can be used to determine if any maintenance windows were defined by the services.

Returns

bool : will return true when GetMaintenanceInfoResponses returns a zero-sized array.

const MaintenanceInfo &GetLatestMaintenanceInfo() const

Will return info for the future maintenance window closest to the current time, or default window info if none exist.

Returns

MaintenanceInfo : the closest maintenance window information

const MaintenanceInfo &GetDefaultMaintenanceInfo() const

Represents a default maintenance window object, which is used when the platform finds no future maintenance windows.

Returns

MaintenanceInfo : what the platform considers to be a default maintenance window

inline MaintenanceInfoResult(csp::systems::EResultCode ResCode, uint16_t HttpResCode)