ReportDefinition (schemas 2.3.0 API)

java.lang.Object
- com.aeris.service.report.model.v1.api.ReportDefinition

All Implemented Interfaces:: Serializable, org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode, org.jvnet.jaxb2_commons.lang.ToString

public class ReportDefinition
extends Object
implements Serializable, org.jvnet.jaxb2_commons.lang.Equals, org.jvnet.jaxb2_commons.lang.HashCode, org.jvnet.jaxb2_commons.lang.ToString

This is base element for all type of reports [ONLINE and SCHEDULE]. Few elements explained below:

"reportType": This identifies which report user wants to generate. The report type enumeration includes:

[DEVICE_DETAIL,TRAFFIC_DETAIL,TRAFFIC_COST_SUMMARY,DEVICE_DAILY_TRAFFIC_USAGE,DEVICE_STATUS_ACTIVITY ,DEVICE_TRAFFIC_USAGE,DEVICE_SUMMARY,TRAFFIC_SUMMARY_TREND,COST_SUMMARY_TREND,DEVICE_SUMMARY_TREND]
"groupBy": This works as a normal group by clause. The generated report is grouped on user provided value (column name).

"onBehalfOf": This is used when Master Account is trying to generate a report for a child account (sub-account). Child account ID should be provided.

"product": It specifies product for which user wants to generate report. ANY value can be provided if user wishes not to specify any specific product.

Product enumeration includes: [CDMA, CDMACC, GLOBALSIM, COVERAGESIM, AERCLOUD, ANY]
"isReportPreview": This should be true for ONLINE and false for SCHEDULE reports.

"reportOnHierarchy": if true will return report for all the accounts in the hierarchy.

"allDevices": if true will return report for all devices ignoring any device filters.

"visibleToSubAccount": if true will return report should be visible to sub-account else false.

"reportGroup": This is obsolete and instead filters with report_group column should be used. This will be removed soon.

"columns": Future purpose.

Java class for ReportDefinition complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="ReportDefinition">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="reportName" type="{http://service.aeris.com/reports/v1/basetype}ReportName"/>
         <element name="reportType" type="{http://service.aeris.com/reports/v1/basetype}ReportType"/>
         <element name="product" type="{http://service.aeris.com/reports/v1/basetype}Product"/>
         <element name="productId" type="{http://service.aeris.com/reports/v1/basetype}ProductID" minOccurs="0"/>
         <element name="email" type="{http://service.aeris.com/reports/v1/basetype}Email" minOccurs="0"/>
         <element name="createdBy" type="{http://service.aeris.com/reports/v1/basetype}CreatedBy" minOccurs="0"/>
         <element name="duration" type="{http://service.aeris.com/reports/v1/compositetype}ReportDuration" minOccurs="0"/>
         <element name="filters" type="{http://service.aeris.com/reports/v1/compositetype}Filter" maxOccurs="1000" minOccurs="0"/>
         <element name="groupBy" type="{http://service.aeris.com/reports/v1/basetype}ColumnName" minOccurs="0"/>
         <element name="sortBy" type="{http://service.aeris.com/reports/v1/compositetype}SortBy" minOccurs="0"/>
         <element name="reportGroup" type="{http://service.aeris.com/reports/v1/basetype}ReportGroup" minOccurs="0"/>
         <element name="reportOnHierarchy" type="{http://service.aeris.com/reports/v1/basetype}ReportOnHierarchy" minOccurs="0"/>
         <element name="allDevices" type="{http://service.aeris.com/reports/v1/basetype}AllDevices" minOccurs="0"/>
         <element name="onBehalfOf" type="{http://service.aeris.com/reports/v1/basetype}AccountId" minOccurs="0"/>
         <element name="visibleToSubAccount" type="{http://service.aeris.com/reports/v1/basetype}VisibleToSubAccount" minOccurs="0"/>
         <element name="isReportPreview" type="{http://service.aeris.com/reports/v1/basetype}IsReportPreview" minOccurs="0"/>
         <element name="outputRecordCount" type="{http://service.aeris.com/reports/v1/basetype}OutputRecordCount" minOccurs="0"/>
         <element name="schedule" type="{http://service.aeris.com/reports/v1/compositetype}ReportSchedule" minOccurs="0"/>
         <element name="columns" type="{http://service.aeris.com/reports/v1/basetype}ColumnName" maxOccurs="1000" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`allDevices`
