org.kuali.rice.kns.datadictionary

Class InquiryCollectionDefinition

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.DataDictionaryDefinitionBase

org.kuali.rice.kns.datadictionary.FieldDefinition

org.kuali.rice.kns.datadictionary.InquiryCollectionDefinition

All Implemented Interfaces:

Serializable, Cloneable, CollectionDefinitionI, FieldDefinitionI, Copyable, DataDictionaryDefinition, DictionaryBean

Deprecated.

Use collections inside of InquiryView.

@Deprecated
public class InquiryCollectionDefinition
extends FieldDefinition
implements CollectionDefinitionI

The inquiryCollection defines a collection within the Business Object which contains data that should be displayed with the BO when the inquiry is performed. Each inquiryCollection defines a set of data fields, nested inquiryCollections and summaryFields. The summaryFields will be reported in the header of this inquiryCollection. DD: See InquiryCollectionDefinition.java JSTL: The inquiryCollection element is a Map with the following keys: * name (String) * dataObjectClass (String) * numberOfColumns (String) * inquiryFields (Map) * inquiryCollections (Map, optional) * summaryTitle (String) * summaryFields (Map, optional)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<? extends BusinessObject>	businessObjectClass Deprecated.
protected Map<String,InquiryCollectionDefinition>	inquiryCollectionMap Deprecated.
protected List<InquiryCollectionDefinition>	inquiryCollections Deprecated.
protected Map<String,FieldDefinition>	inquiryFieldMap Deprecated.
protected List<FieldDefinition>	inquiryFields Deprecated.
protected Integer	numberOfColumns Deprecated.
protected Map<String,FieldDefinitionI>	summaryFieldMap Deprecated.
protected List<FieldDefinition>	summaryFields Deprecated.
protected String	summaryTitle Deprecated.

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

additionalDisplayAttributeName, alternateDisplayAttributeName, attributeName, defaultValue, defaultValueFinderClass, displayEditMode, displayMask, forceInquiry, forceLookup, hidden, maxLength, noDirectInquiry, noInquiry, noLookup, quickfinderParameterString, quickfinderParameterStringBuilderClass, readOnly, required, total, treatWildcardsAndOperatorsAsLiteral, triggerOnChange, useShortLabel

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
InquiryCollectionDefinition() Deprecated.

Method Summary

Methods

Modifier and Type	Method and Description
Class<? extends BusinessObject>	getBusinessObjectClass() Deprecated.
List<? extends CollectionDefinitionI>	getCollections() Deprecated.
List<? extends FieldDefinitionI>	getFields() Deprecated.
boolean	getIncludeAddLine() Deprecated.
List<InquiryCollectionDefinition>	getInquiryCollections() Deprecated.
List<FieldDefinition>	getInquiryFields() Deprecated.
String	getName() Deprecated.
Integer	getNumberOfColumns() Deprecated.
List<FieldDefinition>	getSummaryFields() Deprecated.
String	getSummaryTitle() Deprecated.
boolean	hasSummaryField(String key) Deprecated.
boolean	isAlwaysAllowCollectionDeletion() Deprecated.
void	setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass) Deprecated. This attribute is used in many contexts, for example, in maintenance docs, it's used to specify the classname of the BO being maintained.
void	setInquiryCollections(List<InquiryCollectionDefinition> inquiryCollections) Deprecated. inquirySections allows inquiry to be presented in sections.
void	setInquiryFields(List<FieldDefinition> inquiryFields) Deprecated. JSTL: inquiryFields is a Map which is accessed using a key of "inquiryFields".
void	setNumberOfColumns(Integer numberOfColumns) Deprecated. numberOfColumns = the number of fields to be displayed in each row of the inquiry section.
void	setSummaryFields(List<FieldDefinition> summaryFields) Deprecated. The inquirySummaryField indicates which fields are to appear in the header line of each record in a collection.
void	setSummaryTitle(String summaryTitle) Deprecated. The title element is used specify the title that will appear in the header of an Inquiry or Lookup screen.

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

completeValidation, getAdditionalDisplayAttributeName, getAlternateDisplayAttributeName, getAttributeName, getDefaultValue, getDefaultValueFinderClass, getDisplayEditMode, getDisplayMask, getMaxLength, getQuickfinderParameterString, getQuickfinderParameterStringBuilderClass, isForceInquiry, isForceLookup, isHidden, isNoDirectInquiry, isNoInquiry, isNoLookup, isReadOnly, isReadOnlyAfterAdd, isRequired, isTotal, isTreatWildcardsAndOperatorsAsLiteral, isTriggerOnChange, isUseShortLabel, setAdditionalDisplayAttributeName, setAlternateDisplayAttributeName, setAttributeName, setDefaultValue, setDefaultValueFinderClass, setDisplayEditMode, setDisplayMask, setForceInquiry, setForceLookup, setHidden, setMaxLength, setNoDirectInquiry, setNoInquiry, setNoLookup, setQuickfinderParameterString, setQuickfinderParameterStringBuilderClass, setReadOnly, setRequired, setTotal, setTreatWildcardsAndOperatorsAsLiteral, setTriggerOnChange, setUseShortLabel, toString

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

