org.kuali.rice.kns.datadictionary

Class InquiryDefinition

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

org.kuali.rice.kns.datadictionary.InquiryDefinition

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DataDictionaryDefinition, DictionaryBean

Deprecated.

Use InquiryView.

@Deprecated
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

Fields

Modifier and Type	Field and Description
protected Class<? extends InquiryAuthorizer>	authorizerClass Deprecated.
protected Class<? extends Inquirable>	inquirableClass Deprecated.
protected List<InquirySectionDefinition>	inquirySections Deprecated.
protected Class<? extends InquiryPresentationController>	presentationControllerClass Deprecated.
protected String	title Deprecated.
protected boolean	translateCodes Deprecated.

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

embeddedDataObjectMetadata, generatedFromMetadata, id

Fields inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

componentCode, namespaceCode

Constructor Summary

Constructors

Constructor and Description
InquiryDefinition() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) Deprecated. Directly validate simple fields, call completeValidation on Definition fields.
Class<? extends InquiryAuthorizer>	getAuthorizerClass() Deprecated.
FieldDefinition	getFieldDefinition(String fieldName) Deprecated. Returns the FieldDefinition associated with the field attribute name
Class<? extends Inquirable>	getInquirableClass() Deprecated.
InquirySectionDefinition	getInquirySection(String sectionTitle) Deprecated.
List<InquirySectionDefinition>	getInquirySections() Deprecated.
Class<? extends InquiryPresentationController>	getPresentationControllerClass() Deprecated.
String	getTitle() Deprecated.
boolean	isTranslateCodes() Deprecated.
void	setAuthorizerClass(Class<? extends InquiryAuthorizer> authorizerClass) Deprecated.
void	setInquirableClass(Class<? extends Inquirable> inquirableClass) Deprecated. 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) Deprecated. inquirySections allows inquiry to be presented in sections.
void	setPresentationControllerClass(Class<? extends InquiryPresentationController> presentationControllerClass) Deprecated.
void	setTitle(String title) Deprecated. The title element is used specify the title that will appear in the header of an Inquiry or Lookup screen.
void	setTranslateCodes(boolean translateCodes) Deprecated.
String	toString() Deprecated.

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

completeValidation, getId, hasEmbeddedDataObjectMetadata, setEmbeddedDataObjectMetadata, setGeneratedFromMetadata, setId, wasGeneratedFromMetadata

Methods inherited from class org.kuali.rice.krad.datadictionary.DictionaryBeanBase

clone, copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.datadictionary.DictionaryBean

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Field Detail

title

protected String title

Deprecated.

inquirySections

protected List<InquirySectionDefinition> inquirySections

Deprecated.

inquirableClass

protected Class<? extends Inquirable> inquirableClass

Deprecated.

presentationControllerClass

protected Class<? extends InquiryPresentationController> presentationControllerClass

Deprecated.

authorizerClass

protected Class<? extends InquiryAuthorizer> authorizerClass

Deprecated.

translateCodes

protected boolean translateCodes

Deprecated.

Constructor Detail

InquiryDefinition

public InquiryDefinition()

Deprecated.

Method Detail

getTitle

public String getTitle()

Deprecated.

setTitle

public void setTitle(String title)

Deprecated.

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()

Deprecated.

Returns:

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

getFieldDefinition

public FieldDefinition getFieldDefinition(String fieldName)

Deprecated.

Returns the FieldDefinition associated with the field attribute name

Parameters:

fieldName -

Returns:

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                      Class otherBusinessObjectClass)

Deprecated.

Directly validate simple fields, call completeValidation on Definition fields.

Specified by:

completeValidation in interface DataDictionaryDefinition

Overrides:

completeValidation in class DataDictionaryDefinitionBase

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

See Also:

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

getInquirySection

public InquirySectionDefinition getInquirySection(String sectionTitle)

Deprecated.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

See Also:

Object.toString()

getInquirableClass

public Class<? extends Inquirable> getInquirableClass()

Deprecated.

setInquirableClass

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

Deprecated.

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)

Deprecated.

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

getPresentationControllerClass

public Class<? extends InquiryPresentationController> getPresentationControllerClass()

Deprecated.

setPresentationControllerClass

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

Deprecated.

getAuthorizerClass

public Class<? extends InquiryAuthorizer> getAuthorizerClass()

Deprecated.

setAuthorizerClass

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

Deprecated.

isTranslateCodes

public boolean isTranslateCodes()

Deprecated.

setTranslateCodes

public void setTranslateCodes(boolean translateCodes)

Deprecated.