`protected List<ColumnName>`	`columns`
`protected String`	`createdBy`
`protected ReportDuration`	`duration`
`protected String`	`email`
`protected List<Filter>`	`filters`
`protected ColumnName`	`groupBy`
`protected Boolean`	`isReportPreview`
`protected Long`	`onBehalfOf`
`protected Integer`	`outputRecordCount`
`protected Product`	`product`
`protected BigInteger`	`productId`
`protected Long`	`reportGroup`
`protected String`	`reportName`
`protected Boolean`	`reportOnHierarchy`
`protected ReportType`	`reportType`
`protected ReportSchedule`	`schedule`
`protected SortBy`	`sortBy`
`protected Boolean`	`visibleToSubAccount`

Constructor Summary

Constructors
Constructor and Description

ReportDefinition()

Constructors
Constructor and Description
`ReportDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringBuilder`	`append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)`
`StringBuilder`	`appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)`
`boolean`	`equals(Object object)`
`boolean`	`equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)`
`List<ColumnName>`	`getColumns()` Gets the value of the columns property.
`String`	`getCreatedBy()` Gets the value of the createdBy property.
`ReportDuration`	`getDuration()` Gets the value of the duration property.
`String`	`getEmail()` Gets the value of the email property.
`List<Filter>`	`getFilters()` Gets the value of the filters property.
`ColumnName`	`getGroupBy()` Gets the value of the groupBy property.
`Long`	`getOnBehalfOf()` Gets the value of the onBehalfOf property.
`Integer`	`getOutputRecordCount()` Gets the value of the outputRecordCount property.
`Product`	`getProduct()` Gets the value of the product property.
`BigInteger`	`getProductId()` Gets the value of the productId property.
`Long`	`getReportGroup()` Gets the value of the reportGroup property.
`String`	`getReportName()` Gets the value of the reportName property.
`ReportType`	`getReportType()` Gets the value of the reportType property.
`ReportSchedule`	`getSchedule()` Gets the value of the schedule property.
`SortBy`	`getSortBy()` Gets the value of the sortBy property.
`int`	`hashCode()`
`int`	`hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy)`
`Boolean`	`isAllDevices()` Gets the value of the allDevices property.
`Boolean`	`isIsReportPreview()` Gets the value of the isReportPreview property.
`Boolean`	`isReportOnHierarchy()` Gets the value of the reportOnHierarchy property.
`Boolean`	`isVisibleToSubAccount()` Gets the value of the visibleToSubAccount property.
`void`	`setAllDevices(Boolean value)` Sets the value of the allDevices property.
`void`	`setCreatedBy(String value)` Sets the value of the createdBy property.
`void`	`setDuration(ReportDuration value)` Sets the value of the duration property.
`void`	`setEmail(String value)` Sets the value of the email property.
`void`	`setGroupBy(ColumnName value)` Sets the value of the groupBy property.
`void`	`setIsReportPreview(Boolean value)` Sets the value of the isReportPreview property.
`void`	`setOnBehalfOf(Long value)` Sets the value of the onBehalfOf property.
`void`	`setOutputRecordCount(Integer value)` Sets the value of the outputRecordCount property.
`void`	`setProduct(Product value)` Sets the value of the product property.
`void`	`setProductId(BigInteger value)` Sets the value of the productId property.
`void`	`setReportGroup(Long value)` Sets the value of the reportGroup property.
`void`	`setReportName(String value)` Sets the value of the reportName property.
`void`	`setReportOnHierarchy(Boolean value)` Sets the value of the reportOnHierarchy property.
`void`	`setReportType(ReportType value)` Sets the value of the reportType property.
`void`	`setSchedule(ReportSchedule value)` Sets the value of the schedule property.
`void`	`setSortBy(SortBy value)` Sets the value of the sortBy property.
`void`	`setVisibleToSubAccount(Boolean value)` Sets the value of the visibleToSubAccount property.
`String`	`toString()`

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

- Field Detail
  - reportName
```
@NotNull
protected String reportName
```
  - reportType
```
@NotNull
protected ReportType reportType
```
  - product
```
@NotNull
protected Product product
```
  - productId
```
protected BigInteger productId
```
  - email
```
protected String email
```
  - createdBy
```
protected String createdBy
```
  - duration
