org.kuali.student.common.uif.service.impl

Class KSViewHelperServiceImpl

java.lang.Object

org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

org.kuali.student.common.uif.service.impl.KSViewHelperServiceImpl

All Implemented Interfaces:

Serializable, org.kuali.rice.krad.uif.service.ViewHelperService, KSViewHelperService

Direct Known Subclasses:

AcademicCalendarViewHelperServiceImpl, CalendarSearchViewHelperServiceImpl, CO_AO_RG_ViewHelperServiceImpl, HolidayCalendarViewHelperServiceImpl, ManageSOCViewHelperServiceImpl, RuleViewHelperServiceImpl

public class KSViewHelperServiceImpl
extends org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl
implements KSViewHelperService

Base class for the KS View helper service.

Author:

Kuali Student Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KSViewHelperServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
RuntimeException	convertServiceExceptionsToUI(Exception ex) This is a helper method which handles all the services exceptions.
ContextInfo	createContextInfo() This method creates a new context, which is needed for the service call.
Object	getHelper(String helperName) This creates an instance of the helper class if it's already not there.
StateInfo	getStateInfo(String stateKey) This method gets the StateInfo for a given state key
protected StateService	getStateService()
TypeInfo	getTypeInfo(String typeKey) This method gets the TypeInfo for a given type key
protected TypeService	getTypeService()
void	setHelperClasses(Map<String,Class> helperClasses) This is a map which holds all the helper classes by name.

Methods inherited from class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

addCustomContainerComponents, addLine, adjustIdIfNecessary, applyAuthorizationAndPresentationLogic, applyDefaultValues, applyDefaultValuesForCollectionLine, buildClientSideStateScript, buildGrowlScript, buildInquiryLink, cleanViewAfterRender, findNestedDictionaryAttribute, getCommonContext, getConfigurationService, getDataDictionaryService, getExpressionEvaluatorService, getPreModelContext, getViewDictionaryService, initializeDataFieldFromDataDictionary, invokeMethodFinalizer, logAndThrowRuntime, performAddLineValidation, performApplyModel, performComponentApplyModel, performComponentFinalize, performComponentInitialization, performComponentLifecycle, performCustomApplyModel, performCustomFinalize, performCustomInitialization, performDeleteLineValidation, performFinalize, performInitialization, populateDefaultValueForField, populateViewFromRequestParameters, processAfterAddLine, processAfterDeleteLine, processAfterSaveLine, processAnyRemoteFieldsHolder, processBeforeAddLine, processBeforeSaveLine, processCollectionAddBlankLine, processCollectionAddLine, processCollectionDeleteLine, processCollectionSaveLine, processMultipleValueLookupResults, retrieveEditModesAndActionFlags, runComponentModifiers, setConfigurationService, setDataDictionaryService, setExpressionEvaluatorService, setViewContext, setViewDictionaryService, syncClientSideStateForComponent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.uif.service.ViewHelperService

applyDefaultValuesForCollectionLine, buildInquiryLink, cleanViewAfterRender, getCommonContext, performApplyModel, performComponentInitialization, performComponentLifecycle, performFinalize, performInitialization, populateViewFromRequestParameters, processCollectionAddBlankLine, processCollectionAddLine, processCollectionDeleteLine, processCollectionSaveLine, processMultipleValueLookupResults

Constructor Detail

KSViewHelperServiceImpl

public KSViewHelperServiceImpl()

Method Detail

createContextInfo

public ContextInfo createContextInfo()

This method creates a new context, which is needed for the service call. This is to create ContextInfo with the following information - current logged in user, current local date and locale information

Specified by:

createContextInfo in interface KSViewHelperService

Returns:

a new ContextInfo

getStateInfo

public StateInfo getStateInfo(String stateKey)

This method gets the StateInfo for a given state key

Specified by:

getStateInfo in interface KSViewHelperService

Parameters:

stateKey -

Returns:

StateInfo for the given state key

getTypeInfo

public TypeInfo getTypeInfo(String typeKey)

This method gets the TypeInfo for a given type key

Specified by:

getTypeInfo in interface KSViewHelperService

Parameters:

typeKey -

Returns:

TypeInfo for the given type key

convertServiceExceptionsToUI

public RuntimeException convertServiceExceptionsToUI(Exception ex)

This is a helper method which handles all the services exceptions. This can be the central point to handle all the services exceptions. For now, we're converting all the exceptions to Runtime exceptions. Once we implement authz and when services fully implemented the decorators/exceptions, we need to refactor to handle some of the exceptions with HandlerExceptionResolver (Note, underlying exception is passed to the runtime exception as cause... So, this can be accessed at the exception resolver to determine the action)

Specified by:

convertServiceExceptionsToUI in interface KSViewHelperService

Parameters:

ex - service exception to be handled

Returns:

service exception wrapped in a RuntimeException instance

setHelperClasses

public void setHelperClasses(Map<String,Class> helperClasses)

This is a map which holds all the helper classes by name. This can be used from the view xml file like And from the helper class, we can call like CourseOfferingSetPublishingHelper mpeHelper = (CourseOfferingSetPublishingHelper)getHelper("publishHelper");

Parameters:

helperClasses - map of helper classes with name as keys and classes as values

getHelper

public Object getHelper(String helperName)

This creates an instance of the helper class if it's already not there.

Parameters:

helperName -

Returns:

getStateService

protected StateService getStateService()

getTypeService

protected TypeService getTypeService()