org.kuali.rice.krad.maintenance

Class MaintainableImpl

java.lang.Object

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

org.kuali.rice.krad.maintenance.MaintainableImpl

All Implemented Interfaces:

Serializable, org.kuali.rice.krad.maintenance.Maintainable, org.kuali.rice.krad.uif.service.ViewHelperService

Direct Known Subclasses:

AccountDelegateGlobalMaintainableImpl, org.kuali.rice.kns.maintenance.KualiMaintainableImpl, LicenceRoutingRuleDelegationMaintainable, OleCalendarMaintenanceImpl, OleCheckListMaintenanceImpl, OLEClaimNoticeMaintenanceImpl, OleDeliverRequestMaintenanceImpl, OLEFinancialSystemMaintainable, OLEGlobalMaintainableImpl, OleLicenseRequestMaintenanceImpl, OlePatronMaintenanceImpl

public class MaintainableImpl
extends org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl
implements org.kuali.rice.krad.maintenance.Maintainable

Created by sheiksalahudeenm on 10/23/14. Overridden for fixing the active flag issue while copying document. Modified method name: clearUnauthorizedField. Newly added method name: setPropertyValue. Changes description : Passing the property value to OLEObjectPropertyReference.resolvePath(..) method to fix the active flag issue.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MaintainableImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteDataObject()
void	doRouteStatusChange(org.kuali.rice.krad.bo.DocumentHeader documentHeader)
List<org.kuali.rice.krad.maintenance.MaintenanceLock>	generateMaintenanceLocks() Note: as currently implemented, every key field for a given data object class must have a visible getter
protected List<org.kuali.rice.krad.maintenance.MaintenanceLock>	generateMaintenanceLocks(String documentNumber, String documentTypeName, Class<?> dataObjectClass, Object dataObject) Allows locking of maintenance objects other than the one of the current maintenance object.
String	getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user) Default implementation just throws a PessimisticLockingException.
Object	getDataObject()
protected org.kuali.rice.krad.service.DataObjectAuthorizationService	getDataObjectAuthorizationService()
Class<?>	getDataObjectClass()
protected org.kuali.rice.krad.data.DataObjectService	getDataObjectService()
org.kuali.rice.krad.service.DocumentDictionaryService	getDocumentDictionaryService()
protected String	getDocumentNumber() Retrieves the document number configured on this maintainable
String	getDocumentTitle(org.kuali.rice.krad.maintenance.MaintenanceDocument document)
protected String	getDocumentTypeName() Retrieves the document type name from the data dictionary based on business object class
protected org.kuali.rice.core.api.encryption.EncryptionService	getEncryptionService()
org.kuali.rice.krad.service.KualiRuleService	getKualiRuleService()
protected org.kuali.rice.krad.service.LegacyDataAdapter	getLegacyDataAdapter() Deprecated.
String	getLockingDocumentId()
String	getMaintenanceAction()
protected org.kuali.rice.krad.service.MaintenanceDocumentService	getMaintenanceDocumentService()
Object	getPersistableBusinessObject()
List<String>	getWorkflowEngineDocumentIdsToLock()
boolean	isExternalBusinessObject()
boolean	isLockable() Deprecated. note used by Rice framework
boolean	isNotesEnabled()
boolean	isOldDataObjectInDocument() Checks whether the data object is not null and has its primary key values populated
protected boolean	performAddLineValidation(org.kuali.rice.krad.uif.view.ViewModel viewModel, Object newLine, String collectionId, String collectionPath)
void	performCustomApplyModel(org.kuali.rice.krad.uif.util.LifecycleElement element, Object model) Hook for service overrides to perform custom apply model logic on the component
void	performCustomFinalize(org.kuali.rice.krad.uif.util.LifecycleElement element, Object model, org.kuali.rice.krad.uif.util.LifecycleElement parent) For the copy action, clears out primary key values and replaces any new fields that the current user is unauthorized for with default values in the old record.
void	performCustomViewFinalize(Object model) For the copy action, runs the custom processing after the copy and sets the indicator that fields have been copied as true.
void	prepareExternalBusinessObject(org.kuali.rice.krad.bo.BusinessObject businessObject) Deprecated.
void	prepareForSave()
void	processAfterAddLine(org.kuali.rice.krad.uif.view.ViewModel viewModel, Object addLine, String collectionId, String collectionPath, boolean isValidLine) In the case of edit maintenance adds a new blank line to the old side TODO: should this write some sort of missing message on the old side instead?
void	processAfterCopy(org.kuali.rice.krad.maintenance.MaintenanceDocument document, Map<String,String[]> requestParameters)
void	processAfterDeleteLine(org.kuali.rice.krad.uif.view.ViewModel model, String collectionId, String collectionPath, int lineIndex) In the case of edit maintenance deleted the item on the old side.
void	processAfterEdit(org.kuali.rice.krad.maintenance.MaintenanceDocument document, Map<String,String[]> requestParameters)
void	processAfterNew(org.kuali.rice.krad.maintenance.MaintenanceDocument document, Map<String,String[]> requestParameters)
void	processAfterPost(org.kuali.rice.krad.maintenance.MaintenanceDocument document, Map<String,String[]> requestParameters)
void	processAfterRetrieve()
Object	retrieveObjectForEditOrCopy(org.kuali.rice.krad.maintenance.MaintenanceDocument document, Map<String,String> dataObjectKeys)
void	saveDataObject()
void	setDataObject(Object object)
void	setDataObjectAuthorizationService(org.kuali.rice.krad.service.DataObjectAuthorizationService dataObjectAuthorizationService)
void	setDataObjectClass(Class<?> dataObjectClass)
void	setDocumentDictionaryService(org.kuali.rice.krad.service.DocumentDictionaryService documentDictionaryService)
void	setDocumentNumber(String documentNumber)
void	setEncryptionService(org.kuali.rice.core.api.encryption.EncryptionService encryptionService)
void	setKualiRuleService(org.kuali.rice.krad.service.KualiRuleService kualiRuleService)
void	setLegacyDataAdapter(org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter) Deprecated.
void	setMaintenanceAction(String maintenanceAction)
void	setMaintenanceDocumentService(org.kuali.rice.krad.service.MaintenanceDocumentService maintenanceDocumentService)
static void	setPropertyValue(Object object, String propertyPath, Object propertyValue) Added by 'Sheik Salahudeen' for fixing the active flag issue while copying document.
void	setupNewFromExisting(org.kuali.rice.krad.maintenance.MaintenanceDocument document, Map<String,String[]> parameters)
boolean	useCustomLockDescriptors() Default implementation simply returns false to indicate that custom lock descriptors are not supported by MaintainableImpl.

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

