org.kuali.rice.krad.uif.field

Class GroupLinkField

java.lang.Object

org.kuali.rice.krad.datadictionary.DictionaryBeanBase

org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

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

org.kuali.rice.krad.uif.field.FieldBase

org.kuali.rice.krad.uif.field.LinkField

org.kuali.rice.krad.uif.field.GroupLinkField

All Implemented Interfaces:

Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, ScriptEventSupport, Field, LifecycleElement, org.springframework.core.Ordered

public class GroupLinkField
extends LinkField

Field that encloses a link to a group element.

Author:

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

See Also:

Serialized Form

Field Summary

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

templateOptions

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

componentCode, namespaceCode

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

Method Summary

Modifier and Type	Method and Description
protected String	buildInquiryUrl()
Map<String,String>	getAdditionalInquiryParameters() Map that determines what additional properties from a calling view will be sent to properties on the inquiry data object.
String	getBaseInquiryUrl() BaseInquiryUrl is the foundation of generated inquiry link url
String	getDataObjectClassName() DataObjectClassName used as a parameter of generated inquiry link url
String	getGroupId() GroupId key used as a parameter of generated inquiry link url
String	getGroupName() GroupName key used as a parameter of generated inquiry link url
protected String	getGroupNameByGroupId(String groupId)
protected String	getGroupNameByNamespaceAndName(String namespaceCode, String groupName)
String	getGroupNamespaceCode() GroupNamespaceCode key used as a parameter of generated inquiry link url
boolean	isDisableLink() True if this fields link is disabled, false otherwise.
boolean	isNamespaceInLinkText() True if namespaceCode is to be included in this links linkText, false otherwise.
void	performFinalize(Object model, LifecycleElement parent) PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content/
void	setAdditionalInquiryParameters(Map<String,String> additionalInquiryParameters)
void	setBaseInquiryUrl(String baseInquiryUrl)
void	setDataObjectClassName(String dataObjectClassName)
void	setDisableLink(boolean disableLink)
void	setGroupId(String groupId)
void	setGroupName(String groupName)
void	setGroupNamespaceCode(String groupNamespaceCode)
void	setNamespaceInLinkText(boolean namespaceInLinkText)

Methods inherited from class org.kuali.rice.krad.uif.field.LinkField

completeValidation, getHref, getLink, getLinkDialogId, getLinkText, getSortAs, getTarget, isOpenInDialog, performInitialization, setHref, setLink, setLinkDialogId, setLinkText, setOpenInDialog, setSortAs, setTarget

Methods inherited from class org.kuali.rice.krad.uif.field.FieldBase

afterEvaluateExpression, getComponentTypeName, getFieldLabel, getFieldSecurity, getLabel, getLabelColSpan, getLabelStyleClasses, getShortLabel, initializeComponentSecurity, isEditInLineAuthz, isLabelLeft, isLabelRendered, isViewInLineAuthz, performApplyModel, setComponentSecurity, setEditInLineAuthz, setFieldLabel, setLabel, setLabelColSpan, setLabelLeft, setLabelRendered, setLabelStyleClasses, setNestedComponentIdAndSuffix, setShortLabel, setShowLabel, setViewInLineAuthz

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, checkMutable, clone, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContainerIdSuffix, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getId, getLibraryCssClasses, getMethodToCallOnRefresh, getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, getOrder, getPhasePathMapping, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getViewPath, getViewStatus, getWidth, getWrapperCssClasses, getWrapperCssClassesAsString, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isEditAuthz, isFinal, isForceSessionPersistence, isHidden, isInitialized, isModelApplied, isMutable, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRender, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, isSkipInTabOrder, isViewAuthz, notifyCompleted, pushAllToContext, pushObjectToContext, pushToPropertyReplacerContext, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContainerIdSuffix, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setEditAuthz, setExcludeIf, setExcludeUnless, setFieldsToSendOnRefresh, setFinalizeMethodAdditionalArguments, setFinalizeMethodInvoker, setFinalizeMethodToCall, setForceSessionPersistence, setHidden, setId, setLibraryCssClasses, setMethodToCallOnRefresh, setOmitFromFormPost, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript, setOrder, setPhasePathMapping, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRender, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setSkipInTabOrder, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewAuthz, setViewPath, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle, skipLifecycle

