org.kuali.kra.service

Interface UnitService

All Known Implementing Classes:

UnitServiceImpl

public interface UnitService

This class...

Method Summary

Methods

Modifier and Type	Method and Description
List<Unit>	getAllSubUnits(String unitNumber) Get the list of all of the sub-units for a given unit.
String	getInitialUnitsForUnitHierarchy() This method is to set up the initial load for unut hierarchy
String	getInitialUnitsForUnitHierarchy(int depth)
int	getMaxUnitTreeDepth() This method returns the tree depth of the entire unit hierarchy tree;
List<Unit>	getSubUnits(String unitNumber) Get the list of immediate sub-units for the given unit.
String	getSubUnitsForTreeView(String unitNumber) This method to get the sub units for dynamic tree view
Unit	getTopUnit() This method returns the top level unit in a hierarchy.
Unit	getUnit(String unitNumber) Get the Unit based upon its unique unit number.
Unit	getUnitCaseInsensitive(String unitNumber) This method does a case insensitive search keyed on unitNumber, and returns the matching unit object.
List<Unit>	getUnitHierarchyForUnit(String unitNumber) This method returns the unit hierarch the passed in unit.
String	getUnitName(String unitNumber) This method returns the Unit name for a given Unit Number.
Collection<Unit>	getUnits() Get all of the Units.
List<UnitAdministrator>	retrieveUnitAdministratorsByUnitNumber(String unitNumber)
List<UnitCorrespondent>	retrieveUnitCorrespondentsByUnitNumber(String unitNumber) This method returns a list of UnitCorrespondent objects based on a passed unit number.

Method Detail

getUnitCaseInsensitive

Unit getUnitCaseInsensitive(String unitNumber)

This method does a case insensitive search keyed on unitNumber, and returns the matching unit object. If there is no match, then null is returned.

Parameters:

unitNumber -

Returns:

the unit or null if not found.

getUnitName

String getUnitName(String unitNumber)

This method returns the Unit name for a given Unit Number.

Parameters:

unitNumber - identifier for the unit

Returns:

The name of the unit identified by this number.

getUnit

Unit getUnit(String unitNumber)

Get the Unit based upon its unique unit number.

Parameters:

unitNumber - the unit's unique unit number

Returns:

the unit or null if not found.

getSubUnits

List<Unit> getSubUnits(String unitNumber)

Get the list of immediate sub-units for the given unit.

Parameters:

unitNumber - the number of unit to find sub-units for

Returns:

the list of immediate sub-units

getAllSubUnits

List<Unit> getAllSubUnits(String unitNumber)

Get the list of all of the sub-units for a given unit.

Parameters:

unitNumber - the number of unit to find sub-units for

Returns:

the list of all sub-units

getUnitHierarchyForUnit

List<Unit> getUnitHierarchyForUnit(String unitNumber)

This method returns the unit hierarch the passed in unit. Including all the parent units, and the unit itself.

Parameters:

unitNumber -

Returns:

getUnits

Collection<Unit> getUnits()

Get all of the Units.

Returns:

all of the units

getSubUnitsForTreeView

String getSubUnitsForTreeView(String unitNumber)

This method to get the sub units for dynamic tree view

Parameters:

unitNumber -

Returns:

getTopUnit

Unit getTopUnit()

This method returns the top level unit in a hierarchy.

Returns:

the top level unit

getInitialUnitsForUnitHierarchy

String getInitialUnitsForUnitHierarchy()

This method is to set up the initial load for unut hierarchy

Returns:

getInitialUnitsForUnitHierarchy

String getInitialUnitsForUnitHierarchy(int depth)

retrieveUnitAdministratorsByUnitNumber

List<UnitAdministrator> retrieveUnitAdministratorsByUnitNumber(String unitNumber)

retrieveUnitCorrespondentsByUnitNumber

List<UnitCorrespondent> retrieveUnitCorrespondentsByUnitNumber(String unitNumber)

This method returns a list of UnitCorrespondent objects based on a passed unit number.

Parameters:

unitNumber - identifier for the unit

Returns:

list of UnitCorrespondent objects null value is returned if no unit correspondents not found

getMaxUnitTreeDepth

int getMaxUnitTreeDepth()

This method returns the tree depth of the entire unit hierarchy tree;

Returns: