Services CPQ Apex API Developer Reference

ffscpq.RoleRequestHoursService

global with sharing class RoleRequestHoursService

A service that provides functionality related to the calculation of role request hours.

Enums

TimePeriodType

The types of time period that can be used.

Value Description
DAY A day.
WEEK_STARTING_SATURDAY A week starting on Saturday.
WEEK_STARTING_SUNDAY A week starting on Sunday.
WEEK_STARTING_MONDAY A week starting on Monday.

Methods

calculateRoleRequestHours

global static List<ffscpq.RoleRequestHoursService.CalculateRoleRequestHoursResponse> calculateRoleRequestHours(List<ffscpq.RoleRequestHoursService.CalculateRoleRequestHoursRequest> requests)

A method that calculates the hours on role requests within the specified time period types.

Input Parameters

Name Type Description
requests List<ffscpq.RoleRequestHoursService.CalculateRoleRequestHoursRequest> The list of CalculateRoleRequestHoursRequests.

Return Value

This service returns CalculateRoleRequestHoursResponse in a list that parallels the input list.

ffscpq.RoleRequestHoursService.CalculateRoleRequestHoursRequest

global with sharing class CalculateRoleRequestHoursRequest

The request structure for calculating role request hours.

Properties

Name Type Description
RoleRequestId Id The ID of the role request to calculate the hours for.
HoursAggregationTimePeriodType ffscpq.TimePeriodType The type of time period that the hours of the role request will be calculated for. The default value is TimePeriodType.DAY.

Methods

CalculateRoleRequestHoursRequest

global CalculateRoleRequestHoursRequest(Id roleRequestId)

Input Parameters

Name Type Description
roleRequestId Id The ID of the role request to calculate the hours for.

CalculateRoleRequestHoursRequest

global CalculateRoleRequestHoursRequest(Id roleRequestId, ffscpq.TimePeriodType hoursAggregationTimePeriodType)

Input Parameters

Name Type Description
roleRequestId Id The ID of the role request to calculate the hours for.
hoursAggregationTimePeriodType ffscpq.TimePeriodType The type of time period to use when consolidating role request hours.

ffscpq.RoleRequestHoursService.CalculateRoleRequestHoursResponse

global with sharing class CalculateRoleRequestHoursResponse

The result returned for a role request hours calculation.

Properties

Name Type Description
RoleRequestId Id The ID of the role request that the hours have been calculated for.
HoursAggregationTimePeriodType ffscpq.TimePeriodType The type of time period that the hours of the role request have been calculated for.
HoursByDate Map<Date, Decimal> The number of hours in each time period. This is mapped against the start date of the time period.
© Copyright 2009–2023 FinancialForce.com, inc. All rights reserved. Various trademarks held by their respective owners.