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

Class KSMaintainableImpl

java.lang.Object

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

org.kuali.rice.krad.maintenance.MaintainableImpl

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

All Implemented Interfaces:

Serializable, Maintainable, ViewHelperService, KSMaintainable

Direct Known Subclasses:

ActivityOfferingMaintainableImpl, RuleEditorMaintainableImpl

public class KSMaintainableImpl
extends MaintainableImpl
implements KSMaintainable

Default implementation of the KSMaintainable interface

Author:

Kuali Student Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
KSMaintainableImpl()

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
TypeInfo	getTypeInfo(String typeKey) This method gets the TypeInfo for a given type key
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.maintenance.MaintainableImpl

deleteDataObject, doRouteStatusChange, generateMaintenanceLocks, getCustomLockDescriptor, getDataObject, getDataObjectAuthorizationService, getDataObjectClass, getDataObjectMetaDataService, getDocumentDictionaryService, getDocumentNumber, getDocumentTitle, getDocumentTypeName, getEncryptionService, getLockingDocumentId, getLookupService, getMaintenanceAction, getMaintenanceDocumentService, getPersistableBusinessObject, getWorkflowEngineDocumentIdsToLock, isExternalBusinessObject, isLockable, isNotesEnabled, isOldDataObjectInDocument, prepareExternalBusinessObject, prepareForSave, processAfterAddLine, processAfterCopy, processAfterDeleteLine, processAfterEdit, processAfterNew, processAfterPost, processAfterRetrieve, retrieveObjectForEditOrCopy, saveDataObject, setDataObject, setDataObjectAuthorizationService, setDataObjectClass, setDataObjectMetaDataService, setDocumentDictionaryService, setDocumentNumber, setEncryptionService, setLookupService, setMaintenanceAction, setMaintenanceDocumentService, setupNewFromExisting, useCustomLockDescriptors

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

addCustomContainerComponents, addLine, adjustIdIfNecessary, applyAuthorizationAndPresentationLogic, applyDefaultValues, applyDefaultValuesForCollectionLine, buildClientSideStateScript, buildExportTableData, buildExportTableRow, buildGrowlScript, buildInquiryLink, cleanViewAfterRender, findNestedDictionaryAttribute, getBusinessObjectService, getCommonContext, getConfigurationService, getDataDictionaryService, getExportTableFormatOptions, getExpressionEvaluator, getPersistenceService, getPersistenceStructureService, getPreModelContext, getViewDictionaryService, initializeDataFieldFromDataDictionary, invokeMethodFinalizer, logAndThrowRuntime, performAddLineValidation, performApplyModel, performComponentApplyModel, performComponentFinalize, performComponentInitialization, performComponentLifecycle, performCustomApplyModel, performCustomFinalize, performCustomInitialization, performDeleteLineValidation, performFinalize, performInitialization, populateDefaultValueForField, populateViewFromRequestParameters, processAfterSaveLine, processAnyRemoteFieldsHolder, processBeforeAddLine, processBeforeSaveLine, processCollectionAddBlankLine, processCollectionAddLine, processCollectionDeleteLine, processCollectionSaveLine, processMultipleValueLookupResults, refreshReferences, retrieveEditModesAndActionFlags, runComponentModifiers, setBusinessObjectService, setConfigurationService, setDataDictionaryService, setExpressionEvaluator, setPersistenceService, setPersistenceStructureService, setViewContext, setViewDictionaryService, spawnSubLifecyle, 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.maintenance.Maintainable

deleteDataObject, doRouteStatusChange, generateMaintenanceLocks, getCustomLockDescriptor, getDataObject, getDataObjectClass, getDocumentTitle, getLockingDocumentId, getMaintenanceAction, getPersistableBusinessObject, getWorkflowEngineDocumentIdsToLock, isExternalBusinessObject, isLockable, isNotesEnabled, isOldDataObjectInDocument, prepareExternalBusinessObject, prepareForSave, processAfterCopy, processAfterEdit, processAfterNew, processAfterPost, processAfterRetrieve, retrieveObjectForEditOrCopy, saveDataObject, setDataObject, setDataObjectClass, setDocumentNumber, setMaintenanceAction, setupNewFromExisting, useCustomLockDescriptors

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

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

Constructor Detail

KSMaintainableImpl

public KSMaintainableImpl()

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

Returns:

a new ContextInfo

getStateInfo

public StateInfo getStateInfo(String stateKey)

This method gets the StateInfo for a given state key

Parameters:

stateKey - state key

Returns:

StateInfo for the given state key

getTypeInfo

public TypeInfo getTypeInfo(String typeKey)

This method gets the TypeInfo for a given type key

Parameters:

typeKey - type key

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)

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 -

getHelper

public Object getHelper(String helperName)

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

Parameters:

helperName -

Returns: