org.kuali.kra.service.impl

Class UnitServiceImpl

java.lang.Object

org.kuali.kra.service.impl.UnitServiceImpl

All Implemented Interfaces:

UnitService

public class UnitServiceImpl
extends Object
implements UnitService

The Unit Service Implementation.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Constructor Summary

Constructors

Constructor and Description
UnitServiceImpl()

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.
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Accessor for BusinessObjectService
String	getInitialUnitsForUnitHierarchy() TODO : still WIP.
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.
protected String	getSubUnits(Unit unit, int level)
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.
UnitLookupDao	getUnitLookupDao()
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.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setUnitLookupDao(UnitLookupDao unitLookupDao)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitServiceImpl

public UnitServiceImpl()

Method Detail

getUnitCaseInsensitive

public Unit getUnitCaseInsensitive(String unitNumber)

Description copied from interface: UnitService

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.

Specified by:

getUnitCaseInsensitive in interface UnitService

Returns:

the unit or null if not found.

See Also:

UnitService.getUnitCaseInsensitive(java.lang.String)

getUnitName

public String getUnitName(String unitNumber)

Description copied from interface: UnitService

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

Specified by:

getUnitName in interface UnitService

Parameters:

unitNumber - identifier for the unit

Returns:

The name of the unit identified by this number.

See Also:

UnitService.getUnitName(java.lang.String)

getUnits

public Collection<Unit> getUnits()

Description copied from interface: UnitService

Get all of the Units.

Specified by:

getUnits in interface UnitService

Returns:

all of the units

See Also:

UnitService.getUnits()

getUnit

public Unit getUnit(String unitNumber)

Description copied from interface: UnitService

Get the Unit based upon its unique unit number.

Specified by:

getUnit in interface UnitService

Parameters:

unitNumber - the unit's unique unit number

Returns:

the unit or null if not found.

See Also:

UnitService.getUnit(java.lang.String)

getSubUnits

public List<Unit> getSubUnits(String unitNumber)

Description copied from interface: UnitService

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

Specified by:

getSubUnits in interface UnitService

Parameters:

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

Returns:

the list of immediate sub-units

See Also:

UnitService.getSubUnits(java.lang.String)

getAllSubUnits

public List<Unit> getAllSubUnits(String unitNumber)

Description copied from interface: UnitService

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

Specified by:

getAllSubUnits in interface UnitService

Parameters:

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

Returns:

the list of all sub-units

See Also:

UnitService.getAllSubUnits(java.lang.String)

getUnitHierarchyForUnit

public List<Unit> getUnitHierarchyForUnit(String unitNumber)

Description copied from interface: UnitService

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

Specified by:

getUnitHierarchyForUnit in interface UnitService

Returns:

See Also:

UnitService.getUnitHierarchyForUnit(java.lang.String)

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

Sets the businessObjectService attribute value. Injected by Spring.

Parameters:

businessObjectService - The businessObjectService to set.

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Accessor for BusinessObjectService

Returns:

BusinessObjectService

getSubUnitsForTreeView

public String getSubUnitsForTreeView(String unitNumber)

Description copied from interface: UnitService

This method to get the sub units for dynamic tree view

Specified by:

getSubUnitsForTreeView in interface UnitService

Returns:

See Also:

UnitService.getSubUnitsForTreeView(java.lang.String)

getTopUnit

public Unit getTopUnit()

Description copied from interface: UnitService

This method returns the top level unit in a hierarchy.

Specified by:

getTopUnit in interface UnitService

Returns:

the top level unit

See Also:

UnitService.getTopUnit()

getInitialUnitsForUnitHierarchy

public String getInitialUnitsForUnitHierarchy()

TODO : still WIP. cleanup b4 move to prod

Specified by:

getInitialUnitsForUnitHierarchy in interface UnitService

Returns:

See Also:

Basic data structure : Get the Top node to display. The node data is like following : 'parentidx-unitNumber : unitName' and separated by ';1;'

getInitialUnitsForUnitHierarchy

public String getInitialUnitsForUnitHierarchy(int depth)

Specified by:

getInitialUnitsForUnitHierarchy in interface UnitService

getSubUnits

protected String getSubUnits(Unit unit,
                 int level)

retrieveUnitAdministratorsByUnitNumber

public List<UnitAdministrator> retrieveUnitAdministratorsByUnitNumber(String unitNumber)

Specified by:

retrieveUnitAdministratorsByUnitNumber in interface UnitService

getMaxUnitTreeDepth

public int getMaxUnitTreeDepth()

Description copied from interface: UnitService

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

Specified by:

getMaxUnitTreeDepth in interface UnitService

Returns:

See Also:

UnitService.getMaxUnitTreeDepth()

getUnitLookupDao

public UnitLookupDao getUnitLookupDao()

setUnitLookupDao

public void setUnitLookupDao(UnitLookupDao unitLookupDao)

retrieveUnitCorrespondentsByUnitNumber

public List<UnitCorrespondent> retrieveUnitCorrespondentsByUnitNumber(String unitNumber)

Description copied from interface: UnitService

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

Specified by:

retrieveUnitCorrespondentsByUnitNumber in interface UnitService

Parameters:

unitNumber - identifier for the unit

Returns:

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

See Also:

org.kuali.kra.service.UnitService#retrieveUnitCorrespondentByUnitNumber(java.lang.String)