addCustomContainerComponents, addLine, applyDefaultValues, applyDefaultValuesForCollectionLine, buildGrowlScript, buildInquiryLink, containsDuplicateLine, extractNewValuesAndAssign, extractSingleValue, filterByReturnedFieldConversions, getConfigurationService, getDataDictionaryService, getDefaultValueForField, getExpressionEvaluatorFactory, getViewDictionaryService, isDuplicateLine, linkAddedLine, logAndThrowRuntime, performCustomInitialization, performCustomViewInitialization, performDeleteLineValidation, populateDefaultValueForField, populateViewFromRequestParameters, processAfterEditLine, processAfterSaveLine, processAndAddLineObject, processBeforeAddLine, processBeforeEditLine, processBeforeSaveLine, processCollectionAddBlankLine, processCollectionAddLine, processCollectionCloseEditLineDialog, processCollectionDeleteLine, processCollectionEditLine, processCollectionRetrieveEditLineDialog, processCollectionSaveLine, processMultipleValueLookupResults, refreshReference, refreshReferences, retrieveEditModesAndActionFlags, setConfigurationService, setDataDictionaryService, setDataObjectService, setElementContext, setExpressionEvaluatorFactory, setViewContext, setViewDictionaryService

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

addCustomContainerComponents, applyDefaultValues, applyDefaultValuesForCollectionLine, buildGrowlScript, buildInquiryLink, getDefaultValueForField, getExpressionEvaluatorFactory, performCustomInitialization, performCustomViewInitialization, populateDefaultValueForField, populateViewFromRequestParameters, processAfterEditLine, processAfterSaveLine, processAndAddLineObject, processBeforeAddLine, processBeforeEditLine, processBeforeSaveLine, processCollectionAddBlankLine, processCollectionAddLine, processCollectionCloseEditLineDialog, processCollectionDeleteLine, processCollectionEditLine, processCollectionRetrieveEditLineDialog, processCollectionSaveLine, processMultipleValueLookupResults, refreshReference, refreshReferences, retrieveEditModesAndActionFlags, setElementContext, setViewContext

