Package org.kuali.rice.kns.maintenance

Class KualiMaintainableImpl

java.lang.Object
org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl
org.kuali.rice.krad.maintenance.MaintainableImpl
org.kuali.rice.kns.maintenance.KualiMaintainableImpl
All Implemented Interfaces:
Serializable, SelectiveReferenceRefresher, Maintainable, org.kuali.rice.krad.maintenance.Maintainable, org.kuali.rice.krad.uif.service.ViewHelperService
Direct Known Subclasses:
KualiGlobalMaintainableImpl
@Deprecated public class KualiMaintainableImpl extends org.kuali.rice.krad.maintenance.MaintainableImpl implements Maintainable
Deprecated.
Use MaintainableImpl.
Base Maintainable class to hold things common to all maintainables.
See Also:

  • Field Details

  • Constructor Details

    • KualiMaintainableImpl

      public KualiMaintainableImpl()
      Deprecated.

    • KualiMaintainableImpl

      public KualiMaintainableImpl(PersistableBusinessObject businessObject)
      Deprecated.
      Constructor which initializes the business object to be maintained.

  • Method Details

    • populateBusinessObject

      public Map populateBusinessObject(Map<String,String> fieldValues, MaintenanceDocument maintenanceDocument, String methodToCall)
      Deprecated.
      Description copied from interface: Maintainable
      This method populates the business object based on key/value pairs.
      Specified by:
      populateBusinessObject in interface Maintainable

    • decryptEncryptedData

      protected Map<String,String> decryptEncryptedData(Map<String,String> fieldValues, MaintenanceDocument maintenanceDocument, String methodToCall)
      Deprecated.
      Special hidden parameters are set on the maintenance jsp starting with a prefix that tells us which fields have been encrypted. This field finds the those parameters in the map, whose value gives us the property name that has an encrypted value. We then need to decrypt the value in the Map before the business object is populated.
      Parameters:
      fieldValues - - possibly with encrypted values
      Returns:
      Map fieldValues - with no encrypted values

    • shouldFieldBeEncrypted

      protected boolean shouldFieldBeEncrypted(MaintenanceDocument maintenanceDocument, String fieldName, MaintenanceDocumentRestrictions auths, String methodToCall)
      Deprecated.
      Determines whether the field in a request should be encrypted. This base implementation does not work for properties of collection elements. This base implementation will only return true if the maintenance document is being refreshed after a lookup (i.e. methodToCall is "refresh") and the data dictionary-based attribute security definition has any restriction defined, whether the user would be authorized to view the field. This assumes that only fields returned from a lookup should be encrypted in a request. If the user otherwise has no permissions to view/edit the field, then a request parameter will not be sent back to the server for population.

    • getSections

      public List getSections(MaintenanceDocument document, Maintainable oldMaintainable)
      Deprecated.
      Calls method to get all the core sections for the business object defined in the data dictionary. Then determines if the bo has custom attributes, if so builds a custom attribute section and adds to the section list.
      Specified by:
      getSections in interface Maintainable
      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:
      List of org.kuali.ui.Section objects

    • getCoreSections

      public List<Section> getCoreSections(MaintenanceDocument document, Maintainable oldMaintainable)
      Deprecated.
      Gets list of maintenance sections built from the data dictionary. If the section contains maintenance fields, construct Row/Field UI objects and place under Section UI. If section contains a maintenance collection, call method to build a Section UI which contains rows of Container Fields.
      Returns:
      List of org.kuali.ui.Section objects

    • saveBusinessObject

      public void saveBusinessObject()
      Deprecated.
      Description copied from interface: Maintainable
      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.
      Specified by:
      saveBusinessObject in interface Maintainable

    • saveDataObject

      public void saveDataObject()
      Deprecated.
      delegate this call to KNS' Maintainable.saveBusinessObject() in order to support KNS maintainables.
      Specified by:
      saveDataObject in interface org.kuali.rice.krad.maintenance.Maintainable
      Overrides:
      saveDataObject in class org.kuali.rice.krad.maintenance.MaintainableImpl

    • getMaintainableTitle

      public String getMaintainableTitle()
      Deprecated.
      Retrieves title for maintenance document from data dictionary
      Specified by:
      getMaintainableTitle in interface Maintainable

    • setupNewFromExisting

      public void setupNewFromExisting(MaintenanceDocument document, Map<String,String[]> parameters)
      Deprecated.
      Specified by:
      setupNewFromExisting in interface Maintainable

    • isBoNotesEnabled

      public boolean isBoNotesEnabled()
      Deprecated.
      Specified by:
      isBoNotesEnabled in interface Maintainable

    • retrieveObjectForEditOrCopy

      public PersistableBusinessObject retrieveObjectForEditOrCopy(MaintenanceDocument document, Map<String,String> businessObjectKeys)
      Deprecated.
      Specified by:
      retrieveObjectForEditOrCopy in interface Maintainable

    • isNotesEnabled

      public boolean isNotesEnabled()
      Deprecated.
      Overriding to call old (KNS) name of the method
      Specified by:
      isNotesEnabled in interface org.kuali.rice.krad.maintenance.Maintainable
      Overrides:
      isNotesEnabled in class org.kuali.rice.krad.maintenance.MaintainableImpl

    • refresh

      public void refresh(String refreshCaller, Map fieldValues, MaintenanceDocument document)
      Deprecated.
      Impls will be needed if custom action is needed on refresh.
      Specified by:
      refresh in interface Maintainable

    • refreshReferences

      public void refreshReferences(String referencesToRefresh)
      Deprecated.
      Specified by:
      refreshReferences in interface org.kuali.rice.krad.uif.service.ViewHelperService
      Overrides:
      refreshReferences in class org.kuali.rice.krad.uif.service.impl.ViewHelperServiceImpl

    • addMultipleValueLookupResults

      public void addMultipleValueLookupResults(MaintenanceDocument document, String collectionName, Collection<PersistableBusinessObject> rawValues, boolean needsBlank, PersistableBusinessObject bo)
      Deprecated.
      Specified by:
      addMultipleValueLookupResults in interface Maintainable

    • getDuplicateIdentifierFieldsFromDataDictionary

      public List<String> getDuplicateIdentifierFieldsFromDataDictionary(String docTypeName, String collectionName)
      Deprecated.
      This method is to retrieve a List of fields which are specified in the maintenance document data dictionary as the duplicateIdentificationFields. This List is used to determine whether the new entry being added to the collection is a duplicate entry and if so, we should not add the new entry to the existing collection
      Specified by:
      getDuplicateIdentifierFieldsFromDataDictionary in interface Maintainable

    • getMultiValueIdentifierList

      public List<String> getMultiValueIdentifierList(Collection maintCollection, List<String> duplicateIdentifierFields)
      Deprecated.
      Specified by:
      getMultiValueIdentifierList in interface Maintainable

    • hasBusinessObjectExisted

      public boolean hasBusinessObjectExisted(org.kuali.rice.krad.bo.BusinessObject bo, List<String> existingIdentifierList, List<String> duplicateIdentifierFields)
      Deprecated.
      Specified by:
      hasBusinessObjectExisted in interface Maintainable

    • prepareBusinessObjectForAdditionFromMultipleValueLookup

      public void prepareBusinessObjectForAdditionFromMultipleValueLookup(String collectionName, org.kuali.rice.krad.bo.BusinessObject bo)
      Deprecated.

    • processAfterCopy

      public void processAfterCopy(MaintenanceDocument document, Map<String,String[]> parameters)
      Deprecated.
      Set the new collection records back to true so they can be deleted (copy should act like new)
      Specified by:
      processAfterCopy in interface Maintainable

    • processAfterEdit

      public void processAfterEdit(MaintenanceDocument document, Map<String,String[]> requestParameters)
      Deprecated.
      Specified by:
      processAfterEdit in interface Maintainable

    • processAfterNew

      public void processAfterNew(MaintenanceDocument document, Map<String,String[]> requestParameters)
      Deprecated.
      Specified by:
      processAfterNew in interface Maintainable

    • processAfterPost

      public void processAfterPost(MaintenanceDocument document, Map<String,String[]> requestParameters)
      Deprecated.
      Specified by:
      processAfterPost in interface Maintainable

    • setDataObject

      public void setDataObject(Object object)
      Deprecated.
      Specified by:
      setDataObject in interface org.kuali.rice.krad.maintenance.Maintainable
      Overrides:
      setDataObject in class org.kuali.rice.krad.maintenance.MaintainableImpl

    • getDocumentTitle

      public String getDocumentTitle(MaintenanceDocument document)
      Deprecated.
      Specified by:
      getDocumentTitle in interface Maintainable

    • getBusinessObject

      public PersistableBusinessObject getBusinessObject()
      Deprecated.
      Description copied from interface: Maintainable
      Returns instance of the business object that is being maintained.
      Specified by:
      getBusinessObject in interface Maintainable
      Returns:
      Returns the instance of the business object being maintained.

    • setBusinessObject

      public void setBusinessObject(PersistableBusinessObject businessObject)
      Deprecated.
      Description copied from interface: Maintainable
      Sets an instance of a business object to be maintained.
      Specified by:
      setBusinessObject in interface Maintainable
      Parameters:
      businessObject - Sets the instance of a business object that will be maintained.

    • getBoClass

      public Class getBoClass()
      Deprecated.
      Specified by:
      getBoClass in interface Maintainable

    • setBoClass

      public void setBoClass(Class boClass)
      Deprecated.
      Specified by:
      setBoClass in interface Maintainable

    • setGenerateDefaultValues

      public void setGenerateDefaultValues(String docTypeName)
      Deprecated.
      Description copied from interface: Maintainable
      Set default values.
      Specified by:
      setGenerateDefaultValues in interface Maintainable

    • setGenerateBlankRequiredValues

      public void setGenerateBlankRequiredValues(String docTypeName)
      Deprecated.
      Description copied from interface: Maintainable
      Set default values for blank required fields.
      Specified by:
      setGenerateBlankRequiredValues in interface Maintainable

    • processAfterAddLine

      @Deprecated public void processAfterAddLine(String colName, Class colClass)
      Deprecated.

    • processBeforeAddLine

      public void processBeforeAddLine(String colName, Class colClass, org.kuali.rice.krad.bo.BusinessObject addBO)
      Deprecated.
      Description copied from interface: Maintainable
      KULRICE-4264 - a hook to change the state of the business object, which is the "new line" of a collection, before it is validated
      Specified by:
      processBeforeAddLine in interface Maintainable

    • getShowInactiveRecords

      public boolean getShowInactiveRecords(String collectionName)
      Deprecated.
      Description copied from interface: Maintainable
      Indicates whether inactive records for the given collection should be display.
      Specified by:
      getShowInactiveRecords in interface Maintainable
      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

    • setShowInactiveRecords

      public void setShowInactiveRecords(String collectionName, boolean showInactive)
      Deprecated.
      Description copied from interface: Maintainable
      Indicates to maintainble whether or not inactive records should be displayed for the given collection name.
      Specified by:
      setShowInactiveRecords in interface Maintainable
      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

    • getInactiveRecordDisplay

      public Map<String,Boolean> getInactiveRecordDisplay()
      Deprecated.
      Description copied from interface: Maintainable
      Returns the Map used to control the state of inactive record collection display. Exposed for setting from the maintenance jsp.
      Specified by:
      getInactiveRecordDisplay in interface Maintainable

    • addNewLineToCollection

      public void addNewLineToCollection(String collectionName)
      Deprecated.
      Description copied from interface: Maintainable
      Adds the new line for the given collection to the business object's collection.
      Specified by:
      addNewLineToCollection in interface Maintainable

    • getNewCollectionLine

      public PersistableBusinessObject getNewCollectionLine(String collectionName)
      Deprecated.
      Description copied from interface: Maintainable
      Gets the holder for the "add line" for a collection on the business object
      Specified by:
      getNewCollectionLine in interface Maintainable

    • initNewCollectionLine

      public PersistableBusinessObject initNewCollectionLine(String collectionName)
      Deprecated.

    • populateNewCollectionLines

      public Map<String,String> populateNewCollectionLines(Map<String,String> fieldValues, MaintenanceDocument maintenanceDocument, String methodToCall)
      Deprecated.
      Description copied from interface: Maintainable
      Populates the new collection lines based on key/value pairs.
      Specified by:
      populateNewCollectionLines in interface Maintainable

    • populateNewSubCollectionLines

      protected Map populateNewSubCollectionLines(MaintainableCollectionDefinition parentCollection, Map fieldValues)
      Deprecated.

    • getAffectedReferencesFromLookup

      public Collection<String> getAffectedReferencesFromLookup(org.kuali.rice.krad.bo.BusinessObject baseBO, String attributeName, String collectionPrefix)
      Deprecated.
      Description copied from interface: SelectiveReferenceRefresher
      Returns a list of references that must be refreshed after a lookup performed on an attribute is performed. A lookup on an attribute may cause many attribute values to be updated upon return from lookup. Generally, the returned attributes are the PK of the BO being looked up. For example, a lookup on an account number attribute will cause the chart of accounts code and account code to be returned. These returned attributes may cause other references on the page to be returned. For example, an account number lookup may cause the chart code to change, and if there is also an ObjectCode reference in the BO, then any change in the chart code will cause the referenced ObjectCode BO to be changed.
      Specified by:
      getAffectedReferencesFromLookup in interface SelectiveReferenceRefresher
      Parameters:
      attributeName - the name of the attribute with a quickfinder of the maintained BO.
      Returns:
      a list of reference names that could be affected by lookup return values

    • isRelationshipRefreshable

      protected boolean isRelationshipRefreshable(Class boClass, String relationshipName)
      Deprecated.

    • generateAllAffectedReferences

      protected Collection<String> generateAllAffectedReferences(Class boClass, Map<String,String> fkToPkMappings, String nestedBOPrefix, String collectionPrefix)
      Deprecated.

    • getAllRefreshableReferences

      protected Collection<String> getAllRefreshableReferences(Class boClass)
      Deprecated.

    • setNewCollectionLineDefaultValues

      protected void setNewCollectionLineDefaultValues(String collectionName, PersistableBusinessObject addLine)
      Deprecated.

    • clearBusinessObjectOfRestrictedValues

      public void clearBusinessObjectOfRestrictedValues(MaintenanceDocumentRestrictions maintenanceDocumentRestrictions)
      Deprecated.
      Description copied from interface: Maintainable
      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.
      Specified by:
      clearBusinessObjectOfRestrictedValues in interface Maintainable

    • clearCollectionRestrictedValues

      protected void clearCollectionRestrictedValues(String fieldNamePrefix, org.kuali.rice.krad.bo.BusinessObject businessObject, MaintainableCollectionDefinition collectionDefinition, MaintenanceDocumentRestrictions maintenanceDocumentRestrictions)
      Deprecated.

    • clearFieldRestrictedValues

      protected void clearFieldRestrictedValues(String fieldNamePrefix, org.kuali.rice.krad.bo.BusinessObject businessObject, MaintainableFieldDefinition fieldDefinition, MaintenanceDocumentRestrictions maintenanceDocumentRestrictions)
      Deprecated.

    • performForceUpperCase

      protected void performForceUpperCase(Map fieldValues)
      Deprecated.

    • performFieldForceUpperCase

      protected void performFieldForceUpperCase(String fieldNamePrefix, org.kuali.rice.krad.bo.BusinessObject bo, MaintainableFieldDefinition fieldDefinition, Map fieldValues)
      Deprecated.

    • performCollectionForceUpperCase

      protected void performCollectionForceUpperCase(String fieldNamePrefix, org.kuali.rice.krad.bo.BusinessObject bo, MaintainableCollectionDefinition collectionDefinition, Map fieldValues)
      Deprecated.

    • performFieldForceUpperCase

      protected void performFieldForceUpperCase(org.kuali.rice.krad.bo.BusinessObject bo, Map fieldValues)
      Deprecated.

    • isExternalBusinessObject

      public boolean isExternalBusinessObject()
      Deprecated.
      By default a maintainable is not external
      Specified by:
      isExternalBusinessObject in interface org.kuali.rice.krad.maintenance.Maintainable
      Overrides:
      isExternalBusinessObject in class org.kuali.rice.krad.maintenance.MaintainableImpl

    • prepareBusinessObject

      public void prepareBusinessObject(org.kuali.rice.krad.bo.BusinessObject businessObject)
      Deprecated.
      Description copied from interface: Maintainable
      Gives chance to a maintainable object to prepare and return a maintainable object which might be external to the system
      Specified by:
      prepareBusinessObject in interface Maintainable

    • deleteBusinessObject

      public void deleteBusinessObject()
      Deprecated.
      Specified by:
      deleteBusinessObject in interface Maintainable

    • isOldBusinessObjectInDocument

      public boolean isOldBusinessObjectInDocument()
      Deprecated.
      Specified by:
      isOldBusinessObjectInDocument in interface Maintainable

    • getBusinessObjectDictionaryService

      protected BusinessObjectDictionaryService getBusinessObjectDictionaryService()
      Deprecated.

    • getPersonService

      protected org.kuali.rice.kim.api.identity.PersonService getPersonService()
      Deprecated.

    • getBusinessObjectMetaDataService

      @Deprecated protected BusinessObjectMetaDataService getBusinessObjectMetaDataService()
      Deprecated.

    • getBusinessObjectAuthorizationService

      protected BusinessObjectAuthorizationService getBusinessObjectAuthorizationService()
      Deprecated.

    • getDocumentHelperService

      protected DocumentHelperService getDocumentHelperService()
      Deprecated.

    • setBusinessObjectDictionaryService

      public void setBusinessObjectDictionaryService(BusinessObjectDictionaryService businessObjectDictionaryService)
      Deprecated.

    • setPersonService

      public void setPersonService(org.kuali.rice.kim.api.identity.PersonService personService)
      Deprecated.

    • setBusinessObjectMetaDataService

      @Deprecated public void setBusinessObjectMetaDataService(BusinessObjectMetaDataService businessObjectMetaDataService)
      Deprecated.

    • setBusinessObjectAuthorizationService

      public void setBusinessObjectAuthorizationService(BusinessObjectAuthorizationService businessObjectAuthorizationService)
      Deprecated.

    • setDocumentHelperService

      public void setDocumentHelperService(DocumentHelperService documentHelperService)
      Deprecated.

    • getMaintenanceDocumentDictionaryService

      public MaintenanceDocumentDictionaryService getMaintenanceDocumentDictionaryService()
      Deprecated.

    • setMaintenanceDocumentDictionaryService

      public void setMaintenanceDocumentDictionaryService(MaintenanceDocumentDictionaryService maintenanceDocumentDictionaryService)
      Deprecated.

    • getDataObjectMetaDataService

      @Deprecated protected DataObjectMetaDataService getDataObjectMetaDataService()
      Deprecated.

    • setDataObjectMetaDataService

      @Deprecated public void setDataObjectMetaDataService(DataObjectMetaDataService dataObjectMetaDataService)
      Deprecated.

    • getPersistenceStructureService

      public PersistenceStructureService getPersistenceStructureService()
      Deprecated.