microsoft.exchange.webservices.data.search

Class Grouping

java.lang.Object

microsoft.exchange.webservices.data.search.Grouping

All Implemented Interfaces:

ISelfValidate

public final class Grouping
extends Object
implements ISelfValidate

Represents grouping options in item search operations.

Constructor Summary

Constructors

Constructor and Description
Grouping() Initializes a new instance of the "Grouping" class.
Grouping(PropertyDefinitionBase groupOn, SortDirection sortDirection, PropertyDefinitionBase aggregateOn, AggregateType aggregateType) Initializes a new instance of the "Grouping" class.

Method Summary

Modifier and Type	Method and Description
PropertyDefinitionBase	getAggregateOn() Gets the property to aggregateOn.
AggregateType	getAggregateType() Gets the types of aggregate to calculate.
PropertyDefinitionBase	getGroupOn() Gets the property to group on.
SortDirection	getSortDirection() Gets the Sort Direction.
void	setAggregateOn(PropertyDefinitionBase aggregateOn) Sets the property to aggregateOn.
void	setAggregateType(AggregateType aggregateType) Sets the types of aggregate to calculate.
void	setGroupOn(PropertyDefinitionBase groupOn) sets the property to group on.
void	setSortDirection(SortDirection sortDirection) Sets the Sort Direction.
void	validate() Implements ISelfValidate.Validate.
protected void	writeToXml(EwsServiceXmlWriter writer) Writes to XML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Grouping

public Grouping()

Initializes a new instance of the "Grouping" class.

Grouping

public Grouping(PropertyDefinitionBase groupOn,
                SortDirection sortDirection,
                PropertyDefinitionBase aggregateOn,
                AggregateType aggregateType)
         throws Exception

Initializes a new instance of the "Grouping" class.

Parameters:

groupOn - The property to group on

sortDirection - The sort direction.

aggregateOn - The property to aggregate on.

aggregateType - The type of aggregate to calculate.

Throws:

Exception - the exception

Method Detail

writeToXml

protected void writeToXml(EwsServiceXmlWriter writer)
                   throws XMLStreamException,
                          ServiceXmlSerializationException

Writes to XML.

Parameters:

writer - the writer

Throws:

XMLStreamException - the XML stream exception

ServiceXmlSerializationException - the service xml serialization exception

getSortDirection

public SortDirection getSortDirection()

Gets the Sort Direction.

Returns:

the sort direction

setSortDirection

public void setSortDirection(SortDirection sortDirection)

Sets the Sort Direction.

Parameters:

sortDirection - the new sort direction

getGroupOn

public PropertyDefinitionBase getGroupOn()

Gets the property to group on.

Returns:

the group on

setGroupOn

public void setGroupOn(PropertyDefinitionBase groupOn)

sets the property to group on.

Parameters:

groupOn - the new group on

getAggregateOn

public PropertyDefinitionBase getAggregateOn()

Gets the property to aggregateOn.

Returns:

the aggregate on

setAggregateOn

public void setAggregateOn(PropertyDefinitionBase aggregateOn)

Sets the property to aggregateOn.

Parameters:

aggregateOn - the new aggregate on

getAggregateType

public AggregateType getAggregateType()

Gets the types of aggregate to calculate.

Returns:

the aggregate type

setAggregateType

public void setAggregateType(AggregateType aggregateType)

Sets the types of aggregate to calculate.

Parameters:

aggregateType - the new aggregate type

validate

public void validate()

Implements ISelfValidate.Validate. Validates this grouping.

Specified by:

validate in interface ISelfValidate