/**

  * Copyright 2010 The Kuali Foundation Licensed under the

  * Educational Community License, Version 2.0 (the "License"); you may

  * not use this file except in compliance with the License. You may

  * obtain a copy of the License at

  *

  * http://www.osedu.org/licenses/ECL-2.0

  *

  * Unless required by applicable law or agreed to in writing,

  * software distributed under the License is distributed on an "AS IS"

  * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

  * or implied. See the License for the specific language governing

  * permissions and limitations under the License.

  */

 package org.kuali.student.lum.lu.ui.course.client.controllers;

 import java.text.DateFormat;

 import java.util.ArrayList;

 import java.util.Date;

 import java.util.HashMap;

 import java.util.List;

 import java.util.Map;

 import org.kuali.student.common.assembly.data.Data;

 import org.kuali.student.common.assembly.data.Metadata;

 import org.kuali.student.common.assembly.data.QueryPath;

 import org.kuali.student.common.rice.StudentIdentityConstants;

 import org.kuali.student.common.rice.authorization.PermissionType;

 import org.kuali.student.common.ui.client.application.Application;

 import org.kuali.student.common.ui.client.application.KSAsyncCallback;

 import org.kuali.student.common.ui.client.application.ViewContext;

 import org.kuali.student.common.ui.client.configurable.mvc.layouts.MenuEditableSectionController;

 import org.kuali.student.common.ui.client.configurable.mvc.sections.Section;

 import org.kuali.student.common.ui.client.configurable.mvc.views.SectionView;

 import org.kuali.student.common.ui.client.event.ActionEvent;

 import org.kuali.student.common.ui.client.event.ContentDirtyEvent;

 import org.kuali.student.common.ui.client.event.ContentDirtyEventHandler;

 import org.kuali.student.common.ui.client.event.SaveActionEvent;

 import org.kuali.student.common.ui.client.event.SaveActionHandler;

 import org.kuali.student.common.ui.client.mvc.ActionCompleteCallback;

 import org.kuali.student.common.ui.client.mvc.Callback;

 import org.kuali.student.common.ui.client.mvc.Controller;

 import org.kuali.student.common.ui.client.mvc.DataModel;

 import org.kuali.student.common.ui.client.mvc.DataModelDefinition;

 import org.kuali.student.common.ui.client.mvc.HasCrossConstraints;

 import org.kuali.student.common.ui.client.mvc.ModelProvider;

 import org.kuali.student.common.ui.client.mvc.ModelRequestCallback;

 import org.kuali.student.common.ui.client.mvc.View;

 import org.kuali.student.common.ui.client.mvc.WorkQueue;

 import org.kuali.student.common.ui.client.mvc.WorkQueue.WorkItem;

 import org.kuali.student.common.ui.client.mvc.dto.ReferenceModel;

 import org.kuali.student.common.ui.client.mvc.history.HistoryManager;

 import org.kuali.student.common.ui.client.security.AuthorizationCallback;

 import org.kuali.student.common.ui.client.security.RequiresAuthorization;

 import org.kuali.student.common.ui.client.service.DataSaveResult;

 import org.kuali.student.common.ui.client.util.WindowTitleUtils;

 import org.kuali.student.common.ui.client.widgets.KSButton;

 import org.kuali.student.common.ui.client.widgets.KSButtonAbstract.ButtonStyle;

 import org.kuali.student.common.ui.client.widgets.buttongroups.ButtonEnumerations.YesNoCancelEnum;

 import org.kuali.student.common.ui.client.widgets.dialog.ButtonMessageDialog;

 import org.kuali.student.common.ui.client.widgets.field.layout.button.ButtonGroup;

 import org.kuali.student.common.ui.client.widgets.field.layout.button.YesNoCancelGroup;

 import org.kuali.student.common.ui.client.widgets.notification.KSNotification;

 import org.kuali.student.common.ui.client.widgets.notification.KSNotifier;

 import org.kuali.student.common.ui.client.widgets.progress.BlockingTask;

 import org.kuali.student.common.ui.client.widgets.progress.KSBlockingProgressIndicator;

 import org.kuali.student.common.ui.shared.IdAttributes;

 import org.kuali.student.common.ui.shared.IdAttributes.IdType;

 import org.kuali.student.common.validation.dto.ValidationResultInfo;

 import org.kuali.student.core.statement.dto.StatementTypeInfo;

 import org.kuali.student.core.workflow.ui.client.widgets.WorkflowEnhancedNavController;

 import org.kuali.student.core.workflow.ui.client.widgets.WorkflowUtilities;

 import org.kuali.student.lum.common.client.helpers.RecentlyViewedHelper;

 import org.kuali.student.lum.common.client.widgets.AppLocations;

 import org.kuali.student.lum.lu.ui.course.client.configuration.CourseConfigurer;

 import org.kuali.student.lum.lu.ui.course.client.requirements.CourseRequirementsDataModel;

 import org.kuali.student.lum.lu.ui.course.client.requirements.HasRequirements;

 import org.kuali.student.lum.lu.ui.course.client.service.CourseRpcService;

 import org.kuali.student.lum.lu.ui.course.client.service.CourseRpcServiceAsync;

 import org.kuali.student.lum.lu.ui.course.client.service.CreditCourseProposalRpcService;

 import org.kuali.student.lum.lu.ui.course.client.service.CreditCourseProposalRpcServiceAsync;

 import com.google.gwt.core.client.GWT;

 import com.google.gwt.event.dom.client.ClickEvent;

 import com.google.gwt.event.dom.client.ClickHandler;

 import com.google.gwt.user.client.Window;

 import com.google.gwt.user.client.rpc.AsyncCallback;

 /**

  * Controller for course proposal screens.  This controller controls all functions of the course proposal process

  * and contains the data model and is responsible for retrieving its data and metadata from the server. In

  * addition, this controller is responsible for course proposal save events and updating its ui accordingly.

  * 

  *

  * @author Kuali Student Team

  *

  */

 public class CourseProposalController extends MenuEditableSectionController implements RequiresAuthorization, WorkflowEnhancedNavController, HasRequirements {

         //RPC Services

         CreditCourseProposalRpcServiceAsync cluProposalRpcServiceAsync = GWT.create(CreditCourseProposalRpcService.class);

         CourseRpcServiceAsync courseServiceAsync = GWT.create(CourseRpcService.class);

         //Models

         private final DataModel cluProposalModel = new DataModel("Proposal");

         private final DataModel comparisonModel = new DataModel("Original Course");

         CourseConfigurer cfg = GWT.create(CourseConfigurer.class);

         private WorkQueue modelRequestQueue;

     private WorkflowUtilities workflowUtil;

         private boolean initialized = false;

         private boolean isNew = false;

         private static final String UPDATED_KEY = "metaInfo/updateTime";

         private static final String VERSION_KEY  = "versionInfo/versionedFromId";

         private static final String MODIFY_TYPE = "kuali.proposal.type.course.modify";

         public static final String CREATE_TYPE = "kuali.proposal.type.course.create";

         public static final String INITIAL_SAVE_VERSION = "1";

         private String currentDocType = CREATE_TYPE;

         private String proposalPath = "";

         private String currentTitle;

         private final DateFormat df = DateFormat.getInstance();

         private final BlockingTask initializingTask = new BlockingTask("Loading");

         private final BlockingTask loadDataTask = new BlockingTask("Retrieving Data");

         private final BlockingTask saving = new BlockingTask("Saving");

     final CourseRequirementsDataModel reqDataModel;

     public CourseProposalController(){

         super();

         reqDataModel = new CourseRequirementsDataModel(this);

         initialize();

         addStyleName("courseProposal");

     }

     @Override

     public void setViewContext(ViewContext viewContext) {

             super.setViewContext(viewContext);

             if(viewContext.getId() != null && !viewContext.getId().isEmpty()){

                     if(viewContext.getIdType() != IdType.COPY_OF_OBJECT_ID){

                             viewContext.setPermissionType(PermissionType.OPEN);

                     }

                     else{

                             //they are trying to make a modification

                             viewContext.setPermissionType(PermissionType.INITIATE);

                     }

             }

             else{

                     viewContext.setPermissionType(PermissionType.INITIATE);

             }

     }

     private void initialize() {

             //TODO get from messages

                    proposalPath = cfg.getProposalPath();

                    workflowUtil = new WorkflowUtilities(CourseProposalController.this ,proposalPath);

                    super.setDefaultModelId(cfg.getModelId());

         super.registerModel(cfg.getModelId(), new ModelProvider<DataModel>() {

             @Override

             public void requestModel(final ModelRequestCallback<DataModel> callback) {

                 if (modelRequestQueue == null){

                     modelRequestQueue = new WorkQueue();

                 }

                 WorkItem workItem = new WorkItem(){

                     @Override

                     public void exec(Callback<Boolean> workCompleteCallback) {

                         if (cluProposalModel.getRoot() == null || initialized == false){

                             initModel(callback, workCompleteCallback);

                         } else {

                             callback.onModelReady(cluProposalModel);

                             workCompleteCallback.exec(true);

                         }

                     }

                 };

                 modelRequestQueue.submit(workItem);

             }

         });

         super.registerModel("ComparisonModel", new ModelProvider<DataModel>() {

             @Override

             public void requestModel(final ModelRequestCallback<DataModel> callback) {

                     if(comparisonModel.getRoot() != null && comparisonModel.getRoot().size() != 0){

                             callback.onModelReady(comparisonModel);

                     }

                     else{

                             callback.onModelReady(null);

                     }

             }

         });

         super.addApplicationEventHandler(ContentDirtyEvent.TYPE, new ContentDirtyEventHandler(){

                         public void onContentDirty(ContentDirtyEvent event) {

                         setContentWarning("You have unsaved changes");                                

                         }                

         });

         addApplicationEventHandler(SaveActionEvent.TYPE, new SaveActionHandler(){

             public void doSave(SaveActionEvent saveAction) {

                 GWT.log("CluProposalController received save action request.", null);

                 doSaveAction(saveAction);

             }

         });

     }

     private void initModel(final ModelRequestCallback<DataModel> callback, Callback<Boolean> workCompleteCallback){

             if(getViewContext().getIdType() == IdType.DOCUMENT_ID){

             getCluProposalFromWorkflowId(callback, workCompleteCallback);

         } else if (getViewContext().getIdType() == IdType.KS_KEW_OBJECT_ID){

             getCluProposalFromProposalId(getViewContext().getId(), callback, workCompleteCallback);

         } else if (getViewContext().getIdType() == IdType.COPY_OF_OBJECT_ID){

             createModifyCluProposalModel("versionComment", callback, workCompleteCallback);

         } else{

             createNewCluProposalModel(callback, workCompleteCallback);

         }

     }

     private void getCurrentModel(final ModelRequestCallback<DataModel> callback, Callback<Boolean> workCompleteCallback){

             if (cluProposalModel.getRoot() != null && cluProposalModel.getRoot().size() > 0){

                 String id = cluProposalModel.get(cfg.getProposalPath()+"/id");

                 if(id != null){

                         getCluProposalFromProposalId(id, callback, workCompleteCallback);

                 }

                 else{

                         initModel(callback, workCompleteCallback);

                 }

             }

             else{

                     initModel(callback, workCompleteCallback);

             }

     }

     private void init(final Callback<Boolean> onReadyCallback) {

             if (initialized) {

                     onReadyCallback.exec(true);

             } else {

                     initialized = true;

                     KSBlockingProgressIndicator.addTask(initializingTask);

                     setContentWarning("");

             this.requestModel(new ModelRequestCallback<DataModel>(){

                                 @Override

                                 public void onModelReady(DataModel model) {

                                         //Setup View Context

                                         String idType = null;

                                     String viewContextId = "";

                                     if(getViewContext().getIdType() != null){

                                 idType = getViewContext().getIdType().toString();

                                 viewContextId = getViewContext().getId();

                                 if(getViewContext().getIdType()==IdAttributes.IdType.COPY_OF_OBJECT_ID){

                                         viewContextId = null;

                                 }

                                     }

                                         HashMap<String, String> idAttributes = new HashMap<String, String>();

                                     if(idType != null){

                                             idAttributes.put(IdAttributes.ID_TYPE, idType);

                                     }

                                     if(cluProposalModel.get(VERSION_KEY) != null && !((String)cluProposalModel.get(VERSION_KEY)).equals("")){

                                             currentDocType = MODIFY_TYPE;

                                     }

                                     idAttributes.put(StudentIdentityConstants.DOCUMENT_TYPE_NAME, currentDocType);

                                     //Get metadata and complete initializing the screen

                                     cluProposalRpcServiceAsync.getMetadata(viewContextId, idAttributes, new KSAsyncCallback<Metadata>(){

                                                 @Override

                         public void handleTimeout(Throwable caught) {

                                         initializeFailed(); 

                                                 }

                                                 @Override

                         public void handleFailure(Throwable caught) {

                                                         initializeFailed();

                                     throw new RuntimeException("Failed to get model definition.", caught);

                                 }

                                                 public void initializeFailed(){

                                                 initialized = false;

                                         onReadyCallback.exec(false);

                                         KSBlockingProgressIndicator.removeTask(initializingTask);                                                        

                                                 }

                                 public void onSuccess(Metadata result) {

                                         DataModelDefinition def = new DataModelDefinition(result);

                                     cluProposalModel.setDefinition(def);

                                     comparisonModel.setDefinition(def);

                                     configureScreens(def, onReadyCallback);

                                 }

                                   });

                                 }

                                 @Override

                                 public void onRequestFail(Throwable cause) {

                                         GWT.log("Failed to get modeld for proposal controller init");

                                         onReadyCallback.exec(false);

                                 }

                         });

             }

     }

     private void configureScreens(final DataModelDefinition modelDefinition, final Callback<Boolean> onReadyCallback){

         workflowUtil.requestAndSetupModel();

         CourseRequirementsDataModel.getStatementTypes(new Callback<List<StatementTypeInfo>>() {

             @Override

             public void exec(List<StatementTypeInfo> stmtTypes) {

                 List<StatementTypeInfo> stmtTypesOut = new ArrayList<StatementTypeInfo>();

                 if (stmtTypes != null) {

                     for (StatementTypeInfo stmtType : stmtTypes) {

                         if (stmtType.getId().contains("kuali.statement.type.course.enrollmentEligibility") ||

                             stmtType.getId().contains("kuali.statement.type.course.creditConstraints")) {

                             continue;

                         }

                         stmtTypesOut.add(stmtType);

                     }

                 }

                 cfg.setStatementTypes(stmtTypesOut);

                 cfg.setModelDefinition(modelDefinition);

                 cfg.configure(CourseProposalController.this);

                 //Update any cross fields

                 for(HasCrossConstraints crossConstraint:Application.getApplicationContext().getCrossConstraints(null)){

                         crossConstraint.reprocessWithUpdatedConstraints();

                 }

                 onReadyCallback.exec(true);

                 KSBlockingProgressIndicator.removeTask(initializingTask);

             }

         });

     }

     @Override

     @SuppressWarnings("unchecked")

     public void requestModel(Class modelType, final ModelRequestCallback callback) {

         if(modelType == ReferenceModel.class){

                 if (cluProposalModel != null){

                         ReferenceModel ref = new ReferenceModel();

                         if(cluProposalModel.get(cfg.getProposalPath()) != null){

                             ref.setReferenceId((String)cluProposalModel.get(cfg.getProposalPath()+"/id"));

                         } else {

                                 ref.setReferenceId(null);

                         }

                         //Use the referenceAttribute to store misc data from the parent model like reference name, etc

                         if(cluProposalModel.get(cfg.getProposalPath()) != null){

                                 Map<String, String> attributes = new HashMap<String, String>();

                                 attributes.put("name", (String)cluProposalModel.get(cfg.getProposalPath()+"/name"));

                                 ref.setReferenceAttributes(attributes);

                         } else {

                                 ref.setReferenceAttributes(null);

                         }

                         ref.setReferenceTypeKey(cfg.getProposalReferenceTypeKey());

                         ref.setReferenceType(cfg.getProposalReferenceObjectType());

                         ref.setReferenceState(getViewContext().getState());

                         callback.onModelReady(ref);

                 }

         } else if (modelType == Data.class){

                 requestModel(cfg.getModelId(), callback);

         } else {

             super.requestModel(modelType, callback);

         }

     }

     @SuppressWarnings("unchecked")

     private void getCluProposalFromWorkflowId(final ModelRequestCallback callback, final Callback<Boolean> workCompleteCallback){

         KSBlockingProgressIndicator.addTask(loadDataTask);

         workflowUtil.getDataIdFromWorkflowId(getViewContext().getId(), new KSAsyncCallback<String>(){

                         @Override

                         public void handleFailure(Throwable caught) {

                 Window.alert("Error loading Proposal from Workflow Document: "+caught.getMessage());

                 createNewCluProposalModel(callback, workCompleteCallback);

                 KSBlockingProgressIndicator.removeTask(loadDataTask);

                         }

                         @Override

                         public void onSuccess(String proposalId) {

                                 KSBlockingProgressIndicator.removeTask(loadDataTask);

                                 getCluProposalFromProposalId(proposalId, callback, workCompleteCallback);

                         }

         });

     }

     @SuppressWarnings("unchecked")

     private void getCluProposalFromProposalId(String id, final ModelRequestCallback callback, final Callback<Boolean> workCompleteCallback){

             KSBlockingProgressIndicator.addTask(loadDataTask);

             cluProposalRpcServiceAsync.getData(id, new KSAsyncCallback<Data>(){

                         @Override

                         public void handleFailure(Throwable caught) {

                 Window.alert("Error loading Proposal: "+caught.getMessage());

                 createNewCluProposalModel(callback, workCompleteCallback);

                 KSBlockingProgressIndicator.removeTask(loadDataTask);

                         }

                         @Override

                         public void onSuccess(Data result) {

                                 cluProposalModel.setRoot(result);

                         setProposalHeaderTitle();

                         setLastUpdated();

                 reqDataModel.retrieveStatementTypes(cluProposalModel.<String>get("id"), new Callback<Boolean>() {

                     @Override

                     public void exec(Boolean result) {

                        if(result){

                           getCourseComparisonModel(callback, workCompleteCallback);

                        }

                     }

                 });

                         }

             });

     }

     @SuppressWarnings("unchecked")

         private void getCourseComparisonModel(final ModelRequestCallback proposalModelRequestCallback, final Callback<Boolean> workCompleteCallback){

                 if(cluProposalModel.get(VERSION_KEY) != null && !((String)cluProposalModel.get(VERSION_KEY)).equals("")){

                         courseServiceAsync.getData((String)cluProposalModel.get(VERSION_KEY), new KSAsyncCallback<Data>(){

                             @Override

                     public void handleFailure(Throwable caught) {

                         Window.alert("Error loading Proposal: "+caught.getMessage());

                         createNewCluProposalModel(proposalModelRequestCallback, workCompleteCallback);

                         KSBlockingProgressIndicator.removeTask(loadDataTask);

                     }

                 @Override

                 public void onSuccess(Data result) {

                     if (result != null) {

                         comparisonModel.setRoot(result);

                     }

                     proposalModelRequestCallback.onModelReady(cluProposalModel);

                     workCompleteCallback.exec(true);

                     reqDataModel.retrieveStatementTypes(cluProposalModel.<String>get("id"), new Callback<Boolean>() {

                         @Override

                         public void exec(Boolean result) {

                             if (result) {

                                 //getCourseComparisonModel(proposalModelRequestCallback, workCompleteCallback);

                                 KSBlockingProgressIndicator.removeTask(loadDataTask);

                             }

                         }

                     });

                 }

             });

         } else {

             proposalModelRequestCallback.onModelReady(cluProposalModel);

             workCompleteCallback.exec(true);

             KSBlockingProgressIndicator.removeTask(loadDataTask);

         }

     }

     @SuppressWarnings("unchecked")

     private void createNewCluProposalModel(final ModelRequestCallback callback, final Callback<Boolean> workCompleteCallback){

         cluProposalModel.setRoot(new Data());

         isNew = true;

         setProposalHeaderTitle();

         setLastUpdated();

         callback.onModelReady(cluProposalModel);

         workCompleteCallback.exec(true);

     }

     @SuppressWarnings("unchecked")

     private void createModifyCluProposalModel(String versionComment, final ModelRequestCallback callback, final Callback<Boolean> workCompleteCallback){

         Data data = new Data();

         Data proposalData = new Data();

         proposalData.set(new Data.StringKey("type"), MODIFY_TYPE);

         data.set(new Data.StringKey("proposal"), proposalData);

         Data versionData = new Data();

         versionData.set(new Data.StringKey("versionIndId"), getViewContext().getId());

         versionData.set(new Data.StringKey("versionComment"), versionComment);

         data.set(new Data.StringKey("versionInfo"), versionData);

         cluProposalModel.setRoot(data);

         cluProposalRpcServiceAsync.saveData(cluProposalModel.getRoot(), new AsyncCallback<DataSaveResult>() {

                         public void onSuccess(DataSaveResult result) {

                                 cluProposalModel.setRoot(result.getValue());

                                 setProposalHeaderTitle();

                         setLastUpdated();

                         //add to recently viewed now that we know the id of proposal

                         ViewContext docContext = new ViewContext();

                         docContext.setId((String) cluProposalModel.get(cfg.getProposalPath()+"/id"));

                         docContext.setIdType(IdType.KS_KEW_OBJECT_ID);

                         RecentlyViewedHelper.addDocument(getProposalTitle(), 

                                         HistoryManager.appendContext(AppLocations.Locations.COURSE_PROPOSAL.getLocation(), docContext)

                                         + "/SUMMARY");

                         getCourseComparisonModel(callback, workCompleteCallback);

                         // We need to update the current view context so that if the user clicks the back button it doesn't 

                         // create a duplicate course proposal. 

                         getViewContext().setIdType(docContext.getIdType());

                         getViewContext().setId(docContext.getId());

                         }

                         public void onFailure(Throwable caught) {

                 Window.alert("Error loading Proposal: "+caught.getMessage());

                 createNewCluProposalModel(callback, workCompleteCallback);

                 KSBlockingProgressIndicator.removeTask(loadDataTask);

                         }

                 });

     }

     public void doSaveAction(final SaveActionEvent saveActionEvent){

         requestModel(new ModelRequestCallback<DataModel>() {

             @Override

             public void onModelReady(DataModel model) {

                 CourseProposalController.this.updateModelFromCurrentView();

                 if (isStartViewShowing()){

                         //This call required so fields in start section, which also appear in

                         //other sections don't get overridden from updateModel call above.

                         getStartPopupView().updateModel();

                 }

                     model.validate(new Callback<List<ValidationResultInfo>>() {

                     @Override

                     public void exec(List<ValidationResultInfo> result) {

                             boolean isSectionValid = isValid(result, true);

                             if(isSectionValid){

                             if (startSectionRequired()){

                                 showStartPopup(NO_OP_CALLBACK);

                                 saveActionEvent.doActionComplete();

                             }

                             else{

                                     saveProposalClu(saveActionEvent);

                             }

                             }

                             else{

                                     //saveActionEvent.doActionComplete();

                                     KSNotifier.add(new KSNotification("Unable to save, please check fields for errors.", false, true, 5000));

                             }

                     }

                 });

             }

             @Override

             public void onRequestFail(Throwable cause) {

                     saveActionEvent.doActionComplete();

                 GWT.log("Unable to retrieve model for validation and save", cause);

             }

         });

     }

     public boolean startSectionRequired(){

         String proposalId = cluProposalModel.get(cfg.getProposalPath()+"/id");

         //Defaulting the proposalTitle to courseTitle, this way course data gets set and assembler doesn't

         //complain. This may not be the correct approach.

         String proposalTitle = cluProposalModel.get(cfg.getProposalTitlePath());

         String courseTitle = cluProposalModel.get(cfg.getCourseTitlePath());

         if (proposalTitle == null || proposalTitle.isEmpty()){

             cluProposalModel.set(QueryPath.parse(cfg.getProposalTitlePath()), courseTitle);

         }

             return proposalId==null && !CourseProposalController.this.isStartViewShowing() && !hasTitles(proposalTitle, courseTitle);

     }

     private boolean hasTitles(String proposalTitle, String courseTitle){

             return (proposalTitle != null && !proposalTitle.isEmpty()) && (courseTitle != null && !courseTitle.isEmpty());

     }

     public void saveProposalClu(final SaveActionEvent saveActionEvent){

             KSBlockingProgressIndicator.addTask(saving);

         final Callback<Throwable> saveFailedCallback = new Callback<Throwable>() {

                         @Override

                         public void exec(Throwable caught) {

                                  GWT.log("Save Failed.", caught);

                                  KSBlockingProgressIndicator.removeTask(saving);

                  KSNotifier.add(new KSNotification("Save Failed on server. Please try again.", false, true, 5000));

                         }

         };

         try {

             cluProposalRpcServiceAsync.saveData(cluProposalModel.getRoot(), new KSAsyncCallback<DataSaveResult>(){

                 @Override

                 public void handleFailure(Throwable caught) {

                    saveFailedCallback.exec(caught);

                 }

                 public void onSuccess(DataSaveResult result) {

                         KSBlockingProgressIndicator.removeTask(saving);

                         if(result.getValidationResults()!=null && !result.getValidationResults().isEmpty()){

                                 isValid(result.getValidationResults(), false, true);

                             saveActionEvent.setGotoNextView(false);

                         saveActionEvent.doActionComplete();

                         KSNotifier.add(new KSNotification("Save Failed. There were validation errors.", false, 5000));

                         }else{

                                 saveActionEvent.setSaveSuccessful(true);

                                 cluProposalModel.setRoot(result.getValue());

                                 String title = getProposalTitle();

                                 View currentView = getCurrentView();

                                             if (currentView instanceof SectionView){

                                                     ((SectionView)currentView).updateView(cluProposalModel);

                                                     ((SectionView) currentView).resetDirtyFlags();

                                 }

                             saveActionEvent.doActionComplete();

                                             ViewContext context = CourseProposalController.this.getViewContext();

                                             context.setId((String)cluProposalModel.get(proposalPath+"/id"));

                                             context.setIdType(IdType.KS_KEW_OBJECT_ID);

                                             //Ensure workflow doc status gets updated from draft, only done on intial save

                                             //to reduce workflow rpc calls.

                                             String proposalVersion = cluProposalModel.get(proposalPath+"/metaInfo/versionInd");

                                             if (INITIAL_SAVE_VERSION.equals(proposalVersion)){

                                                     workflowUtil.refresh();

                                             }

                                             setProposalHeaderTitle();

                                             setLastUpdated();

                                             HistoryManager.logHistoryChange();

                                 if(isNew){

                                         RecentlyViewedHelper.addCurrentDocument(title);

                                 }

                                 else if(!currentTitle.equals(title)){

                                         RecentlyViewedHelper.updateTitle(currentTitle, title, (String)cluProposalModel.get(proposalPath+"/id"));

                                 }

                                 isNew = false;

                                             if(saveActionEvent.gotoNextView()){

                                                     CourseProposalController.this.showNextViewOnMenu();

                                             }

                                             KSNotifier.add(new KSNotification("Save Successful", false, 4000));

                         }

                 }

             });

         } catch (Exception e) {

                 saveFailedCallback.exec(e);

         }

     }

     public void setLastUpdated(){

             Date lastUpdated = (Date)cluProposalModel.get(UPDATED_KEY);

             if(lastUpdated != null){

                     setContentInfo("Last Updated: " + df.format(lastUpdated));

             }

             else{

                     setContentInfo("");

             }

     }

     @Override

         public void beforeShow(final Callback<Boolean> onReadyCallback){

             Application.getApplicationContext().clearCrossConstraintMap(null);

             Application.getApplicationContext().clearPathToFieldMapping(null);

             Application.getApplicationContext().setParentPath("");

             init(onReadyCallback);

         }

    @Override

    public void showDefaultView(Callback<Boolean> onReadyCallback) {

            if(isNew){

                    super.showFirstView(onReadyCallback);

            }

            else{

                    super.showDefaultView(onReadyCallback);

            }

    }

         @Override

     public void setParentController(Controller controller) {

         super.setParentController(controller);

     }

         @Override

         public void checkAuthorization(final PermissionType permissionType, final AuthorizationCallback authCallback) {

                 Map<String,String> attributes = new HashMap<String,String>();

 //                if (StringUtils.isNotBlank(getViewContext().getId())) {

                 GWT.log("Attempting Auth Check.", null);

                 if ( (getViewContext().getId() != null) && (!"".equals(getViewContext().getId())) ) {

                         attributes.put(getViewContext().getIdType().toString(), getViewContext().getId());

                 }

                 cluProposalRpcServiceAsync.isAuthorized(permissionType, attributes, new KSAsyncCallback<Boolean>(){

                         @Override

                         public void handleFailure(Throwable caught) {

                                 authCallback.isNotAuthorized("Error checking authorization.");

                                 GWT.log("Error checking proposal authorization.", caught);

                 Window.alert("Error Checking Proposal Authorization: "+caught.getMessage());

                         }

                         @Override

                         public void onSuccess(Boolean result) {

                                 GWT.log("Succeeded checking auth for permission type '" + permissionType + "' with result: " + result, null);

                                 if (Boolean.TRUE.equals(result)) {

                                         authCallback.isAuthorized();

                                 }

                                 else {

                                         authCallback.isNotAuthorized("User is not authorized: " + permissionType);

                                 }

                         }

             });

         }

         @Override

         public boolean isAuthorizationRequired() {

                 return true;

         }

         @Override

         public void setAuthorizationRequired(boolean required) {

                 throw new UnsupportedOperationException();

         }

     protected void setProposalHeaderTitle(){

             String title;

             if (cluProposalModel.get(cfg.getProposalTitlePath()) != null){

                     title = getProposalTitle();

             }

             else{

                     title = "New Course (Proposal)";

             }

             this.setContentTitle(title);

             this.setName(title);

             WindowTitleUtils.setContextTitle(title);

                 currentTitle = title;

     }

         @Override

         public WorkflowUtilities getWfUtilities() {

                 return workflowUtil;

         }

         @Override

         public void beforeViewChange(Enum<?> viewChangingTo, final Callback<Boolean> okToChange) {

                 //We do this check here because theoretically the subcontroller views

                 //will display their own messages to the user to give them a reason why the view

                 //change has been cancelled, otherwise continue to check for reasons not to change

                 //with this controller

                 super.beforeViewChange(viewChangingTo, new Callback<Boolean>(){

                         @Override

                         public void exec(Boolean result) {

                                 if(result){

                                         if(getCurrentView() instanceof SectionView && ((SectionView)getCurrentView()).isDirty()){

                                                 ButtonGroup<YesNoCancelEnum> buttonGroup = new YesNoCancelGroup();

                                                 final ButtonMessageDialog<YesNoCancelEnum> dialog = new ButtonMessageDialog<YesNoCancelEnum>("Warning", "You may have unsaved changes.  Save changes?", buttonGroup);

                                                 buttonGroup.addCallback(new Callback<YesNoCancelEnum>(){

                                                         @Override

                                                         public void exec(YesNoCancelEnum result) {

                                                                 switch(result){

                                                                         case YES:

                                                                                 dialog.hide();

                                                                                 final SaveActionEvent e = new SaveActionEvent();

                                                                                 e.setActionCompleteCallback(new ActionCompleteCallback(){

                                                                                         @Override

                                                                                         public void onActionComplete(ActionEvent action) {

                                                                                                 if(e.isSaveSuccessful()){

                                                                                                         okToChange.exec(true);

                                                                                                 }

                                                                                                 else{

                                                                                                         okToChange.exec(false);

                                                                                                 }

                                                                                         }

                                                                                 });

                                                                                 fireApplicationEvent(e);

                                                                                 break;

                                                                         case NO:

                                                                                 //Force a model request from server

                                                                                 getCurrentModel(new ModelRequestCallback<DataModel>(){

                                                                                         @Override

                                                                                         public void onModelReady(DataModel model) {

                                                                                                 if (getCurrentView()instanceof Section){

                                                                                                     ((Section) getCurrentView()).resetFieldInteractionFlags();

                                                                                                 }

                                                                                                 okToChange.exec(true);

                                                                                                 dialog.hide();

                                                                                         }

                                                                                         @Override

                                                                                         public void onRequestFail(Throwable cause) {

                                                                                                 //TODO Is this correct... do we want to stop view change if we can't restore the data?  Possibly traps the user

                                                                                                 //if we don't it messes up saves, possibly warn the user that it failed and continue?

                                                                                                 okToChange.exec(false);

                                                                                                 dialog.hide();

                                                                                                 GWT.log("Unable to retrieve model for data restore on view change with no save", cause);

                                                                                         }},

                                                                                         NO_OP_CALLBACK);

                                                                                 break;

                                                                         case CANCEL:

                                                                                 okToChange.exec(false);

                                                                                 dialog.hide();

                                                                                 // Because this event fires after the history change event we need to "undo" the history events. 

                                                                                 HistoryManager.logHistoryChange();  

                                                                                 break;

                                                                 }

                                                         }

                                                 });

                                                 dialog.show();

                                         }

                                         else{

                                                 okToChange.exec(true);

                                         }

                                 }

                                 else{

                                         okToChange.exec(false);

                                 }

                         }

                 });

         }

     public KSButton getSaveButton(){

             if(currentDocType != MODIFY_TYPE){

                 return new KSButton("Save and Continue", new ClickHandler(){

                             public void onClick(ClickEvent event) {

                                     CourseProposalController.this.fireApplicationEvent(new SaveActionEvent(true));

                             }

                         });

             }

             else{

                     return new KSButton("Save", new ClickHandler(){

                 public void onClick(ClickEvent event) {

                     CourseProposalController.this.fireApplicationEvent(new SaveActionEvent(false));

                 }

             });

             }

     }

     public KSButton getCancelButton(final Enum<?> summaryView){

         return new KSButton("Cancel", ButtonStyle.ANCHOR_LARGE_CENTERED, new ClickHandler(){

                     public void onClick(ClickEvent event) {

                             if(!isNew){

                                     CourseProposalController.this.showView(summaryView);

                             }

                             else{

                                     Application.navigate(AppLocations.Locations.CURRICULUM_MANAGEMENT.getLocation());

                             }

                     }

                 });

     }

         @Override

         public void onHistoryEvent(String historyStack) {

                 super.onHistoryEvent(historyStack);

                 //we dont want to add proposals that are brand new before saving, or copy addresses (as they will initiate

                 //the modify/copy logic again if called)

                 if(cluProposalModel.get(cfg.getProposalTitlePath()) != null && 

                                 this.getViewContext().getIdType() != IdType.COPY_OF_OBJECT_ID){

                         RecentlyViewedHelper.addCurrentDocument(getProposalTitle());

                 }

         }

         private String getProposalTitle(){

                 StringBuffer sb = new StringBuffer();

                 sb.append(cluProposalModel.get(cfg.getProposalTitlePath()));

                 sb.append(" (Proposal)");

                 return sb.toString();

         }

     public String getCourseId(){

         return cluProposalModel.<String>get("id");

     }

     public boolean isNew() {

         return isNew;

     }

     public CourseRequirementsDataModel getReqDataModel() {

         return reqDataModel;

     }

 }