Methods inherited from class org.kuali.rice.krad.datadictionary.uif.UifDictionaryBeanBase

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

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

copy, dataDictionaryPostProcessing, getComponentCode, getNamespaceCode, setComponentCode, setNamespaceCode

Methods inherited from class java.lang.Object

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

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

addAriaAttribute, addDataAttribute, addScriptDataAttribute, addStyleClass, addWrapperCssClass, appendToStyle, getAdditionalComponentsToRefresh, getAdditionalComponentsToRefreshJs, getAdditionalCssClasses, getAdditionalTemplates, getAlign, getAriaAttributes, getAriaAttributesAsString, getCanCopyOnReadOnly, getCellWidth, getColSpan, getComponentModifiers, getComponentSecurity, getConditionalRefresh, getConditionalRefreshConditionJs, getConditionalRefreshControlNames, getContext, getCssClasses, getCssGridSizes, getDataAttributes, getEventHandlerScript, getExcludeIf, getExcludeUnless, getFieldsToSendOnRefresh, getFinalizeMethodAdditionalArguments, getFinalizeMethodInvoker, getFinalizeMethodToCall, getLibraryCssClasses, getMethodToCallOnRefresh, getOrder, getPostRenderContent, getPreRenderContent, getProgressiveDisclosureConditionJs, getProgressiveDisclosureControlNames, getProgressiveRender, getPropertyReplacerComponents, getPropertyReplacers, getReadOnly, getRefreshTimer, getRefreshWhenChangedPropertyNames, getRenderedHtmlOutput, getRequired, getRole, getRowSpan, getScriptDataAttributes, getScriptDataAttributesJs, getSimpleDataAttributes, getStyle, getStyleClassesAsString, getTemplate, getTemplateName, getTemplateOptions, getTemplateOptionsJSString, getTitle, getToolTip, getValign, getWidth, getWrapperCssClasses, getWrapperStyle, isDisableSessionPersistence, isDisclosedByAction, isForceSessionPersistence, isHidden, isOmitFromFormPost, isProgressiveRenderAndRefresh, isProgressiveRenderViaAJAX, isRefreshedByAction, isRendered, isResetDataOnRefresh, isRetrieveViaAjax, isSelfRendered, setAdditionalComponentsToRefresh, setAdditionalCssClasses, setAlign, setAriaAttributes, setCanCopyOnReadOnly, setCellWidth, setColSpan, setComponentModifiers, setConditionalRefresh, setContext, setCssClasses, setCssGridSizes, setDataAttributes, setDisableSessionPersistence, setDisclosedByAction, setFieldsToSendOnRefresh, setForceSessionPersistence, setHidden, setLibraryCssClasses, setOmitFromFormPost, setOrder, setPostRenderContent, setPreRenderContent, setProgressiveRender, setProgressiveRenderAndRefresh, setProgressiveRenderViaAJAX, setPropertyReplacers, setReadOnly, setRefreshedByAction, setRefreshTimer, setRefreshWhenChangedPropertyNames, setRenderedHtmlOutput, setRequired, setResetDataOnRefresh, setRetrieveViaAjax, setRole, setRowSpan, setScriptDataAttributes, setSelfRendered, setStyle, setTemplate, setTemplateName, setTemplateOptions, setTemplateOptionsJSString, setTitle, setToolTip, setValign, setViewStatus, setWidth, setWrapperCssClasses, setWrapperStyle

Methods inherited from interface org.kuali.rice.krad.datadictionary.uif.UifDictionaryBean

getExpressionGraph, getPropertyExpression, getPropertyExpressions, setExpressionGraph, setPropertyExpressions

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

dataDictionaryPostProcessing, getComponentCode, getNamespaceCode

Methods inherited from interface org.kuali.rice.krad.uif.util.LifecycleElement

checkMutable, getContainerIdSuffix, getId, getPhasePathMapping, getViewPath, getViewStatus, isFinal, isInitialized, isModelApplied, isMutable, isRender, notifyCompleted, pushAllToContext, pushObjectToContext, setContainerIdSuffix, setId, setPhasePathMapping, setRender, setViewPath, skipLifecycle

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

