Class EnhancedCallLogs.UserEnhancedCallLogsGetListRequest
java.lang.Object
co.ecg.alpaca.toolkit.messaging.request.Request<EnhancedCallLogs.UserEnhancedCallLogsGetListResponse>
co.ecg.alpaca.toolkit.generated.services.EnhancedCallLogs.UserEnhancedCallLogsGetListRequest
- Enclosing class:
EnhancedCallLogs
public static class EnhancedCallLogs.UserEnhancedCallLogsGetListRequest
extends Request<EnhancedCallLogs.UserEnhancedCallLogsGetListResponse>
Request user's call logs. If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned. The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter" "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including placed will be returned. It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control the maximum number of call logs can be returned. The response is either a UserEnhancedCallLogsGetListResponse23 or an ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: callAuthorizationCodeFilter
- Author:
- AlpacaGenerator
-
Nested Class Summary
Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request
Request.Protocol -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected @Valid EnhancedCallLogsAccountAuthorizationCodeFilterprotected @Valid EnhancedCallLogsCallAuthorizationCodeFilterprotected EnhancedCallLogsCallLogsRequestTypeprotected @NotNull @Valid EnhancedCallLogsTimeRangeprotected @Valid EnhancedCallLogsNumberFilterprotected @Valid EnhancedCallLogsRedirectedNumberFilter23protected @Valid ResponsePagingControlprotected EnhancedCallLogsSubscriberType20protected @NotNull @Valid BroadWorksUser -
Constructor Summary
ConstructorsConstructorDescriptionUserEnhancedCallLogsGetListRequest(BroadWorksUser user, EnhancedCallLogsTimeRange dateTimeRange) -
Method Summary
Modifier and TypeMethodDescriptionvoidForms the XML Document for this Request Object.getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.setAccountAuthorizationCodeFilter(EnhancedCallLogsAccountAuthorizationCodeFilter accountAuthorizationCodeFilter) setCallAuthorizationCodeFilter(EnhancedCallLogsCallAuthorizationCodeFilter callAuthorizationCodeFilter) setCallLogType(EnhancedCallLogsCallLogsRequestType callLogType) setDateTimeRange(EnhancedCallLogsTimeRange dateTimeRange) setNumberFilter(EnhancedCallLogsNumberFilter numberFilter) setRedirectedNumberFilter(EnhancedCallLogsRedirectedNumberFilter23 redirectedNumberFilter) setResponsePagingControl(ResponsePagingControl responsePagingControl) setSubscriberType(EnhancedCallLogsSubscriberType20 subscriberType) setUser(BroadWorksUser user) Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request
appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate
-
Field Details
-
user
-
callLogType
-
dateTimeRange
-
numberFilter
-
redirectedNumberFilter
-
accountAuthorizationCodeFilter
@Valid protected @Valid EnhancedCallLogsAccountAuthorizationCodeFilter accountAuthorizationCodeFilter -
callAuthorizationCodeFilter
-
subscriberType
-
responsePagingControl
-
-
Constructor Details
-
UserEnhancedCallLogsGetListRequest
public UserEnhancedCallLogsGetListRequest() -
UserEnhancedCallLogsGetListRequest
public UserEnhancedCallLogsGetListRequest(BroadWorksUser user, EnhancedCallLogsTimeRange dateTimeRange)
-
-
Method Details
-
setUser
-
getBroadWorksUser
-
setCallLogType
public EnhancedCallLogs.UserEnhancedCallLogsGetListRequest setCallLogType(EnhancedCallLogsCallLogsRequestType callLogType) -
getCallLogType
-
setDateTimeRange
public EnhancedCallLogs.UserEnhancedCallLogsGetListRequest setDateTimeRange(EnhancedCallLogsTimeRange dateTimeRange) -
getDateTimeRange
-
setNumberFilter
public EnhancedCallLogs.UserEnhancedCallLogsGetListRequest setNumberFilter(EnhancedCallLogsNumberFilter numberFilter) -
getNumberFilter
-
setRedirectedNumberFilter
public EnhancedCallLogs.UserEnhancedCallLogsGetListRequest setRedirectedNumberFilter(EnhancedCallLogsRedirectedNumberFilter23 redirectedNumberFilter) -
getRedirectedNumberFilter
-
setAccountAuthorizationCodeFilter
public EnhancedCallLogs.UserEnhancedCallLogsGetListRequest setAccountAuthorizationCodeFilter(EnhancedCallLogsAccountAuthorizationCodeFilter accountAuthorizationCodeFilter) -
getAccountAuthorizationCodeFilter
-
setCallAuthorizationCodeFilter
public EnhancedCallLogs.UserEnhancedCallLogsGetListRequest setCallAuthorizationCodeFilter(EnhancedCallLogsCallAuthorizationCodeFilter callAuthorizationCodeFilter) -
getCallAuthorizationCodeFilter
-
setSubscriberType
public EnhancedCallLogs.UserEnhancedCallLogsGetListRequest setSubscriberType(EnhancedCallLogsSubscriberType20 subscriberType) -
getSubscriberType
-
setResponsePagingControl
public EnhancedCallLogs.UserEnhancedCallLogsGetListRequest setResponsePagingControl(ResponsePagingControl responsePagingControl) -
getResponsePagingControl
-
getEmptyObject
public static EnhancedCallLogs.UserEnhancedCallLogsGetListRequest getEmptyObject(BroadWorksServer broadWorksServer) Retrieves this object with minimal setup.- Parameters:
broadWorksServer- The BroadWorksServer
-
formRequest
public void formRequest()Forms the XML Document for this Request Object. Called by the Request upon fire().- Overrides:
formRequestin classRequest<EnhancedCallLogs.UserEnhancedCallLogsGetListResponse>
-