org.kuali.rice.kns.document.authorization
Class BusinessObjectRestrictionsBase

java.lang.Object
  org.kuali.rice.kns.document.authorization.BusinessObjectRestrictionsBase

All Implemented Interfaces:

Serializable, BusinessObjectRestrictions

Direct Known Subclasses:

InquiryOrMaintenanceDocumentRestrictionsBase

public class BusinessObjectRestrictionsBase
extends Object
implements BusinessObjectRestrictions

See Also:

Serialized Form

Field Summary

protected Set<String>

allRestrictedFields

Constructor Summary

BusinessObjectRestrictionsBase()

Method Summary

void	addFullyMaskedField(String fieldName, MaskFormatter maskFormatter)
void	addPartiallyMaskedField(String fieldName, MaskFormatter maskFormatter)
void	clearAllRestrictions()
FieldRestriction	getFieldRestriction(String fieldName) This method returns the authorization setting for the given field name.
boolean	hasAnyFieldRestrictions()
boolean	hasRestriction(String fieldName)
protected boolean	isFullyMaskedField(String fieldName)
protected boolean	isPartiallyMaskedField(String fieldName)
protected String	normalizeFieldName(String fieldName) This method is used to convert field names on forms into a format that's compatible with field names that are registered with a restriction.

Methods inherited from class java.lang.Object

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

Field Detail

allRestrictedFields

protected Set<String> allRestrictedFields

Constructor Detail

BusinessObjectRestrictionsBase

public BusinessObjectRestrictionsBase()

Method Detail

hasAnyFieldRestrictions

public boolean hasAnyFieldRestrictions()

Specified by:

hasAnyFieldRestrictions in interface BusinessObjectRestrictions

hasRestriction

public boolean hasRestriction(String fieldName)

Specified by:

hasRestriction in interface BusinessObjectRestrictions

addFullyMaskedField

public void addFullyMaskedField(String fieldName,
                                MaskFormatter maskFormatter)

Specified by:

addFullyMaskedField in interface BusinessObjectRestrictions

addPartiallyMaskedField

public void addPartiallyMaskedField(String fieldName,
                                    MaskFormatter maskFormatter)

Specified by:

addPartiallyMaskedField in interface BusinessObjectRestrictions

getFieldRestriction

public FieldRestriction getFieldRestriction(String fieldName)

This method returns the authorization setting for the given field name. If the field name is not restricted in any way, a default full-editable value is returned.

Specified by:

getFieldRestriction in interface BusinessObjectRestrictions

Parameters:

fieldName - - name of field to get authorization restrictions for.

Returns:

a populated FieldAuthorization class for this field

clearAllRestrictions

public void clearAllRestrictions()

normalizeFieldName

protected String normalizeFieldName(String fieldName)

This method is used to convert field names on forms into a format that's compatible with field names that are registered with a restriction. The base implementation of this method just returns the string.

Parameters:

fieldName - The field name that would be rendered on a form

Returns:

isFullyMaskedField

protected boolean isFullyMaskedField(String fieldName)

isPartiallyMaskedField

protected boolean isPartiallyMaskedField(String fieldName)