Package org.kuali.rice.krad.uif.field

Class UserLinkField

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.UserLinkField
All Implemented Interfaces:
Serializable, Cloneable, Copyable, DictionaryBean, UifDictionaryBean, Component, Ordered, ScriptEventSupport, Field, LifecycleElement, org.springframework.core.Ordered
public class UserLinkField extends LinkField
Field that encloses a link to a person element.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • UserLinkField

      public UserLinkField()

  • Method Details

    • performInitialization

      public void performInitialization(Object model)
      The following initialization is performed:
      • Set the linkLabel if blank to the Field label
      The following initialization is performed:
      • Set the linkLabel if blank to the Field label
      The following updates are done here:
      • Invoke performInitialize on component modifiers
      Initializes the component

      Where components can set defaults and setup other necessary state. The initialize method should only be called once per component lifecycle and is invoked within the initialize phase of the view lifecylce.

      Specified by:
      performInitialization in interface LifecycleElement
      Overrides:
      performInitialization in class LinkField
      Parameters:
      model - - object instance containing the view data
      See Also:

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

    • getPersonNameByPrincipalId

      protected String getPersonNameByPrincipalId(String principalId)

    • getPersonNameByPrincipalName

      protected String getPersonNameByPrincipalName(String principalName)

    • getPrincipalName

      public String getPrincipalName()
      PrincipalName key used as a parameter of generated inquiry link url.
      Returns:
      value of PrincipalName key parameter

    • setPrincipalName

      public void setPrincipalName(String principalName)

    • getPrincipalId

      public String getPrincipalId()
      PrincipalId key used as a parameter of generated inquiry link url.
      Returns:
      value of PrincipalId key parameter

    • setPrincipalId

      public void setPrincipalId(String principalId)

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

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