```
protected ReportDuration duration
```
  - filters
```
@Size(min=0,
      max=1000)
protected List<Filter> filters
```
  - groupBy
```
protected ColumnName groupBy
```
  - sortBy
```
protected SortBy sortBy
```
  - reportGroup
```
@DecimalMax(value="4294967295")
 @DecimalMin(value="0")
protected Long reportGroup
```
  - reportOnHierarchy
```
protected Boolean reportOnHierarchy
```
  - allDevices
```
protected Boolean allDevices
```
  - onBehalfOf
```
protected Long onBehalfOf
```
  - visibleToSubAccount
```
protected Boolean visibleToSubAccount
```
  - isReportPreview
```
protected Boolean isReportPreview
```
  - outputRecordCount
```
@Digits(integer=3,
        fraction=0)
protected Integer outputRecordCount
```
  - schedule
```
protected ReportSchedule schedule
```
  - columns
```
@Size(min=0,
      max=1000)
protected List<ColumnName> columns
```
- Constructor Detail
  - ReportDefinition
```
public ReportDefinition()
```
- Method Detail
  - getReportName
```
public String getReportName()
```
    Gets the value of the reportName property.
    
    Returns:
    
    possible object is String
  - setReportName
```
public void setReportName(String value)
```
    Sets the value of the reportName property.
    
    Parameters:
    
    value - allowed object is String
  - getReportType
```
public ReportType getReportType()
```
    Gets the value of the reportType property.
    
    Returns:
    
    possible object is ReportType
  - setReportType
```
public void setReportType(ReportType value)
```
    Sets the value of the reportType property.
    
    Parameters:
    
    value - allowed object is ReportType
  - getProduct
```
public Product getProduct()
```
    Gets the value of the product property.
    
    Returns:
    
    possible object is Product
  - setProduct
```
public void setProduct(Product value)
```
    Sets the value of the product property.
    
    Parameters:
    
    value - allowed object is Product
  - getProductId
```
public BigInteger getProductId()
```
    Gets the value of the productId property.
    
    Returns:
    
    possible object is BigInteger
  - setProductId
```
public void setProductId(BigInteger value)
```
    Sets the value of the productId property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getEmail
```
public String getEmail()
```
    Gets the value of the email property.
    
    Returns:
    
    possible object is String
  - setEmail
```
public void setEmail(String value)
```
    Sets the value of the email property.
    
    Parameters:
    
    value - allowed object is String
  - getCreatedBy
```
public String getCreatedBy()
```
    Gets the value of the createdBy property.
    
    Returns:
    
    possible object is String
  - setCreatedBy
```
public void setCreatedBy(String value)
```
    Sets the value of the createdBy property.
    
    Parameters:
    
    value - allowed object is String
  - getDuration
```
public ReportDuration getDuration()
```
    Gets the value of the duration property.
    
    Returns:
    
    possible object is ReportDuration
  - setDuration
```
public void setDuration(ReportDuration value)
```
    Sets the value of the duration property.
    
    Parameters:
    
    value - allowed object is ReportDuration
  - getFilters
```
public List<Filter> getFilters()
```
    Gets the value of the filters property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the filters property.
    For example, to add a new item, do as follows:
