org.kuali.rice.krad.uif.widget

Class Inquiry

java.lang.Object

org.kuali.rice.krad.uif.component.ConfigurableBase

org.kuali.rice.krad.uif.component.ComponentBase

org.kuali.rice.krad.uif.widget.WidgetBase

org.kuali.rice.krad.uif.widget.Inquiry

All Implemented Interfaces:

Serializable, Component, Configurable, ScriptEventSupport, Widget, org.springframework.core.Ordered

Direct Known Subclasses:

DirectInquiry

public class Inquiry
extends WidgetBase

Widget for rendering an Inquiry link on a field's value

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	INQUIRY_TITLE_PREFIX

Fields inherited from interface org.kuali.rice.krad.uif.component.Ordered

INITIAL_ORDER_VALUE

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
Inquiry()

Method Summary

Modifier and Type	Method and Description
void	buildInquiryLink(Object dataObject, String propertyName, Class<?> inquiryObjectClass, Map<String,String> inquiryParms) Builds the inquiry link based on the given inquiry class and parameters
String	createTitleText(Class<?> dataObjectClass) Gets text to prepend to the inquiry link title
String	getBaseInquiryUrl()
List<Component>	getComponentsForLifecycle() List of components that are contained within the component and should be sent through the lifecycle
String	getDataObjectClassName()
LinkField	getInquiryLinkField()
Map<String,String>	getInquiryParameters()
String	getViewName()
boolean	isForceInquiry()
void	performFinalize(View view, Object model, Component parent) The following finalization is done here: progressiveRender and conditionalRefresh variables are processed if set If any of the style properties were given, sets the style string on the style property Set the skipInTabOrder flag for nested components
void	setBaseInquiryUrl(String baseInquiryUrl)
void	setDataObjectClassName(String dataObjectClassName)
void	setForceInquiry(boolean forceInquiry)
void	setInquiryLinkField(LinkField inquiryLinkField)
void	setInquiryParameters(Map<String,String> inquiryParameters)
void	setupLink(View view, Object model, DataField field) Get parent object and field name and build the inquiry link This was moved from the performFinalize because overlapping and to be used by DirectInquiry
void	setViewName(String viewName)
void	updateInquiryParameters(BindingInfo bindingInfo) Adjusts the path on the inquiry parameter property to match the binding path prefix of the given BindingInfo

Methods inherited from class org.kuali.rice.krad.uif.widget.WidgetBase

getComponentTypeName

Methods inherited from class org.kuali.rice.krad.uif.component.ComponentBase

addStyleClass, appendToStyle, getAlign, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getComponentSecurityClass, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getEventCode, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshDiscloseMethodToCall, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getStyleClassesAsString, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, getTemplate, getTitle, getValign, getWidth, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, isSkipInTabOrder, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAlign, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setHidden, setId, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshDiscloseMethodToCall, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setSkipInTabOrder, setStyle, setStyleClasses, setTemplate, setTitle, setValign, setWidth

Methods inherited from class org.kuali.rice.krad.uif.component.ConfigurableBase

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.uif.component.Component

addStyleClass, appendToStyle, getColSpan, getComponentModifiers, getComponentOptions, getComponentOptionsJSString, getComponentPrototypes, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getFactoryId, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getOrder, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getRefreshWhenChanged, getRefreshWhenChangedControlNames, getRenderOutput, getRequired, getRowSpan, getStyle, getStyleClasses, getTemplate, getTitle, isHidden, isPersistInSession, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isReadOnly, isRefresh, isRefreshedByAction, isRender, isResetDataOnRefresh, isSelfRendered, performApplyModel, performInitialization, pushAllToContext, pushObjectToContext, setColSpan, setComponentModifiers, setComponentOptions, setComponentOptionsJSString, setComponentSecurity, setConditionalRefresh, setContext, setFactoryId, setHidden, setId, setOrder, setPersistInSession, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefresh, setRefreshedByAction, setRefreshWhenChanged, setRender, setRenderOutput, setRequired, setResetDataOnRefresh, setRowSpan, setSelfRendered, setStyle, setStyleClasses, setTemplate, setTitle

Methods inherited from interface org.kuali.rice.krad.uif.component.Configurable