clone

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

getOnBlurScript, getOnChangeScript, getOnClickScript, getOnCloseScript, getOnDblClickScript, getOnDocumentReadyScript, getOnFocusScript, getOnInputScript, getOnKeyDownScript, getOnKeyPressScript, getOnKeyUpScript, getOnLoadScript, getOnMouseDownScript, getOnMouseMoveScript, getOnMouseOutScript, getOnMouseOverScript, getOnMouseUpScript, getOnSubmitScript, getOnUnloadScript, setOnBlurScript, setOnChangeScript, setOnClickScript, setOnCloseScript, setOnDblClickScript, setOnDocumentReadyScript, setOnFocusScript, setOnInputScript, setOnKeyDownScript, setOnKeyPressScript, setOnKeyUpScript, setOnLoadScript, setOnMouseDownScript, setOnMouseMoveScript, setOnMouseOutScript, setOnMouseOverScript, setOnMouseUpScript, setOnSubmitScript, setOnUnloadScript

Constructor Detail

GroupLinkField

public GroupLinkField()

Method Detail

performFinalize

public void performFinalize(Object model,
                            LifecycleElement parent)

PerformFinalize override - calls super, corrects the field's Label for attribute to point to this field's content/

Specified by:

performFinalize in interface LifecycleElement

Overrides:

performFinalize in class LinkField

Parameters:

model - the model

parent - the parent component

buildInquiryUrl

protected String buildInquiryUrl()

getGroupNameByGroupId

protected String getGroupNameByGroupId(String groupId)

getGroupNameByNamespaceAndName

protected String getGroupNameByNamespaceAndName(String namespaceCode,
                                                String groupName)

getGroupName

public String getGroupName()

GroupName key used as a parameter of generated inquiry link url

Returns:

value of GroupName key parameter

setGroupName

public void setGroupName(String groupName)

getGroupNamespaceCode

public String getGroupNamespaceCode()

GroupNamespaceCode key used as a parameter of generated inquiry link url

Returns:

value of GroupNamespaceCode key parameter

setGroupNamespaceCode

public void setGroupNamespaceCode(String groupNamespaceCode)

getGroupId

public String getGroupId()

GroupId key used as a parameter of generated inquiry link url

Returns:

value of GroupId key parameter

setGroupId

public void setGroupId(String groupId)

getDataObjectClassName

public String getDataObjectClassName()

DataObjectClassName used as a parameter of generated inquiry link url

Returns:

value of DataObjectClassName parameter

setDataObjectClassName

public void setDataObjectClassName(String dataObjectClassName)

getBaseInquiryUrl

public String getBaseInquiryUrl()

BaseInquiryUrl is the foundation of generated inquiry link url

Returns:

value of BaseInquiryUrl part of inquiry link url

setBaseInquiryUrl

public void setBaseInquiryUrl(String baseInquiryUrl)

isNamespaceInLinkText

public boolean isNamespaceInLinkText()

True if namespaceCode is to be included in this links linkText, false otherwise.

Returns:

true if namespaceCode is to be included in linkText

setNamespaceInLinkText

public void setNamespaceInLinkText(boolean namespaceInLinkText)

isDisableLink

public boolean isDisableLink()

True if this fields link is disabled, false otherwise.

Returns:

true if link disabled

setDisableLink

public void setDisableLink(boolean disableLink)

getAdditionalInquiryParameters

public Map<String,String> getAdditionalInquiryParameters()

Map that determines what additional properties from a calling view will be sent to properties on the inquiry data object.

When invoking an inquiry view, a query is done against the inquiries configured data object and the resulting record is display. The values for the properties configured within the inquiry parameters Map, in addition to the inquiry key parameters, will be passed along as values for the inquiry data object properties (thus they form the criteria for the inquiry)

Returns:

mapping of calling additional view properties to inquiry data object properties

setAdditionalInquiryParameters

public void setAdditionalInquiryParameters(Map<String,String> additionalInquiryParameters)