org.kuali.rice.kns.util
Class InactiveRecordsHidingUtils

java.lang.Object
  org.kuali.rice.kns.util.InactiveRecordsHidingUtils

public class InactiveRecordsHidingUtils
extends Object

Inquiry screens and maintenance documents may render a collection of BOs on a screen. These BOs may implement Inactivateable, which means that the BO has an active flag of true or false. Some screens may give the user the ability to not render (i.e. hide) inactive collection elements. This class has several utilities to control that behavior.

Author:

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

Constructor Summary

InactiveRecordsHidingUtils()

Method Summary

static String	formatCollectionName(String collectionName)
static boolean	getShowInactiveRecords(Map<String,Boolean> inactiveRecordDisplay, String collectionName) Returns whether a collection has been set to show inactive records.
static void	setShowInactiveRecords(Map<String,Boolean> inactiveRecordDisplay, String collectionName, boolean showInactive) Sets whether a method should show inactive records

Methods inherited from class java.lang.Object

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

Constructor Detail

InactiveRecordsHidingUtils

public InactiveRecordsHidingUtils()

Method Detail

getShowInactiveRecords

public static boolean getShowInactiveRecords(Map<String,Boolean> inactiveRecordDisplay,
                                             String collectionName)

Returns whether a collection has been set to show inactive records. Note that if a collection has not been set to show inactive inactive records, then this method will return false.

Parameters:

inactiveRecordDisplay - a Map used to keep state between invocations of this method and setShowInactiveRecords(Map, String, boolean)

collectionName - the name of the collection

Returns:

setShowInactiveRecords

public static void setShowInactiveRecords(Map<String,Boolean> inactiveRecordDisplay,
                                          String collectionName,
                                          boolean showInactive)

Sets whether a method should show inactive records

Parameters:

inactiveRecordDisplay - a Map used to keep state between invocations of this method and getShowInactiveRecords(Map, String)

collectionName - the name of the collection

showInactive - whether to show inactive records

formatCollectionName

public static String formatCollectionName(String collectionName)