Constructor Detail

MaintainableImpl

public MaintainableImpl()

Method Detail

retrieveObjectForEditOrCopy

public Object retrieveObjectForEditOrCopy(org.kuali.rice.krad.maintenance.MaintenanceDocument document,
                                 Map<String,String> dataObjectKeys)

Specified by:

retrieveObjectForEditOrCopy in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.retrieveObjectForEditOrCopy(MaintenanceDocument, java.util.Map)

setDocumentNumber

public void setDocumentNumber(String documentNumber)

Specified by:

setDocumentNumber in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.setDocumentNumber(java.lang.String)

getDocumentTitle

public String getDocumentTitle(org.kuali.rice.krad.maintenance.MaintenanceDocument document)

Specified by:

getDocumentTitle in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.getDocumentTitle(org.kuali.rice.krad.maintenance.MaintenanceDocument)

getDataObject

public Object getDataObject()

Specified by:

getDataObject in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.getDataObject()

setDataObject

public void setDataObject(Object object)

Specified by:

setDataObject in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.setDataObject(java.lang.Object)

getDataObjectClass

public Class<?> getDataObjectClass()

Specified by:

getDataObjectClass in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.getDataObjectClass()

setDataObjectClass

public void setDataObjectClass(Class<?> dataObjectClass)

Specified by:

setDataObjectClass in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.setDataObjectClass(java.lang.Class<?>)

isLockable

@Deprecated
public boolean isLockable()

Deprecated. note used by Rice framework

Persistable business objects are lockable

Specified by:

isLockable in interface org.kuali.rice.krad.maintenance.Maintainable

getMaintenanceAction

public String getMaintenanceAction()

Specified by:

getMaintenanceAction in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.getMaintenanceAction()

setMaintenanceAction

public void setMaintenanceAction(String maintenanceAction)

Specified by:

setMaintenanceAction in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.setMaintenanceAction(java.lang.String)

generateMaintenanceLocks

public List<org.kuali.rice.krad.maintenance.MaintenanceLock> generateMaintenanceLocks()

Note: as currently implemented, every key field for a given data object class must have a visible getter

Specified by:

generateMaintenanceLocks in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.generateMaintenanceLocks()

generateMaintenanceLocks

protected List<org.kuali.rice.krad.maintenance.MaintenanceLock> generateMaintenanceLocks(String documentNumber,
                                                                             String documentTypeName,
                                                                             Class<?> dataObjectClass,
                                                                             Object dataObject)

Allows locking of maintenance objects other than the one of the current maintenance object.

Parameters:

documentNumber - of the locking maintenance document

documentTypeName - of the maintenance document to be locked

dataObjectClass - of the maintenance document to be locked

dataObject - of the maintenance document to be locked

Returns:

getDocumentTypeName

protected String getDocumentTypeName()

Retrieves the document type name from the data dictionary based on business object class

saveDataObject

public void saveDataObject()

Specified by:

saveDataObject in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.saveDataObject()

deleteDataObject

public void deleteDataObject()

Specified by:

deleteDataObject in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.deleteDataObject()

doRouteStatusChange

public void doRouteStatusChange(org.kuali.rice.krad.bo.DocumentHeader documentHeader)

Specified by:

doRouteStatusChange in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.doRouteStatusChange(org.kuali.rice.krad.bo.DocumentHeader)

getLockingDocumentId

public String getLockingDocumentId()

Specified by:

getLockingDocumentId in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.getLockingDocumentId()

getWorkflowEngineDocumentIdsToLock

public List<String> getWorkflowEngineDocumentIdsToLock()

Specified by:

getWorkflowEngineDocumentIdsToLock in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.getWorkflowEngineDocumentIdsToLock()

useCustomLockDescriptors

public boolean useCustomLockDescriptors()

