BatchDeliveryReportParams.Builder (SDK for CLX XMS 1.0.2 API)

java.lang.Object
- com.clxcommunications.xms.BatchDeliveryReportParams.Builder

Enclosing class:

BatchDeliveryReportParams
```
public static class BatchDeliveryReportParams.Builder
extends Object
```
A builder of batch delivery report filters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchDeliveryReportParams.Builder`	`addAllCodes(Iterable<Integer> elements)` Adds elements to `codes` set.
`BatchDeliveryReportParams.Builder`	`addAllStatuses(Iterable<? extends DeliveryStatus> elements)` Adds elements to `statuses` set.
`BatchDeliveryReportParams.Builder`	`addCode(int... elements)` Adds elements to `codes` set.
`BatchDeliveryReportParams.Builder`	`addCode(int element)` Adds one element to `codes` set.
`BatchDeliveryReportParams.Builder`	`addStatus(DeliveryStatus... elements)` Adds elements to `statuses` set.
`BatchDeliveryReportParams.Builder`	`addStatus(DeliveryStatus element)` Adds one element to `statuses` set.
`BatchDeliveryReportParams`	`build()` Builds a new `BatchDeliveryReportParams`.
`BatchDeliveryReportParams.Builder`	`codes(Iterable<Integer> elements)` Sets or replaces all elements for `codes` set.
`BatchDeliveryReportParams.Builder`	`fullReport()` Request a full delivery report.
`BatchDeliveryReportParams.Builder`	`reportType(BatchDeliveryReportParams.ReportType reportType)` Initializes the value for the `reportType` attribute.
`BatchDeliveryReportParams.Builder`	`statuses(Iterable<? extends DeliveryStatus> elements)` Sets or replaces all elements for `statuses` set.
`BatchDeliveryReportParams.Builder`	`summaryReport()` Request a summary delivery report.
`BatchDeliveryReportParams.Builder`	`using(BatchDeliveryReportParams instance)` Fill a builder with attribute values from the provided `BatchDeliveryReportParams` instance.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - summaryReport
```
public BatchDeliveryReportParams.Builder summaryReport()
```
    Request a summary delivery report.
    
    Returns:
    
    this builder for use in a chained invocation
    
    See Also:
    
    BatchDeliveryReportParams.ReportType.SUMMARY
  - fullReport
```
public BatchDeliveryReportParams.Builder fullReport()
```
    Request a full delivery report.
    
    Returns:
    
    this builder for use in a chained invocation
    
    See Also:
    
    BatchDeliveryReportParams.ReportType.FULL
  - using
```
public final BatchDeliveryReportParams.Builder using(BatchDeliveryReportParams instance)
```
    Fill a builder with attribute values from the provided BatchDeliveryReportParams instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.
    
    Parameters:
    
    instance - The instance from which to copy values
    
    Returns:
    
    this builder for use in a chained invocation
  - reportType
```
public final BatchDeliveryReportParams.Builder reportType(@Nullable
                                                          BatchDeliveryReportParams.ReportType reportType)
```
    Initializes the value for the reportType attribute.
    
    Parameters:
    
    reportType - The value for reportType (can be null)
    
    Returns:
    
    this builder for use in a chained invocation
  - addStatus
```
public final BatchDeliveryReportParams.Builder addStatus(DeliveryStatus element)
```
    Adds one element to statuses set.
    
    Parameters:
    
    element - A statuses element
    
    Returns:
    
    this builder for use in a chained invocation
  - addStatus
```
public final BatchDeliveryReportParams.Builder addStatus(DeliveryStatus... elements)
```
    Adds elements to statuses set.
    
    Parameters:
    
    elements - An array of statuses elements
    
    Returns:
    
    this builder for use in a chained invocation
  - statuses
```
public final BatchDeliveryReportParams.Builder statuses(Iterable<? extends DeliveryStatus> elements)
```
    Sets or replaces all elements for statuses set.
    
    Parameters:
    
    elements - An iterable of statuses elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllStatuses
```
public final BatchDeliveryReportParams.Builder addAllStatuses(Iterable<? extends DeliveryStatus> elements)
```
    Adds elements to statuses set.
    
    Parameters:
    
    elements - An iterable of statuses elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addCode
```
public final BatchDeliveryReportParams.Builder addCode(int element)
```
    Adds one element to codes set.
    
    Parameters:
    
    element - A codes element
    
    Returns:
    
    this builder for use in a chained invocation
  - addCode
```
public final BatchDeliveryReportParams.Builder addCode(int... elements)
```
    Adds elements to codes set.
    
    Parameters:
    
    elements - An array of codes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - codes
```
public final BatchDeliveryReportParams.Builder codes(Iterable<Integer> elements)
```
    Sets or replaces all elements for codes set.
    
    Parameters:
    
    elements - An iterable of codes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - addAllCodes
```
public final BatchDeliveryReportParams.Builder addAllCodes(Iterable<Integer> elements)
```
    Adds elements to codes set.
    
    Parameters:
    
    elements - An iterable of codes elements
    
    Returns:
    
    this builder for use in a chained invocation
  - build
```
public BatchDeliveryReportParams build()
```
    Builds a new BatchDeliveryReportParams.
    
    Returns:
    
    An immutable instance of BatchDeliveryReportParams
    
    Throws:
    
    IllegalStateException - if any required attributes are missing

Class BatchDeliveryReportParams.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

summaryReport

fullReport

using

reportType

addStatus

addStatus

statuses

addAllStatuses

addCode

addCode

codes

addAllCodes

build