org.kuali.rice.kns.maintenance

Interface Maintainable

All Superinterfaces:

Maintainable, SelectiveReferenceRefresher, Serializable, ViewHelperService

Deprecated.

Use Maintainable.

@Deprecated
public interface Maintainable
extends Maintainable, SelectiveReferenceRefresher

Defines basic methods that all maintainable objects must provide

Method Summary

Methods

Modifier and Type	Method and Description
void	addMultipleValueLookupResults(MaintenanceDocument document, String collectionName, Collection<PersistableBusinessObject> rawValues, boolean needsBlank, PersistableBusinessObject bo) Deprecated.
void	addNewLineToCollection(String collectionName) Deprecated.
void	clearBusinessObjectOfRestrictedValues(MaintenanceDocumentRestrictions maintenanceDocumentRestrictions) Deprecated.
void	deleteBusinessObject() Deprecated.
Class	getBoClass() Deprecated.
PersistableBusinessObject	getBusinessObject() Deprecated.
String	getDocumentTitle(MaintenanceDocument document) Deprecated.
List<String>	getDuplicateIdentifierFieldsFromDataDictionary(String docTypeName, String collectionName) Deprecated.
Map<String,Boolean>	getInactiveRecordDisplay() Deprecated.
String	getMaintainableTitle() Deprecated.
List<String>	getMultiValueIdentifierList(Collection maintCollection, List<String> duplicateIdentifierFields) Deprecated.
PersistableBusinessObject	getNewCollectionLine(String collectionName) Deprecated.
List	getSections(MaintenanceDocument maintenanceDocument, Maintainable oldMaintainable) Deprecated.
boolean	getShowInactiveRecords(String collectionName) Deprecated.
boolean	hasBusinessObjectExisted(BusinessObject bo, List<String> existingIdentifierList, List<String> duplicateIdentifierFields) Deprecated.
boolean	isBoNotesEnabled() Deprecated.
boolean	isOldBusinessObjectInDocument() Deprecated.
Map	populateBusinessObject(Map<String,String> fieldValues, MaintenanceDocument maintenanceDocument, String methodToCall) Deprecated.
Map<String,String>	populateNewCollectionLines(Map<String,String> fieldValues, MaintenanceDocument maintenanceDocument, String methodToCall) Deprecated.
void	prepareBusinessObject(BusinessObject businessObject) Deprecated.
void	processAfterCopy(MaintenanceDocument document, Map<String,String[]> requestParameters) Deprecated.
void	processAfterEdit(MaintenanceDocument document, Map<String,String[]> requestParameters) Deprecated.
void	processAfterNew(MaintenanceDocument document, Map<String,String[]> requestParameters) Deprecated.
void	processAfterPost(MaintenanceDocument document, Map<String,String[]> requestParameters) Deprecated.
void	processBeforeAddLine(String colName, Class colClass, BusinessObject addBO) Deprecated.
void	refresh(String refreshCaller, Map fieldValues, MaintenanceDocument document) Deprecated.
void	saveBusinessObject() Deprecated.
void	setBoClass(Class boClass) Deprecated.
void	setBusinessObject(PersistableBusinessObject object) Deprecated.
void	setGenerateBlankRequiredValues(String docTypeName) Deprecated.
void	setGenerateDefaultValues(String docTypeName) Deprecated.
void	setShowInactiveRecords(String collectionName, boolean showInactive) Deprecated.
void	setupNewFromExisting(MaintenanceDocument document, Map<String,String[]> parameters) Deprecated.

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

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

Methods inherited from interface org.kuali.rice.kns.lookup.SelectiveReferenceRefresher

getAffectedReferencesFromLookup

Method Detail

getDocumentTitle

String getDocumentTitle(MaintenanceDocument document)

Deprecated.

getBusinessObject

@Deprecated
PersistableBusinessObject getBusinessObject()

Deprecated.

Returns instance of the business object that is being maintained.

refresh

@Deprecated
void refresh(String refreshCaller,
                      Map fieldValues,
                      MaintenanceDocument document)

Deprecated.

Called from a lookup return by the maintenance action.

setBusinessObject

@Deprecated
void setBusinessObject(PersistableBusinessObject object)

Deprecated.

Sets an instance of a business object to be maintained.

getBoClass

@Deprecated
Class getBoClass()

Deprecated.

setBoClass

@Deprecated
void setBoClass(Class boClass)

Deprecated.

saveBusinessObject

@Deprecated
void saveBusinessObject()

Deprecated.

This method will cause the Maintainable implementation to save/store the relevant business object(s). This typically is called only after the maint document has gone through state to final.

addMultipleValueLookupResults

@Deprecated
void addMultipleValueLookupResults(MaintenanceDocument document,
                                            String collectionName,
                                            Collection<PersistableBusinessObject> rawValues,
                                            boolean needsBlank,
                                            PersistableBusinessObject bo)

Deprecated.

getDuplicateIdentifierFieldsFromDataDictionary

