org.jaffa.components.codehelper.dto
Class CodeHelperInDto

java.lang.Object
  org.jaffa.components.codehelper.dto.CodeHelperInDto

public class CodeHelperInDto

extends Object

The is the input to the ICodeHelper. It will contain one or more CodeHelperInElementDto objects. In turn, each CodeHelperInElementDto may contain zero or more CriteriaField objects, for specifying additional criteria.

Author:

GautamJ

Constructor Summary

CodeHelperInDto()
Creates new CodeHelperInElementDto

Method Summary

void	addCodeHelperInElementDto(CodeHelperInElementDto codeHelperInElementDto) Add a codeHelperInElementDto to the list
void	clearCodeHelperInElementDtos() Clear the list of codeHelperInElementDto
CodeHelperInElementDto	getCodeHelperInElementDto(int index) Return a codeHelperInElementDto at the specified position in the list
int	getCodeHelperInElementDtoCount() Returns the number of codeHelperInElementDto in the list
CodeHelperInElementDto[]	getCodeHelperInElementDtos() Returns an array of codeHelperInElementDto
HeaderDto	getHeaderDto() Getter for property headerDto.
boolean	removeCodeHelperInElementDto(CodeHelperInElementDto codeHelperInElementDto) Remove a codeHelperInElementDto from the list
void	setCodeHelperInElementDto(CodeHelperInElementDto codeHelperInElementDto, int index) Add a codeHelperInElementDto at the specified position in the list
void	setCodeHelperInElementDtos(CodeHelperInElementDto[] codeHelperInElementDtos) Recreate the internal list with the input array of codeHelperInElementDto
void	setHeaderDto(HeaderDto headerDto) Setter for property headerDto.
String	toString() Returns diagnostic information.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeHelperInDto

public CodeHelperInDto()

Creates new CodeHelperInElementDto

Method Detail

getHeaderDto

public HeaderDto getHeaderDto()

Getter for property headerDto.

Returns:

Value of property headerDto.

setHeaderDto

public void setHeaderDto(HeaderDto headerDto)

Setter for property headerDto.

Parameters:

headerDto - New value of property headerDto.

addCodeHelperInElementDto

public void addCodeHelperInElementDto(CodeHelperInElementDto codeHelperInElementDto)

Add a codeHelperInElementDto to the list

Parameters:

codeHelperInElementDto - A codeHelperInElementDto

setCodeHelperInElementDto

public void setCodeHelperInElementDto(CodeHelperInElementDto codeHelperInElementDto,
                                      int index)

Add a codeHelperInElementDto at the specified position in the list

Parameters:

codeHelperInElementDto - A codeHelperInElementDto

index - The position in the list

setCodeHelperInElementDtos

public void setCodeHelperInElementDtos(CodeHelperInElementDto[] codeHelperInElementDtos)

Recreate the internal list with the input array of codeHelperInElementDto

Parameters:

codeHelperInElementDtos - An array of codeHelperInElementDto

clearCodeHelperInElementDtos

public void clearCodeHelperInElementDtos()

Clear the list of codeHelperInElementDto

removeCodeHelperInElementDto

public boolean removeCodeHelperInElementDto(CodeHelperInElementDto codeHelperInElementDto)

Remove a codeHelperInElementDto from the list

Parameters:

codeHelperInElementDto - The codeHelperInElementDto to be removed

Returns:

true if this list contained the specified element

getCodeHelperInElementDto

public CodeHelperInElementDto getCodeHelperInElementDto(int index)

Return a codeHelperInElementDto at the specified position in the list

Parameters:

index - The position in the list

Returns:

The codeHelperInElementDto

getCodeHelperInElementDtos

public CodeHelperInElementDto[] getCodeHelperInElementDtos()

Returns an array of codeHelperInElementDto

Returns:

An array of codeHelperInElementDto

getCodeHelperInElementDtoCount

public int getCodeHelperInElementDtoCount()

Returns the number of codeHelperInElementDto in the list

Returns:

The number of codeHelperInElementDto in the list

toString

public String toString()

Returns diagnostic information.

Returns:

diagnostic information.