org.kuali.rice.kns.datadictionary
Class AttributeSecurity

java.lang.Object
  org.kuali.rice.kns.datadictionary.DataDictionaryDefinitionBase
      org.kuali.rice.kns.datadictionary.AttributeSecurity

All Implemented Interfaces:

Serializable, DataDictionaryDefinition, org.springframework.beans.factory.InitializingBean

public class AttributeSecurity
extends DataDictionaryDefinitionBase

This class defines a set of restrictions that are possible on an attribute in a BusinessObjectEntry or a maintainable field in a MaintenanceDocumentEntry

Author:

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

See Also:

Serialized Form

Field Summary

(package private) boolean	hide
(package private) boolean	mask
(package private) MaskFormatter	maskFormatter
(package private) boolean	partialMask
(package private) MaskFormatter	partialMaskFormatter
(package private) boolean	readOnly
private static long	serialVersionUID

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

id

Constructor Summary

AttributeSecurity()

Method Summary

void	completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass) This overridden method ...
MaskFormatter	getMaskFormatter()
MaskFormatter	getPartialMaskFormatter()
boolean	hasAnyRestriction() Returns whether any of the restrictions defined in this class are true.
boolean	hasRestrictionThatRemovesValueFromUI() Returns whether any of the restrictions defined in this class indicate that the attribute value potentially needs to be not shown to the user (i.e.
boolean	isHide()
boolean	isMask()
boolean	isPartialMask()
boolean	isReadOnly()
void	setHide(boolean hide)
void	setMask(boolean mask)
void	setMaskFormatter(MaskFormatter maskFormatter)
void	setPartialMask(boolean partialMask)
void	setPartialMaskFormatter(MaskFormatter partialMaskFormatter)
void	setReadOnly(boolean readOnly)

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

afterPropertiesSet, getId, setId

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

readOnly

boolean readOnly

hide

boolean hide

mask

boolean mask

partialMask

boolean partialMask

partialMaskFormatter

MaskFormatter partialMaskFormatter

maskFormatter

MaskFormatter maskFormatter

Constructor Detail

AttributeSecurity

public AttributeSecurity()

Method Detail

isReadOnly

public boolean isReadOnly()

Returns:

the readOnly

setReadOnly

public void setReadOnly(boolean readOnly)

Parameters:

readOnly - the readOnly to set

isHide

public boolean isHide()

Returns:

the hide

setHide

public void setHide(boolean hide)

Parameters:

hide - the hide to set

isMask

public boolean isMask()

Returns:

the mask

setMask

public void setMask(boolean mask)

Parameters:

mask - the mask to set

isPartialMask

public boolean isPartialMask()

Returns:

the partialMask

setPartialMask

public void setPartialMask(boolean partialMask)

Parameters:

partialMask - the partialMask to set

getMaskFormatter

public MaskFormatter getMaskFormatter()

Returns:

the maskFormatter

setMaskFormatter

public void setMaskFormatter(MaskFormatter maskFormatter)

Parameters:

maskFormatter - the maskFormatter to set

getPartialMaskFormatter

public MaskFormatter getPartialMaskFormatter()

Returns:

the partialMaskFormatter

setPartialMaskFormatter

public void setPartialMaskFormatter(MaskFormatter partialMaskFormatter)

Parameters:

partialMaskFormatter - the partialMaskFormatter to set

completeValidation

public void completeValidation(Class rootBusinessObjectClass,
                               Class otherBusinessObjectClass)

This overridden method ...

Parameters:

rootBusinessObjectClass - Class of the BusinessObjectEntry which ultimately contains this definition

otherBusinessObjectClass - other stuff required to complete validation

See Also:

DataDictionaryDefinition.completeValidation(java.lang.Class, java.lang.Class)

hasAnyRestriction

public boolean hasAnyRestriction()

Returns whether any of the restrictions defined in this class are true.

hasRestrictionThatRemovesValueFromUI

public boolean hasRestrictionThatRemovesValueFromUI()

Returns whether any of the restrictions defined in this class indicate that the attribute value potentially needs to be not shown to the user (i.e. masked, partial mask, hide). Note that readonly does not fall in this category.

Returns: