Package org.kuali.rice.kns.document.authorization

Class FieldRestriction

java.lang.Object
org.kuali.rice.kns.document.authorization.FieldRestriction
@Deprecated public class FieldRestriction extends Object
Deprecated.
Only used in KNS classes, use KRAD.
This class represents the authorization restrictions (or lack of) for a given field.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FieldRestriction()
    Deprecated.
     
    FieldRestriction(String fieldName, boolean canEdit, boolean canView)
    Deprecated.
     
    FieldRestriction(String fieldName, String fieldAuthorizationFlag)
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Deprecated.
     
    String
    getFieldName()
    Deprecated.
    Gets the fieldName attribute.
    String
    getKualiFieldDisplayFlag()
    Deprecated.
    This method returns the correct flag from the Kuali Field object, that corresponds to the particular combination of editable and viewable set on this object.
    org.kuali.rice.krad.datadictionary.mask.MaskFormatter
    getMaskFormatter()
    Deprecated.
     
    int
    hashCode()
    Deprecated.
     
    boolean
    isEditable()
    Deprecated.
    Gets the editable attribute.
    boolean
    isHidden()
    Deprecated.
    This method returns true if this authorization prohibits Viewing and Editing, resulting in a hidden field.
    boolean
    isMasked()
    Deprecated.
     
    boolean
    isPartiallyMasked()
    Deprecated.
     
    boolean
    isReadOnly()
    Deprecated.
    This method returns true if this authorization prohibits Editing but not Viewing, resulting in a ReadOnly field.
    boolean
    isRestricted()
    Deprecated.
    This method returns true if the FieldAuthorization is some kind of restriction, and returns false if it is an editable field.
    boolean
    isShouldBeEncrypted()
    Deprecated.
     
    boolean
    isViewable()
    Deprecated.
    Gets the viewable attribute.
    void
    setEditable(boolean editable)
    Deprecated.
    Sets the editable attribute value.
    void
    setFieldName(String fieldName)
    Deprecated.
    Sets the fieldName attribute value.
    void
    setMaskFormatter(org.kuali.rice.krad.datadictionary.mask.MaskFormatter maskFormatter)
    Deprecated.
     
    void
    setShouldBeEncrypted(boolean shouldBeEncrypted)
    Deprecated.
     
    void
    setViewable(boolean viewable)
    Deprecated.
    Sets the viewable attribute value.
    String
    toString()
    Deprecated.
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • FieldRestriction

      public FieldRestriction()
      Deprecated.

    • FieldRestriction

      public FieldRestriction(String fieldName, boolean canEdit, boolean canView)
      Deprecated.
      Parameters:
      fieldName - - name of field to represent
      canEdit - - true if the field is editable in this context, false otherwise
      canView - - true if thie field is viewable in this context, false otherwise

    • FieldRestriction

      public FieldRestriction(String fieldName, String fieldAuthorizationFlag)
      Deprecated.
      Parameters:
      fieldName - - name of the field to represent
      fieldAuthorizationFlag - - Field.HIDDEN, Field.READONLY, or Field.EDITABLE

  • Method Details

    • getKualiFieldDisplayFlag

      public String getKualiFieldDisplayFlag()
      Deprecated.
      This method returns the correct flag from the Kuali Field object, that corresponds to the particular combination of editable and viewable set on this object.
      Returns:
      Field.HIDDEN, Field.READONLY, or Field.EDITABLE

    • isRestricted

      public boolean isRestricted()
      Deprecated.
      This method returns true if the FieldAuthorization is some kind of restriction, and returns false if it is an editable field.
      Returns:
      boolean

    • isHidden

      public boolean isHidden()
      Deprecated.
      This method returns true if this authorization prohibits Viewing and Editing, resulting in a hidden field.
      Returns:
      boolean

    • isReadOnly

      public boolean isReadOnly()
      Deprecated.
      This method returns true if this authorization prohibits Editing but not Viewing, resulting in a ReadOnly field.
      Returns:
      boolean

    • isEditable

      public boolean isEditable()
      Deprecated.
      Gets the editable attribute.
      Returns:
      Returns the editable.

    • setEditable

      public void setEditable(boolean editable)
      Deprecated.
      Sets the editable attribute value. Note that if editable is being set to true, and the internal value of viewable is false, viewable will be flipped to true, to avoid impossible combinations of flags.
      Parameters:
      editable - The editable to set.

    • getFieldName

      public String getFieldName()
      Deprecated.
      Gets the fieldName attribute.
      Returns:
      Returns the fieldName.

    • setFieldName

      public void setFieldName(String fieldName)
      Deprecated.
      Sets the fieldName attribute value.
      Parameters:
      fieldName - The fieldName to set.

    • isViewable

      public boolean isViewable()
      Deprecated.
      Gets the viewable attribute.
      Returns:
      Returns the viewable.

    • setViewable

      public void setViewable(boolean viewable)
      Deprecated.
      Sets the viewable attribute value. Note that if viewable is being set to false, and the internal value of editable is true, then editable will be silently flipped to false. This is done to avoid impossible combinations of authorization flags.
      Parameters:
      viewable - The viewable to set.

    • toString

      public String toString()
      Deprecated.
      Overrides:
      toString in class Object
      See Also:

    • equals

      public boolean equals(Object obj)
      Deprecated.
      Overrides:
      equals in class Object
      See Also:

    • hashCode

      public int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object
      See Also:

    • isMasked

      public boolean isMasked()
      Deprecated.
      Returns:
      the masked

    • isPartiallyMasked

      public boolean isPartiallyMasked()
      Deprecated.
      Returns:
      the partiallyMasked

    • isShouldBeEncrypted

      public boolean isShouldBeEncrypted()
      Deprecated.
      Returns:
      the shouldBeEncrypted

    • setShouldBeEncrypted

      public void setShouldBeEncrypted(boolean shouldBeEncrypted)
      Deprecated.
      Parameters:
      shouldBeEncrypted - the shouldBeEncrypted to set

    • getMaskFormatter

      public org.kuali.rice.krad.datadictionary.mask.MaskFormatter getMaskFormatter()
      Deprecated.
      Returns:
      the maskFormatter

    • setMaskFormatter

      public void setMaskFormatter(org.kuali.rice.krad.datadictionary.mask.MaskFormatter maskFormatter)
      Deprecated.
      Parameters:
      maskFormatter - the maskFormatter to set