org.kuali.rice.krms.impl.ui

Class AgendaEditorMaintainable

java.lang.Object

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

org.kuali.rice.krad.maintenance.MaintainableImpl

org.kuali.rice.krms.impl.ui.AgendaEditorMaintainable

All Implemented Interfaces:

Serializable, Maintainable, ViewHelperService

public class AgendaEditorMaintainable
extends MaintainableImpl

Maintainable for the AgendaEditor

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	NEW_AGENDA_EDITOR_DOCUMENT_TEXT

Constructor Summary

Constructors

Constructor and Description
AgendaEditorMaintainable()

Method Summary

Methods

Modifier and Type	Method and Description
BusinessObjectService	getBoService()
Class	getDataObjectClass() Returns the class for the data object being maintained
PersistableBusinessObject	getPersistableBusinessObject() Returns the data object if its persistable, null otherwise
boolean	isLockable() Persistable business objects are lockable
boolean	isOldDataObjectInDocument() Checks whether the data object is not null and has its primary key values populated
void	prepareForSave() Hook for performing any custom processing before the maintenance object is saved
void	processAfterEdit(MaintenanceDocument document, Map<String,String[]> requestParameters) Hook for performing any custom processing after the maintenance object has been setup for a edit action
void	processAfterNew(MaintenanceDocument document, Map<String,String[]> requestParameters) Hook for performing any custom processing after the maintenance object has been setup for a new action
protected void	processBeforeAddLine(View view, CollectionGroup collectionGroup, Object model, Object addLine) Hook for service overrides to process the new collection line before it is added to the collection
List<RemotableAttributeField>	retrieveAgendaCustomAttributes(View view, Object model, Container container)
Object	retrieveObjectForEditOrCopy(MaintenanceDocument document, Map<String,String> dataObjectKeys) Called during setupMaintenanceObject to retrieve the original dataObject that is being edited or copied.
List<RemotableAttributeField>	retrieveRuleActionCustomAttributes(View view, Object model, Container container)
List<RemotableAttributeField>	retrieveRuleCustomAttributes(View view, Object model, Container container) This only supports a single action within a rule.
List<RemotableAttributeField>	retrieveTermParameters(View view, Object model, Container container) Retrieve a list of RemotableAttributeFields for the parameters (if any) required by the resolver for the selected term in the proposition that is under edit.
void	saveDataObject() Invoked to persist changes to the data object being maintained

Methods inherited from class org.kuali.rice.krad.maintenance.MaintainableImpl

deleteDataObject, doRouteStatusChange, generateMaintenanceLocks, getCustomLockDescriptor, getDataObject, getDataObjectAuthorizationService, getDataObjectMetaDataService, getDocumentDictionaryService, getDocumentNumber, getDocumentTitle, getDocumentTypeName, getEncryptionService, getLockingDocumentId, getLookupService, getMaintenanceAction, getMaintenanceDocumentService, getWorkflowEngineDocumentIdsToLock, isExternalBusinessObject, isNotesEnabled, prepareExternalBusinessObject, processAfterAddLine, processAfterCopy, processAfterDeleteLine, processAfterPost, processAfterRetrieve, 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, 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.uif.service.ViewHelperService

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

Field Detail

NEW_AGENDA_EDITOR_DOCUMENT_TEXT

public static final String NEW_AGENDA_EDITOR_DOCUMENT_TEXT

See Also:

Constant Field Values

Constructor Detail

AgendaEditorMaintainable

public AgendaEditorMaintainable()

Method Detail

getBoService

public BusinessObjectService getBoService()

Returns:

the boService

retrieveAgendaCustomAttributes

public List<RemotableAttributeField> retrieveAgendaCustomAttributes(View view,
                                                           Object model,
                                                           Container container)

retrieveTermParameters

public List<RemotableAttributeField> retrieveTermParameters(View view,
                                                   Object model,
                                                   Container container)

Retrieve a list of RemotableAttributeFields for the parameters (if any) required by the resolver for the selected term in the proposition that is under edit.

retrieveRuleActionCustomAttributes

public List<RemotableAttributeField> retrieveRuleActionCustomAttributes(View view,
                                                               Object model,
                                                               Container container)

retrieveRuleCustomAttributes

public List<RemotableAttributeField> retrieveRuleCustomAttributes(View view,
                                                         Object model,
                                                         Container container)