businessObjectClass

protected Class<? extends BusinessObject> businessObjectClass

Deprecated.

numberOfColumns

protected Integer numberOfColumns

Deprecated.

inquiryFieldMap

protected Map<String,FieldDefinition> inquiryFieldMap

Deprecated.

inquiryCollectionMap

protected Map<String,InquiryCollectionDefinition> inquiryCollectionMap

Deprecated.

summaryFieldMap

protected Map<String,FieldDefinitionI> summaryFieldMap

Deprecated.

inquiryFields

protected List<FieldDefinition> inquiryFields

Deprecated.

inquiryCollections

protected List<InquiryCollectionDefinition> inquiryCollections

Deprecated.

summaryFields

protected List<FieldDefinition> summaryFields

Deprecated.

summaryTitle

protected String summaryTitle

Deprecated.

Constructor Detail

InquiryCollectionDefinition

public InquiryCollectionDefinition()

Deprecated.

Method Detail

getBusinessObjectClass

public Class<? extends BusinessObject> getBusinessObjectClass()

Deprecated.

Specified by:

getBusinessObjectClass in interface CollectionDefinitionI

setBusinessObjectClass

public void setBusinessObjectClass(Class<? extends BusinessObject> businessObjectClass)

Deprecated.

This attribute is used in many contexts, for example, in maintenance docs, it's used to specify the classname of the BO being maintained.

getNumberOfColumns

public Integer getNumberOfColumns()

Deprecated.

setNumberOfColumns

public void setNumberOfColumns(Integer numberOfColumns)

Deprecated.

numberOfColumns = the number of fields to be displayed in each row of the inquiry section. For example, numberOfColumns = 2 indicates that the label and values for two fields will be displayed in each row as follows: field1label field1value | field2label field2value field3label field3value | field4label field4value etc.

getName

public String getName()

Deprecated.

Specified by:

getName in interface CollectionDefinitionI

Specified by:

getName in interface FieldDefinitionI

Overrides:

getName in class FieldDefinition

getCollections

public List<? extends CollectionDefinitionI> getCollections()

Deprecated.

Specified by:

getCollections in interface CollectionDefinitionI

getFields

public List<? extends FieldDefinitionI> getFields()

Deprecated.

Specified by:

getFields in interface CollectionDefinitionI

getIncludeAddLine

public boolean getIncludeAddLine()

Deprecated.

Specified by:

getIncludeAddLine in interface CollectionDefinitionI

isAlwaysAllowCollectionDeletion

public boolean isAlwaysAllowCollectionDeletion()

Deprecated.

Specified by:

isAlwaysAllowCollectionDeletion in interface CollectionDefinitionI

hasSummaryField

public boolean hasSummaryField(String key)

Deprecated.

Specified by:

hasSummaryField in interface CollectionDefinitionI

setSummaryTitle

public void setSummaryTitle(String summaryTitle)

Deprecated.

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

getSummaryTitle

public String getSummaryTitle()

Deprecated.

Specified by:

getSummaryTitle in interface CollectionDefinitionI

getInquiryFields

public List<FieldDefinition> getInquiryFields()

Deprecated.

setInquiryFields

public void setInquiryFields(List<FieldDefinition> inquiryFields)

Deprecated.

JSTL: inquiryFields is a Map which is accessed using a key of "inquiryFields". This map contains the following types of elements: inquirySubSectionHeader field inquiryCollection Each of these entries are keyed by "attributeName". The associated value is the attributeName of the mapped element. The inquirySubSectionHeader allows a separator containing text to separate groups of fields. The name attribute is the displayed text. DD: See InquirySubSectionHeaderDefinition. JSTL: inquirySubSectionHeader appears in the inquiryFields map as: key = "attributeName" value = name of inquirySubSectionHeader The field element defines the attributes of a single data field. DD: See FieldDefinition.java JSTL: The field element is a Map which is accessed using a key of the attributeName. This map contains the following keys: attributeName (String) forceInquiry (boolean String) noInquiry (boolean String) maxLength (String) forceInquiry = true means that the displayed field value will always be made inquirable (this attribute is not used within the code). noInquiry = true means that the displayed field will never be made inquirable. maxLength = the maximum allowable length of the field in the lookup result fields. In other contexts, like inquiries, this field has no effect.

getInquiryCollections

public List<InquiryCollectionDefinition> getInquiryCollections()

Deprecated.

setInquiryCollections

public void setInquiryCollections(List<InquiryCollectionDefinition> inquiryCollections)

Deprecated.

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

getSummaryFields

public List<FieldDefinition> getSummaryFields()

Deprecated.

Specified by:

getSummaryFields in interface CollectionDefinitionI

setSummaryFields

public void setSummaryFields(List<FieldDefinition> summaryFields)

Deprecated.

The inquirySummaryField indicates which fields are to appear in the header line of each record in a collection. For example, the header of an address record may contain something like: "Address ( Purchase_Order - San Francisco )" where the two summary fields are: Vendor Type = "Purchase_Order" Vendor City = "San Francisco" DD: See FieldDefinition.java