@Deprecated
List<String> getDuplicateIdentifierFieldsFromDataDictionary(String docTypeName,
                                                                     String collectionName)

Deprecated.

getMultiValueIdentifierList

@Deprecated
List<String> getMultiValueIdentifierList(Collection maintCollection,
                                                  List<String> duplicateIdentifierFields)

Deprecated.

hasBusinessObjectExisted

@Deprecated
boolean hasBusinessObjectExisted(BusinessObject bo,
                                          List<String> existingIdentifierList,
                                          List<String> duplicateIdentifierFields)

Deprecated.

clearBusinessObjectOfRestrictedValues

@Deprecated
void clearBusinessObjectOfRestrictedValues(MaintenanceDocumentRestrictions maintenanceDocumentRestrictions)

Deprecated.

Blanks out or sets the default of any value specified as restricted within the MaintenanceDocumentRestrictions instance. This method should only be called if this maintainable represents the new maintainable of the maintenance document.

Parameters:

maintenanceDocumentRestrictions -

isBoNotesEnabled

boolean isBoNotesEnabled()

Deprecated.

prepareBusinessObject

@Deprecated
void prepareBusinessObject(BusinessObject businessObject)

Deprecated.

Gives chance to a maintainable object to prepare and return a maintainable object which might be external to the system

deleteBusinessObject

@Deprecated
void deleteBusinessObject()

Deprecated.

isOldBusinessObjectInDocument

@Deprecated
boolean isOldBusinessObjectInDocument()

Deprecated.

getShowInactiveRecords

@Deprecated
boolean getShowInactiveRecords(String collectionName)

Deprecated.

Indicates whether inactive records for the given collection should be display.

Parameters:

collectionName - - name of the collection (or sub-collection) to check inactive record display setting

Returns:

true if inactive records should be displayed, false otherwise

getInactiveRecordDisplay

@Deprecated
Map<String,Boolean> getInactiveRecordDisplay()

Deprecated.

Returns the Map used to control the state of inactive record collection display. Exposed for setting from the maintenance jsp.

setShowInactiveRecords

@Deprecated
void setShowInactiveRecords(String collectionName,
                                     boolean showInactive)

Deprecated.

Indicates to maintainble whether or not inactive records should be displayed for the given collection name.

Parameters:

collectionName - - name of the collection (or sub-collection) to set inactive record display setting

showInactive - - true to display inactive, false to not display inactive records

populateNewCollectionLines

@Deprecated
Map<String,String> populateNewCollectionLines(Map<String,String> fieldValues,
                                                       MaintenanceDocument maintenanceDocument,
                                                       String methodToCall)

Deprecated.

Populates the new collection lines based on key/value pairs.

Parameters:

fieldValues -

Returns:

getNewCollectionLine

@Deprecated
PersistableBusinessObject getNewCollectionLine(String collectionName)

Deprecated.

Gets the holder for the "add line" for a collection on the business object

Parameters:

collectionName -

Returns:

addNewLineToCollection

@Deprecated
void addNewLineToCollection(String collectionName)

Deprecated.

Adds the new line for the given collection to the business object's collection.

Parameters:

collectionName -

processBeforeAddLine

@Deprecated
void processBeforeAddLine(String colName,
                                   Class colClass,
                                   BusinessObject addBO)

Deprecated.

KULRICE-4264 - a hook to change the state of the business object, which is the "new line" of a collection, before it is validated

Parameters:

colName -

colClass -

addBO -

setGenerateDefaultValues

@Deprecated
void setGenerateDefaultValues(String docTypeName)

Deprecated.

Set default values.

Parameters:

docTypeName -

setGenerateBlankRequiredValues

@Deprecated
void setGenerateBlankRequiredValues(String docTypeName)

Deprecated.

Set default values for blank required fields.

Parameters:

docTypeName -

getSections

@Deprecated
List getSections(MaintenanceDocument maintenanceDocument,
                          Maintainable oldMaintainable)

Deprecated.

Returns a list of Section objects that specify how to render the view for the maintenance object.

Parameters:

oldMaintainable - - If this is the new maintainable, the old is passed in for reference. If it is the old maintainable, then null will be passed in

Returns:

populateBusinessObject

@Deprecated
Map populateBusinessObject(Map<String,String> fieldValues,
                                    MaintenanceDocument maintenanceDocument,
                                    String methodToCall)

Deprecated.

This method populates the business object based on key/value pairs.

Parameters:

fieldValues -

maintenanceDocument -

Returns:

getMaintainableTitle

@Deprecated
String getMaintainableTitle()

Deprecated.

Returns a string that will be displayed as title on the maintenance screen.

setupNewFromExisting

void setupNewFromExisting(MaintenanceDocument document,
                        Map<String,String[]> parameters)

Deprecated.

processAfterCopy

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

Deprecated.

processAfterEdit

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

Deprecated.

processAfterNew

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

Deprecated.

processAfterPost

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

Deprecated.