org.jaffa.components.codehelper.dto
Class CodeHelperInElementDto

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

public class CodeHelperInElementDto

extends Object

The input to the ICodeHelper, will consist of a List of instances of this class. The ICodeHelper will query the 'domainClassName' and use reflection to determine the fields to return. Additional criteria can be specified using instances of CriteriaElementDto. The properties domainClassName, codeFieldName and the descriptionFieldName are mandatory, for the ICodeHelper to work correctly.

Author:

GautamJ

Constructor Summary

CodeHelperInElementDto()
Creates new CodeHelperInElementDto

Method Summary

void	addCriteriaField(CriteriaElementDto criteriaField) Add a criteriaField to the list
void	clearCriteriaFields() Clear the list of criteriaField
String	getAppendBeginMarker() Getter for property appendBeginMarker.
String	getAppendEndMarker() Getter for property appendEndMarker.
String	getCode() Getter for property code.
String	getCodeFieldName() Getter for property codeFieldName.
CriteriaElementDto	getCriteriaField(int index) Return a criteriaField at the specified position in the list
int	getCriteriaFieldCount() Returns the number of criteriaField in the list
CriteriaElementDto[]	getCriteriaFields() Returns an array of criteriaField
String	getDescriptionFieldName() Getter for property descriptionFieldName.
String	getDomainClassName() Getter for property domainClassName.
boolean	isAppendCodeAndDescription() Getter for property appendCodeAndDescription.
boolean	removeCriteriaField(CriteriaElementDto criteriaField) Remove a criteriaField from the list
void	setAppendBeginMarker(String appendBeginMarker) Setter for property appendBeginMarker.
void	setAppendCodeAndDescription(boolean appendCodeAndDescription) Setter for property appendCodeAndDescription.
void	setAppendEndMarker(String appendEndMarker) Setter for property appendEndMarker.
void	setCode(String code) Setter for property code.
void	setCodeFieldName(String codeFieldName) Setter for property codeFieldName.
void	setCriteriaField(CriteriaElementDto criteriaField, int index) Add a criteriaField at the specified position in the list
void	setCriteriaFields(CriteriaElementDto[] criteriaFields) Recreate the internal list with the input array of criteriaField
void	setDescriptionFieldName(String descriptionFieldName) Setter for property descriptionFieldName.
void	setDomainClassName(String domainClassName) Setter for property domainClassName.
String	toString() Returns diagnostic information.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeHelperInElementDto

public CodeHelperInElementDto()

Creates new CodeHelperInElementDto

Method Detail

getCode

public String getCode()

Getter for property code.

Returns:

Value of property code.

setCode

public void setCode(String code)

Setter for property code.

Parameters:

code - New value of property code.

getDomainClassName

public String getDomainClassName()

Getter for property domainClassName.

Returns:

Value of property domainClassName.

setDomainClassName

public void setDomainClassName(String domainClassName)

Setter for property domainClassName.

Parameters:

domainClassName - New value of property domainClassName.

getCodeFieldName

public String getCodeFieldName()

Getter for property codeFieldName.

Returns:

Value of property codeFieldName.

setCodeFieldName

public void setCodeFieldName(String codeFieldName)

Setter for property codeFieldName.

Parameters:

codeFieldName - New value of property codeFieldName.

getDescriptionFieldName

public String getDescriptionFieldName()

Getter for property descriptionFieldName.

Returns:

Value of property descriptionFieldName.

setDescriptionFieldName

public void setDescriptionFieldName(String descriptionFieldName)

Setter for property descriptionFieldName.

Parameters:

descriptionFieldName - New value of property descriptionFieldName.

addCriteriaField

public void addCriteriaField(CriteriaElementDto criteriaField)

Add a criteriaField to the list

Parameters:

criteriaField - A criteriaField

setCriteriaField

public void setCriteriaField(CriteriaElementDto criteriaField,
                             int index)

Add a criteriaField at the specified position in the list

Parameters:

criteriaField - A criteriaField

index - The position in the list

setCriteriaFields

public void setCriteriaFields(CriteriaElementDto[] criteriaFields)

Recreate the internal list with the input array of criteriaField

Parameters:

criteriaFields - An array of criteriaField

clearCriteriaFields

public void clearCriteriaFields()

Clear the list of criteriaField

removeCriteriaField

public boolean removeCriteriaField(CriteriaElementDto criteriaField)

Remove a criteriaField from the list

Parameters:

criteriaField - The criteriaField to be removed

Returns:

true if this list contained the specified element

getCriteriaField

public CriteriaElementDto getCriteriaField(int index)

Return a criteriaField at the specified position in the list

Parameters:

index - The position in the list

Returns:

The criteriaField

getCriteriaFields

public CriteriaElementDto[] getCriteriaFields()

Returns an array of criteriaField

Returns:

An array of criteriaField

getCriteriaFieldCount

public int getCriteriaFieldCount()

Returns the number of criteriaField in the list

Returns:

The number of criteriaField in the list

isAppendCodeAndDescription

public boolean isAppendCodeAndDescription()

Getter for property appendCodeAndDescription.

Returns:

Value of property appendCodeAndDescription.

setAppendCodeAndDescription

public void setAppendCodeAndDescription(boolean appendCodeAndDescription)

Setter for property appendCodeAndDescription.

Parameters:

appendCodeAndDescription - New value of property appendCodeAndDescription.

getAppendBeginMarker

public String getAppendBeginMarker()

Getter for property appendBeginMarker.

Returns:

Value of property appendBeginMarker.

setAppendBeginMarker

public void setAppendBeginMarker(String appendBeginMarker)

Setter for property appendBeginMarker.

Parameters:

appendBeginMarker - New value of property appendBeginMarker.

getAppendEndMarker

public String getAppendEndMarker()

Getter for property appendEndMarker.

Returns:

Value of property appendEndMarker.

setAppendEndMarker

public void setAppendEndMarker(String appendEndMarker)

Setter for property appendEndMarker.

Parameters:

appendEndMarker - New value of property appendEndMarker.

toString

public String toString()

Returns diagnostic information.

Returns:

diagnostic information.