```
    getFilters().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Filter
  - getGroupBy
```
public ColumnName getGroupBy()
```
    Gets the value of the groupBy property.
    
    Returns:
    
    possible object is ColumnName
  - setGroupBy
```
public void setGroupBy(ColumnName value)
```
    Sets the value of the groupBy property.
    
    Parameters:
    
    value - allowed object is ColumnName
  - getSortBy
```
public SortBy getSortBy()
```
    Gets the value of the sortBy property.
    
    Returns:
    
    possible object is SortBy
  - setSortBy
```
public void setSortBy(SortBy value)
```
    Sets the value of the sortBy property.
    
    Parameters:
    
    value - allowed object is SortBy
  - getReportGroup
```
public Long getReportGroup()
```
    Gets the value of the reportGroup property.
    
    Returns:
    
    possible object is Long
  - setReportGroup
```
public void setReportGroup(Long value)
```
    Sets the value of the reportGroup property.
    
    Parameters:
    
    value - allowed object is Long
  - isReportOnHierarchy
```
public Boolean isReportOnHierarchy()
```
    Gets the value of the reportOnHierarchy property.
    
    Returns:
    
    possible object is String
  - setReportOnHierarchy
```
public void setReportOnHierarchy(Boolean value)
```
    Sets the value of the reportOnHierarchy property.
    
    Parameters:
    
    value - allowed object is String
  - isAllDevices
```
public Boolean isAllDevices()
```
    Gets the value of the allDevices property.
    
    Returns:
    
    possible object is String
  - setAllDevices
```
public void setAllDevices(Boolean value)
```
    Sets the value of the allDevices property.
    
    Parameters:
    
    value - allowed object is String
  - getOnBehalfOf
```
public Long getOnBehalfOf()
```
    Gets the value of the onBehalfOf property.
    
    Returns:
    
    possible object is Long
  - setOnBehalfOf
```
public void setOnBehalfOf(Long value)
```
    Sets the value of the onBehalfOf property.
    
    Parameters:
    
    value - allowed object is Long
  - isVisibleToSubAccount
```
public Boolean isVisibleToSubAccount()
```
    Gets the value of the visibleToSubAccount property.
    
    Returns:
    
    possible object is String
  - setVisibleToSubAccount
```
public void setVisibleToSubAccount(Boolean value)
```
    Sets the value of the visibleToSubAccount property.
    
    Parameters:
    
    value - allowed object is String
  - isIsReportPreview
```
public Boolean isIsReportPreview()
```
    Gets the value of the isReportPreview property.
    
    Returns:
    
    possible object is String
  - setIsReportPreview
```
public void setIsReportPreview(Boolean value)
```
    Sets the value of the isReportPreview property.
    
    Parameters:
    
    value - allowed object is String
  - getOutputRecordCount
```
public Integer getOutputRecordCount()
```
    Gets the value of the outputRecordCount property.
    
    Returns:
    
    possible object is Integer
  - setOutputRecordCount
```
public void setOutputRecordCount(Integer value)
```
    Sets the value of the outputRecordCount property.
    
    Parameters:
    
    value - allowed object is Integer
  - getSchedule
```
public ReportSchedule getSchedule()
```
    Gets the value of the schedule property.
    
    Returns:
    
    possible object is ReportSchedule
  - setSchedule
```
public void setSchedule(ReportSchedule value)
```
    Sets the value of the schedule property.
    
    Parameters:
    
    value - allowed object is ReportSchedule
  - getColumns
```
public List<ColumnName> getColumns()
```
    Gets the value of the columns property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the columns property.
    For example, to add a new item, do as follows:
```
    getColumns().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ColumnName
  - equals
```
public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
                      org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
                      Object object,
                      org.jvnet.jaxb2_commons.lang.EqualsStrategy strategy)
```
    Specified by:
    
    equals in interface org.jvnet.jaxb2_commons.lang.Equals
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - append
```
public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                            StringBuilder buffer,
                            org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
```
    Specified by:
    
    append in interface org.jvnet.jaxb2_commons.lang.ToString
  - appendFields
```
public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                                  StringBuilder buffer,
                                  org.jvnet.jaxb2_commons.lang.ToStringStrategy strategy)
```
    Specified by:
    
    appendFields in interface org.jvnet.jaxb2_commons.lang.ToString
  - hashCode
```
public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                    org.jvnet.jaxb2_commons.lang.HashCodeStrategy strategy)
```
    Specified by:
    
    hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ReportDefinition

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

reportName

reportType

product

productId

email

createdBy

duration

filters

groupBy

sortBy

reportGroup

reportOnHierarchy

allDevices

onBehalfOf

visibleToSubAccount

isReportPreview

outputRecordCount

schedule

columns

Constructor Detail

ReportDefinition

Method Detail

getReportName

setReportName

getReportType

setReportType

getProduct

setProduct

getProductId

setProductId

getEmail

setEmail

getCreatedBy

setCreatedBy

getDuration

setDuration

getFilters

getGroupBy

setGroupBy

getSortBy

setSortBy

getReportGroup

setReportGroup

isReportOnHierarchy

setReportOnHierarchy

isAllDevices

setAllDevices

getOnBehalfOf

setOnBehalfOf

isVisibleToSubAccount

setVisibleToSubAccount

isIsReportPreview

setIsReportPreview

getOutputRecordCount

setOutputRecordCount

getSchedule

setSchedule

getColumns

equals

equals

toString

append

appendFields

hashCode

hashCode