org.jaffa.components.finder
Class FinderInDto

java.lang.Object
  org.jaffa.components.finder.FinderInDto

public class FinderInDto

extends Object

This is the base class for all the input DTOs used by the Finder components.

Constructor Summary

FinderInDto()
Creates an instance of this class.

Method Summary

void	addOrderByFields(OrderByField orderByFields) Add orderByFields.
void	clearOrderByFields() Clear existing orderByFields.
Integer	getMaxRecords() Getter for property maxRecords.
OrderByField[]	getOrderByFields() Returns an array of orderByFields.
OrderByField	getOrderByFields(int index) Returns a orderByFields from the specified position.
int	getOrderByFieldsCount() Returns a count of orderByFields.
boolean	removeOrderByFields(OrderByField orderByFields) Remove orderByFields.
void	setMaxRecords(Integer maxRecords) Setter for property maxRecords.
void	setOrderByFields(OrderByField[] orderByFields) Add an array of orderByFields.
void	setOrderByFields(OrderByField orderByFields, int index) Add orderByFields at the specified position.

Methods inherited from class java.lang.Object

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

Constructor Detail

FinderInDto

public FinderInDto()

Creates an instance of this class.

Method Detail

addOrderByFields

public void addOrderByFields(OrderByField orderByFields)

Add orderByFields.

Parameters:

orderByFields - OrderByFields.

setOrderByFields

public void setOrderByFields(OrderByField orderByFields,
                             int index)

Add orderByFields at the specified position.

Parameters:

orderByFields - OrderByFields.

index - The position at which the orderByFields is to be added.

setOrderByFields

public void setOrderByFields(OrderByField[] orderByFields)

Add an array of orderByFields. This will overwrite existing orderByFields.

Parameters:

orderByFields - An array of orderByFields.

clearOrderByFields

public void clearOrderByFields()

Clear existing orderByFields.

removeOrderByFields

public boolean removeOrderByFields(OrderByField orderByFields)

Remove orderByFields.

Parameters:

orderByFields - OrderByFields.

Returns:

A true indicates a orderByFields was removed. A false indicates, the orderByFields was not found.

getOrderByFields

public OrderByField getOrderByFields(int index)

Returns a orderByFields from the specified position.

Parameters:

index - The position index.

Returns:

OrderByFields.

getOrderByFields

public OrderByField[] getOrderByFields()

Returns an array of orderByFields.

Returns:

An array of orderByFields.

getOrderByFieldsCount

public int getOrderByFieldsCount()

Returns a count of orderByFields.

Returns:

The count of orderByFields.

getMaxRecords

public Integer getMaxRecords()

Getter for property maxRecords.

Returns:

Value of property maxRecords.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

Setter for property maxRecords.

Parameters:

maxRecords - New value of property maxRecords.