Default implementation simply returns false to indicate that custom lock descriptors are not supported by MaintainableImpl. If custom lock descriptors are needed, the appropriate subclasses should override this method

Specified by:

useCustomLockDescriptors in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.useCustomLockDescriptors()

getCustomLockDescriptor

public String getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person user)

Default implementation just throws a PessimisticLockingException. Subclasses of MaintainableImpl that need support for custom lock descriptors should override this method

Specified by:

getCustomLockDescriptor in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.getCustomLockDescriptor(org.kuali.rice.kim.api.identity.Person)

isNotesEnabled

public boolean isNotesEnabled()

Specified by:

isNotesEnabled in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.isNotesEnabled()

isExternalBusinessObject

public boolean isExternalBusinessObject()

Specified by:

isExternalBusinessObject in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

isExternalBusinessObject()

prepareExternalBusinessObject

@Deprecated
public void prepareExternalBusinessObject(org.kuali.rice.krad.bo.BusinessObject businessObject)

Deprecated.

Specified by:

prepareExternalBusinessObject in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

prepareExternalBusinessObject(org.kuali.rice.krad.bo.BusinessObject)

isOldDataObjectInDocument

public boolean isOldDataObjectInDocument()

Checks whether the data object is not null and has its primary key values populated

Specified by:

isOldDataObjectInDocument in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

isOldDataObjectInDocument()

prepareForSave

public void prepareForSave()

Specified by:

prepareForSave in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.prepareForSave()

processAfterRetrieve

public void processAfterRetrieve()

Specified by:

processAfterRetrieve in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.processAfterRetrieve()

setupNewFromExisting

public void setupNewFromExisting(org.kuali.rice.krad.maintenance.MaintenanceDocument document,
                        Map<String,String[]> parameters)

Specified by:

setupNewFromExisting in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

setupNewFromExisting(org.kuali.rice.krad.maintenance.MaintenanceDocument, java.util.Map<java.lang.String, java.lang.String[]>)

processAfterCopy

public void processAfterCopy(org.kuali.rice.krad.maintenance.MaintenanceDocument document,
                    Map<String,String[]> requestParameters)

Specified by:

processAfterCopy in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.processAfterCopy(org.kuali.rice.krad.maintenance.MaintenanceDocument, java.util.Map<java.lang.String, java.lang.String[]>)

processAfterEdit

public void processAfterEdit(org.kuali.rice.krad.maintenance.MaintenanceDocument document,
                    Map<String,String[]> requestParameters)

Specified by:

processAfterEdit in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.processAfterEdit(org.kuali.rice.krad.maintenance.MaintenanceDocument, java.util.Map<java.lang.String, java.lang.String[]>)

processAfterNew

public void processAfterNew(org.kuali.rice.krad.maintenance.MaintenanceDocument document,
                   Map<String,String[]> requestParameters)

Specified by:

processAfterNew in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.processAfterNew(org.kuali.rice.krad.maintenance.MaintenanceDocument, java.util.Map<java.lang.String, java.lang.String[]>)

processAfterPost

public void processAfterPost(org.kuali.rice.krad.maintenance.MaintenanceDocument document,
                    Map<String,String[]> requestParameters)

Specified by:

processAfterPost in interface org.kuali.rice.krad.maintenance.Maintainable

See Also:

Maintainable.processAfterPost(org.kuali.rice.krad.maintenance.MaintenanceDocument, java.util.Map<java.lang.String, java.lang.String[]>)

processAfterAddLine

public void processAfterAddLine(org.kuali.rice.krad.uif.view.ViewModel viewModel,
                       Object addLine,
                       String collectionId,
                       String collectionPath,
                       boolean isValidLine)

In the case of edit maintenance adds a new blank line to the old side TODO: should this write some sort of missing message on the old side instead?

Specified by:

processAfterAddLine in interface org.kuali.rice.krad.uif.service.ViewHelperService

Overrides:

processAfterAddLine in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

processAfterDeleteLine

public void processAfterDeleteLine(org.kuali.rice.krad.uif.view.ViewModel model,
                          String collectionId,
                          String collectionPath,
                          int lineIndex)

In the case of edit maintenance deleted the item on the old side.

Specified by:

