org.kuali.rice.kns.datadictionary
Class InquiryDefinition

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.kns.datadictionary.InquiryDefinition

All Implemented Interfaces:

Serializable, DataDictionaryDefinition, org.springframework.beans.factory.InitializingBean

public class InquiryDefinition
extends DataDictionaryDefinitionBase

The inquiry element is used to specify the fields that will be displayed on the inquiry screen for this business object and the order in which they will appear. JSTL: The inquiry element is a Map which is accessed using a key of "inquiry". This map contains the following keys: title (String) inquiryFields (Map)

See Also:

Serialized Form

Field Summary

protected Class<? extends InquiryAuthorizer>	authorizerClass
protected Class<? extends Inquirable>	inquirableClass
protected List<InquirySectionDefinition>	inquirySections
protected Class<? extends InquiryPresentationController>	presentationControllerClass
private static long	serialVersionUID
protected String	title
protected boolean	translateCodes

Fields inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase

id

Constructor Summary

InquiryDefinition()

Method Summary

void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Directly validate simple fields, call completeValidation on Definition fields.
Class<? extends InquiryAuthorizer>	getAuthorizerClass()
FieldDefinition	getFieldDefinition(String fieldName) Returns the FieldDefinition associated with the field attribute name
Class<? extends Inquirable>	getInquirableClass()
InquirySectionDefinition	getInquirySection(String sectionTitle)
List<InquirySectionDefinition>	getInquirySections()
Class<? extends InquiryPresentationController>	getPresentationControllerClass()
String	getTitle()
boolean	isTranslateCodes()
void	setAuthorizerClass(Class<? extends InquiryAuthorizer> authorizerClass)
void	setInquirableClass(Class<? extends Inquirable> inquirableClass) inquirableClass is required if a custom inquirable is required which will show additional data other than the business object attributes.
void	setInquirySections(List<InquirySectionDefinition> inquirySections) inquirySections allows inquiry to be presented in sections.
void	setPresentationControllerClass(Class<? extends InquiryPresentationController> presentationControllerClass)
void	setTitle(String title) The title element is used specify the title that will appear in the header of an Inquiry or Lookup screen.
void	setTranslateCodes(boolean translateCodes)
String	toString()

Methods inherited from class org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase

afterPropertiesSet, getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

title

protected String title

inquirySections

protected List<InquirySectionDefinition> inquirySections

inquirableClass

protected Class<? extends Inquirable> inquirableClass

presentationControllerClass

protected Class<? extends InquiryPresentationController> presentationControllerClass

authorizerClass

protected Class<? extends InquiryAuthorizer> authorizerClass

translateCodes

protected boolean translateCodes

Constructor Detail

InquiryDefinition

public InquiryDefinition()

Method Detail

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

The title element is used specify the title that will appear in the header of an Inquiry or Lookup screen.

Throws:

IllegalArgumentException - if the given title is blank

getInquirySections

public List<InquirySectionDefinition> getInquirySections()

Returns:

Collection of all inquiryField FieldDefinitions associated with this InquiryDefinition, in the order in which they were added

getFieldDefinition

public FieldDefinition getFieldDefinition(String fieldName)

Returns the FieldDefinition associated with the field attribute name

Parameters:

fieldName -

Returns:

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

Directly validate simple fields, call completeValidation on Definition fields.

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

See Also:

org.kuali.rice.kns.datadictionary.DataDictionaryDefinition#completeValidation(java.lang.Class, java.lang.Object)

getInquirySection

public InquirySectionDefinition getInquirySection(String sectionTitle)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getInquirableClass

public Class<? extends Inquirable> getInquirableClass()

setInquirableClass

public void setInquirableClass(Class<? extends Inquirable> inquirableClass)

inquirableClass is required if a custom inquirable is required which will show additional data other than the business object attributes. Example from Org.xml: org.kuali.module.chart.maintenance.OrgInquirable The custom inquirable is required in this case because the organization hierarchy is shown on the inquiry screen.

setInquirySections

public void setInquirySections(List<InquirySectionDefinition> inquirySections)

inquirySections allows inquiry to be presented in sections. Each section can have a different format.

getPresentationControllerClass

public Class<? extends InquiryPresentationController> getPresentationControllerClass()

setPresentationControllerClass

public void setPresentationControllerClass(Class<? extends InquiryPresentationController> presentationControllerClass)

getAuthorizerClass

public Class<? extends InquiryAuthorizer> getAuthorizerClass()

setAuthorizerClass

public void setAuthorizerClass(Class<? extends InquiryAuthorizer> authorizerClass)

isTranslateCodes

public boolean isTranslateCodes()

setTranslateCodes

public void setTranslateCodes(boolean translateCodes)