getPropertyExpression, getPropertyExpressions, setPropertyExpressions

Methods inherited from interface org.kuali.rice.krad.uif.component.ScriptEventSupport

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getSupportsOnBlur, getSupportsOnChange, getSupportsOnClick, getSupportsOnClose, getSupportsOnDblClick, getSupportsOnDocumentReady, getSupportsOnFocus, getSupportsOnKeyDown, getSupportsOnKeyPress, getSupportsOnKeyUp, getSupportsOnLoad, getSupportsOnMouseDown, getSupportsOnMouseMove, getSupportsOnMouseOut, getSupportsOnMouseOver, getSupportsOnMouseUp, getSupportsOnSubmit, getSupportsOnUnload, setOnBlurScript, setOnDocumentReadyScript, setOnLoadScript

Field Detail

INQUIRY_TITLE_PREFIX

public static final String INQUIRY_TITLE_PREFIX

See Also:

Constant Field Values

Constructor Detail

Inquiry

public Inquiry()

Method Detail

performFinalize

public void performFinalize(View view,
                            Object model,
                            Component parent)

Description copied from class: ComponentBase

The following finalization is done here:

• progressiveRender and conditionalRefresh variables are processed if set
• If any of the style properties were given, sets the style string on the style property
• Set the skipInTabOrder flag for nested components

Specified by:

performFinalize in interface Component

Overrides:

performFinalize in class ComponentBase

Parameters:

view - - view instance that should be finalized for rendering

model - - top level object containing the data

parent - - parent component

See Also:

ComponentBase.performFinalize(org.kuali.rice.krad.uif.view.View, java.lang.Object, org.kuali.rice.krad.uif.component.Component)

setupLink

public void setupLink(View view,
                      Object model,
                      DataField field)

Get parent object and field name and build the inquiry link This was moved from the performFinalize because overlapping and to be used by DirectInquiry

Parameters:

view - - Container View

model - - model

field - - The parent Attribute field

updateInquiryParameters

public void updateInquiryParameters(BindingInfo bindingInfo)

Adjusts the path on the inquiry parameter property to match the binding path prefix of the given BindingInfo

Parameters:

bindingInfo - - binding info instance to copy binding path prefix from

buildInquiryLink

public void buildInquiryLink(Object dataObject,
                             String propertyName,
                             Class<?> inquiryObjectClass,
                             Map<String,String> inquiryParms)

Builds the inquiry link based on the given inquiry class and parameters

Parameters:

dataObject - - parent object that contains the data (used to pull inquiry parameters)

propertyName - - name of the property the inquiry is set on

inquiryObjectClass - - class of the object the inquiry should point to

inquiryParms - - map of key field mappings for the inquiry

createTitleText

public String createTitleText(Class<?> dataObjectClass)

Gets text to prepend to the inquiry link title

Parameters:

dataObjectClass - - data object class being inquired into

Returns:

String title prepend text

getComponentsForLifecycle

public List<Component> getComponentsForLifecycle()

Description copied from interface: Component

List of components that are contained within the component and should be sent through the lifecycle

Used by ViewHelperService for the various lifecycle callbacks

Specified by:

getComponentsForLifecycle in interface Component

Overrides:

getComponentsForLifecycle in class ComponentBase

Returns:

List child components

See Also:

ComponentBase.getComponentsForLifecycle()

getBaseInquiryUrl

public String getBaseInquiryUrl()

setBaseInquiryUrl

public void setBaseInquiryUrl(String baseInquiryUrl)

getDataObjectClassName

public String getDataObjectClassName()

setDataObjectClassName

public void setDataObjectClassName(String dataObjectClassName)

getViewName

public String getViewName()

setViewName

public void setViewName(String viewName)

isForceInquiry

public boolean isForceInquiry()

setForceInquiry

public void setForceInquiry(boolean forceInquiry)

getInquiryParameters

public Map<String,String> getInquiryParameters()

setInquiryParameters

public void setInquiryParameters(Map<String,String> inquiryParameters)

getInquiryLinkField

public LinkField getInquiryLinkField()

setInquiryLinkField

public void setInquiryLinkField(LinkField inquiryLinkField)