processAfterDeleteLine in interface org.kuali.rice.krad.uif.service.ViewHelperService

Overrides:

processAfterDeleteLine in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

See Also:

ViewHelperServiceImpl.processAfterDeleteLine(org.kuali.rice.krad.uif.view.ViewModel, String, String, int)

performAddLineValidation

protected boolean performAddLineValidation(org.kuali.rice.krad.uif.view.ViewModel viewModel,
                               Object newLine,
                               String collectionId,
                               String collectionPath)

Overrides:

performAddLineValidation in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

getDocumentNumber

protected String getDocumentNumber()

Retrieves the document number configured on this maintainable

Returns:

String document number

performCustomApplyModel

public void performCustomApplyModel(org.kuali.rice.krad.uif.util.LifecycleElement element,
                           Object model)

Hook for service overrides to perform custom apply model logic on the component

Specified by:

performCustomApplyModel in interface org.kuali.rice.krad.uif.service.ViewHelperService

Overrides:

performCustomApplyModel in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

Parameters:

element - element instance to apply model to

model - Top level object containing the data (could be the model or a top level business object, dto)

performCustomFinalize

public void performCustomFinalize(org.kuali.rice.krad.uif.util.LifecycleElement element,
                         Object model,
                         org.kuali.rice.krad.uif.util.LifecycleElement parent)

For the copy action, clears out primary key values and replaces any new fields that the current user is unauthorized for with default values in the old record.

Specified by:

performCustomFinalize in interface org.kuali.rice.krad.uif.service.ViewHelperService

Overrides:

performCustomFinalize in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

performCustomViewFinalize

public void performCustomViewFinalize(Object model)

For the copy action, runs the custom processing after the copy and sets the indicator that fields have been copied as true.

Specified by:

performCustomViewFinalize in interface org.kuali.rice.krad.uif.service.ViewHelperService

Overrides:

performCustomViewFinalize in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

getLegacyDataAdapter

@Deprecated
protected org.kuali.rice.krad.service.LegacyDataAdapter getLegacyDataAdapter()

Deprecated.

Overrides:

getLegacyDataAdapter in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

setLegacyDataAdapter

@Deprecated
public void setLegacyDataAdapter(org.kuali.rice.krad.service.LegacyDataAdapter legacyDataAdapter)

Deprecated.

Overrides:

setLegacyDataAdapter in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

getDataObjectAuthorizationService

protected org.kuali.rice.krad.service.DataObjectAuthorizationService getDataObjectAuthorizationService()

setDataObjectAuthorizationService

public void setDataObjectAuthorizationService(org.kuali.rice.krad.service.DataObjectAuthorizationService dataObjectAuthorizationService)

getDocumentDictionaryService

public org.kuali.rice.krad.service.DocumentDictionaryService getDocumentDictionaryService()

setDocumentDictionaryService

public void setDocumentDictionaryService(org.kuali.rice.krad.service.DocumentDictionaryService documentDictionaryService)

getEncryptionService

protected org.kuali.rice.core.api.encryption.EncryptionService getEncryptionService()

setEncryptionService

public void setEncryptionService(org.kuali.rice.core.api.encryption.EncryptionService encryptionService)

getDataObjectService

protected org.kuali.rice.krad.data.DataObjectService getDataObjectService()

Overrides:

getDataObjectService in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

getMaintenanceDocumentService

protected org.kuali.rice.krad.service.MaintenanceDocumentService getMaintenanceDocumentService()

setMaintenanceDocumentService

public void setMaintenanceDocumentService(org.kuali.rice.krad.service.MaintenanceDocumentService maintenanceDocumentService)

getKualiRuleService

public org.kuali.rice.krad.service.KualiRuleService getKualiRuleService()

setKualiRuleService

public void setKualiRuleService(org.kuali.rice.krad.service.KualiRuleService kualiRuleService)

getPersistableBusinessObject

public Object getPersistableBusinessObject()

Specified by:

getPersistableBusinessObject in interface org.kuali.rice.krad.maintenance.Maintainable

setPropertyValue

public static void setPropertyValue(Object object,
                    String propertyPath,
                    Object propertyValue)

Added by 'Sheik Salahudeen' for fixing the active flag issue while copying document.