This only supports a single action within a rule.

retrieveObjectForEditOrCopy

public Object retrieveObjectForEditOrCopy(MaintenanceDocument document,
                                 Map<String,String> dataObjectKeys)

Description copied from interface: Maintainable

Called during setupMaintenanceObject to retrieve the original dataObject that is being edited or copied. Override this method for non BusinessObject external persistence, Maintainable objects that extend BO should override isExternalBusinessObject and prepareBusinessObject instead. Do not override this method and isExternalBusinessObject.

Specified by:

retrieveObjectForEditOrCopy in interface Maintainable

Overrides:

retrieveObjectForEditOrCopy in class MaintainableImpl

Parameters:

document - document instance for the maintenance object

dataObjectKeys - Map of keys for the requested object

Returns:

the object identified by the dataObjectKeys

See Also:

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

processAfterNew

public void processAfterNew(MaintenanceDocument document,
                   Map<String,String[]> requestParameters)

Hook for performing any custom processing after the maintenance object has been setup for a new action

Specified by:

processAfterNew in interface Maintainable

Overrides:

processAfterNew in class MaintainableImpl

Parameters:

document - - maintenance document instance this maintainable belong to

requestParameters - - map of request parameters sent for the copy request

See Also:

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

processAfterEdit

public void processAfterEdit(MaintenanceDocument document,
                    Map<String,String[]> requestParameters)

Description copied from interface: Maintainable

Hook for performing any custom processing after the maintenance object has been setup for a edit action

Specified by:

processAfterEdit in interface Maintainable

Overrides:

processAfterEdit in class MaintainableImpl

Parameters:

document - - maintenance document instance this maintainable belong to

requestParameters - - map of request parameters sent for the copy request

See Also:

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

prepareForSave

public void prepareForSave()

Description copied from interface: Maintainable

Hook for performing any custom processing before the maintenance object is saved

Specified by:

prepareForSave in interface Maintainable

Overrides:

prepareForSave in class MaintainableImpl

See Also:

Maintainable.prepareForSave()

saveDataObject

public void saveDataObject()

Description copied from interface: Maintainable

Invoked to persist changes to the data object being maintained

Called after the maintenance document has become final indicating the changes should be applied

Specified by:

saveDataObject in interface Maintainable

Overrides:

saveDataObject in class MaintainableImpl

See Also:

Maintainable.saveDataObject()

isOldDataObjectInDocument

public boolean isOldDataObjectInDocument()

Description copied from class: MaintainableImpl

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

Specified by:

isOldDataObjectInDocument in interface Maintainable

Overrides:

isOldDataObjectInDocument in class MaintainableImpl

Returns:

boolean true if old data object exists, false if not

See Also:

MaintainableImpl.isOldDataObjectInDocument()

getDataObjectClass

public Class getDataObjectClass()

Description copied from interface: Maintainable

Returns the class for the data object being maintained

Specified by:

getDataObjectClass in interface Maintainable

Overrides:

getDataObjectClass in class MaintainableImpl

Returns:

Class data object class

See Also:

Maintainable.getDataObjectClass()

isLockable

public boolean isLockable()

Description copied from class: MaintainableImpl

Persistable business objects are lockable

Specified by:

isLockable in interface Maintainable

Overrides:

isLockable in class MaintainableImpl

Returns:

true if maintenance is lockable, false otherwise

See Also:

Maintainable.isLockable()

getPersistableBusinessObject

public PersistableBusinessObject getPersistableBusinessObject()

Description copied from class: MaintainableImpl

Returns the data object if its persistable, null otherwise

Specified by:

getPersistableBusinessObject in interface Maintainable

Overrides:

getPersistableBusinessObject in class MaintainableImpl

Returns:

persistable buisness object

See Also:

Maintainable.getPersistableBusinessObject()

processBeforeAddLine

protected void processBeforeAddLine(View view,
                        CollectionGroup collectionGroup,
                        Object model,
                        Object addLine)

Description copied from class: ViewHelperServiceImpl

Hook for service overrides to process the new collection line before it is added to the collection

Overrides:

processBeforeAddLine in class ViewHelperServiceImpl

Parameters:

view - view instance that is being presented (the action was taken on)

collectionGroup - collection group component for the collection the line will be added to

model - object instance that contain's the views data

addLine - the new line instance to be processed