ReportHeader (IPP V3 Java DevKit 3.0.0 API)

java.lang.Object
- com.intuit.ipp.data.ReportHeader

All Implemented Interfaces:: Serializable, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2

public class ReportHeader
extends Object
implements Serializable, org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2

Specifies the Header of a Report, Time report was generated, parameters corresponding to the request

Java class for ReportHeader complex type.

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

 <complexType name="ReportHeader">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="Time" type="{http://www.w3.org/2001/XMLSchema}dateTime" minOccurs="0"/>
         <element name="ReportName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="DateMacro" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="ReportBasis" type="{http://schema.intuit.com/finance/v3}ReportBasisEnum" minOccurs="0"/>
         <element name="StartPeriod" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="EndPeriod" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="SummarizeColumnsBy" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Currency" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Customer" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Vendor" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Employee" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Item" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Class" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Department" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="Option" type="{http://schema.intuit.com/finance/v3}NameValue" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`clazz`
`protected String`	`currency`
`protected String`	`customer`
`protected String`	`dateMacro`
`protected String`	`department`
`protected String`	`employee`
`protected String`	`endPeriod`
`protected String`	`item`
`protected List<NameValue>`	`option`
`protected ReportBasisEnum`	`reportBasis`
`protected String`	`reportName`
`protected String`	`startPeriod`
`protected String`	`summarizeColumnsBy`
`protected Date`	`time`
`protected String`	`vendor`

Constructor Summary

Constructors
Constructor and Description

ReportHeader()

Constructors
Constructor and Description
`ReportHeader()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.EqualsStrategy2 strategy)`
`String`	`getClazz()` Gets the value of the clazz property.
`String`	`getCurrency()` Gets the value of the currency property.
`String`	`getCustomer()` Gets the value of the customer property.
`String`	`getDateMacro()` Gets the value of the dateMacro property.
`String`	`getDepartment()` Gets the value of the department property.
`String`	`getEmployee()` Gets the value of the employee property.
`String`	`getEndPeriod()` Gets the value of the endPeriod property.
`String`	`getItem()` Gets the value of the item property.
`List<NameValue>`	`getOption()` Gets the value of the option property.
`ReportBasisEnum`	`getReportBasis()` Gets the value of the reportBasis property.
`String`	`getReportName()` Gets the value of the reportName property.
`String`	`getStartPeriod()` Gets the value of the startPeriod property.
`String`	`getSummarizeColumnsBy()` Gets the value of the summarizeColumnsBy property.
`Date`	`getTime()` Gets the value of the time property.
`String`	`getVendor()` Gets the value of the vendor property.
`int`	`hashCode()`
`int`	`hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)`
`void`	`setClazz(String value)` Sets the value of the clazz property.
`void`	`setCurrency(String value)` Sets the value of the currency property.
`void`	`setCustomer(String value)` Sets the value of the customer property.
`void`	`setDateMacro(String value)` Sets the value of the dateMacro property.
`void`	`setDepartment(String value)` Sets the value of the department property.
`void`	`setEmployee(String value)` Sets the value of the employee property.
`void`	`setEndPeriod(String value)` Sets the value of the endPeriod property.
`void`	`setItem(String value)` Sets the value of the item property.
`void`	`setOption(List<NameValue> option)` Sets the value of the option property.
`void`	`setReportBasis(ReportBasisEnum value)` Sets the value of the reportBasis property.
`void`	`setReportName(String value)` Sets the value of the reportName property.
`void`	`setStartPeriod(String value)` Sets the value of the startPeriod property.
`void`	`setSummarizeColumnsBy(String value)` Sets the value of the summarizeColumnsBy property.
`void`	`setTime(Date value)` Sets the value of the time property.
`void`	`setVendor(String value)` Sets the value of the vendor property.

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

- Field Detail
  - time
```
protected Date time
```
  - reportName
```
protected String reportName
```
  - dateMacro
```
protected String dateMacro
```
  - reportBasis
```
protected ReportBasisEnum reportBasis
```
  - startPeriod
```
protected String startPeriod
```
  - endPeriod
```
protected String endPeriod
```
  - summarizeColumnsBy
```
protected String summarizeColumnsBy
```
  - currency
```
protected String currency
```
  - customer
```
protected String customer
```
  - vendor
```
protected String vendor
```
  - employee
```
protected String employee
```
  - item
```
protected String item
```
  - clazz
```
protected String clazz
```
  - department
```
protected String department
```
  - option
```
protected List<NameValue> option
```
- Constructor Detail
  - ReportHeader
```
public ReportHeader()
```
- Method Detail
  - getTime
```
public Date getTime()
```
    Gets the value of the time property.
    
    Returns:
    
    possible object is String
  - setTime
```
public void setTime(Date value)
```
    Sets the value of the time property.
    
    Parameters:
    
    value - allowed object is String
  - 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
  - getDateMacro
```
public String getDateMacro()
```
    Gets the value of the dateMacro property.
    
    Returns:
    
    possible object is String
  - setDateMacro
```
public void setDateMacro(String value)
```
    Sets the value of the dateMacro property.
    
    Parameters:
    
    value - allowed object is String
  - getReportBasis
```
public ReportBasisEnum getReportBasis()
```
    Gets the value of the reportBasis property.
    
    Returns:
    
    possible object is ReportBasisEnum
  - setReportBasis
```
public void setReportBasis(ReportBasisEnum value)
```
    Sets the value of the reportBasis property.
    
    Parameters:
    
    value - allowed object is ReportBasisEnum
  - getStartPeriod
```
public String getStartPeriod()
```
    Gets the value of the startPeriod property.
    
    Returns:
    
    possible object is String
  - setStartPeriod
```
public void setStartPeriod(String value)
```
    Sets the value of the startPeriod property.
    
    Parameters:
    
    value - allowed object is String
  - getEndPeriod
```
public String getEndPeriod()
```
    Gets the value of the endPeriod property.
    
    Returns:
    
    possible object is String
  - setEndPeriod
```
public void setEndPeriod(String value)
```
    Sets the value of the endPeriod property.
    
    Parameters:
    
    value - allowed object is String
  - getSummarizeColumnsBy
```
public String getSummarizeColumnsBy()
```
    Gets the value of the summarizeColumnsBy property.
    
    Returns:
    
    possible object is String
  - setSummarizeColumnsBy
```
public void setSummarizeColumnsBy(String value)
```
    Sets the value of the summarizeColumnsBy property.
    
    Parameters:
    
    value - allowed object is String
  - getCurrency
```
public String getCurrency()
```
    Gets the value of the currency property.
    
    Returns:
    
    possible object is String
  - setCurrency
```
public void setCurrency(String value)
```
    Sets the value of the currency property.
    
    Parameters:
    
    value - allowed object is String
  - getCustomer
```
public String getCustomer()
```
    Gets the value of the customer property.
    
    Returns:
    
    possible object is String
  - setCustomer
```
public void setCustomer(String value)
```
    Sets the value of the customer property.
    
    Parameters:
    
    value - allowed object is String
  - getVendor
```
public String getVendor()
```
    Gets the value of the vendor property.
    
    Returns:
    
    possible object is String
  - setVendor
```
public void setVendor(String value)
```
    Sets the value of the vendor property.
    
    Parameters:
    
    value - allowed object is String
  - getEmployee
```
public String getEmployee()
```
    Gets the value of the employee property.
    
    Returns:
    
    possible object is String
  - setEmployee
```
public void setEmployee(String value)
```
    Sets the value of the employee property.
    
    Parameters:
    
    value - allowed object is String
  - getItem
```
public String getItem()
```
    Gets the value of the item property.
    
    Returns:
    
    possible object is String
  - setItem
```
public void setItem(String value)
```
    Sets the value of the item property.
    
    Parameters:
    
    value - allowed object is String
  - getClazz
```
public String getClazz()
```
    Gets the value of the clazz property.
    
    Returns:
    
    possible object is String
  - setClazz
```
public void setClazz(String value)
```
    Sets the value of the clazz property.
    
    Parameters:
    
    value - allowed object is String
  - getDepartment
```
public String getDepartment()
```
    Gets the value of the department property.
    
    Returns:
    
    possible object is String
  - setDepartment
```
public void setDepartment(String value)
```
    Sets the value of the department property.
    
    Parameters:
    
    value - allowed object is String
  - getOption
```
public List<NameValue> getOption()
```
    Gets the value of the option 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 option property.
    For example, to add a new item, do as follows:
```
    getOption().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list NameValue
  - setOption
```
public void setOption(List<NameValue> option)
```
    Sets the value of the option property.
    
    Parameters:
    
    option - allowed object is NameValue
  - 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.EqualsStrategy2 strategy)
```
    Specified by:
    
    equals in interface org.jvnet.jaxb2_commons.lang.Equals2
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                    org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
```
    Specified by:
    
    hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class ReportHeader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

time

reportName

dateMacro

reportBasis

startPeriod

endPeriod

summarizeColumnsBy

currency

customer

vendor

employee

item

clazz

department

option

Constructor Detail

ReportHeader

Method Detail

getTime

setTime

getReportName

setReportName

getDateMacro

setDateMacro

getReportBasis

setReportBasis

getStartPeriod

setStartPeriod

getEndPeriod

setEndPeriod

getSummarizeColumnsBy

setSummarizeColumnsBy

getCurrency

setCurrency

getCustomer

setCustomer

getVendor

setVendor

getEmployee

setEmployee

getItem

setItem

getClazz

setClazz

getDepartment

setDepartment

getOption

setOption

equals

equals

hashCode

hashCode