edu.internet2.middleware.grouper.grouperUi.beans.ui.GrouperTemplateLogicBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of grouper-ui Show documentation
Internet2 Groups Management User Interface
The newest version!
package edu.internet2.middleware.grouper.grouperUi.beans.ui;

import java.util.List;

/**
 * 
 */
public abstract class GrouperTemplateLogicBase {

  /**
   * logic to init the screen
   */
  public void initScreen() {
    
  }
  
  /**
   * 
   */
  private GroupStemTemplateContainer groupStemTemplateContainer;
  
  /**
   * @return the stemTemplateContainer
   */
  public GroupStemTemplateContainer getStemTemplateContainer() {
    return this.groupStemTemplateContainer;
  }
  
  /**
   * @param stemTemplateContainer1 the templateContainer to set
   */
  public void setStemTemplateContainer(GroupStemTemplateContainer stemTemplateContainer1) {
    this.groupStemTemplateContainer = stemTemplateContainer1;
  }

  /**
   * stem id user is working on
   */
  private String stemId;
  
  /**
   * stem id user is working on
   * @return
   */
  public String getStemId() {
    return stemId;
  }

  /**
   * stem id user is working on
   * @param stemId
   */
  public void setStemId(String stemId) {
    this.stemId = stemId;
  }

  /**
   * Should user be asked for key, friendly name and description?
   * @return
   */
  public boolean isPromptForKeyAndLabelAndDescription() {
    return true;
  }
  
  
  /**
   *
   * @param selectedServiceActions - list of service actions selected by user on the UI
   */
  public boolean validate(List selectedServiceActions) {

    for (ServiceAction serviceAction: selectedServiceActions) {
      
      ServiceAction temp = new ServiceAction();
      temp.setId(serviceAction.getId());
      temp.setParentServiceAction(serviceAction.getParentServiceAction());
      
      // for each selected service action, go through the hierarchy upwards and make sure everything is selected.
      while (temp.getParentServiceAction() != null) {
         if (!selectedServiceActions.contains(temp.getParentServiceAction())) {
           return false;
         }
         ServiceAction tempTemp = temp.getParentServiceAction();
         temp = new ServiceAction();
         temp.setId(tempTemp.getId());
         temp.setParentServiceAction(tempTemp.getParentServiceAction());
      }
      
    }
    
    return true;
  }
  
  /**
   * create new service action
   * @param defaulChecked
   * @param indentLevel
   * @param externalizedKey
   * @param type
   * @param args
   * @param parentServiceAction
   * @return action
   */
  protected final ServiceAction createNewServiceAction(String id, boolean defaulChecked, int indentLevel, 
      String externalizedKey, ServiceActionType type, List args,
      ServiceAction parentServiceAction) {
  
    ServiceAction serviceAction = new ServiceAction();
    serviceAction.setService(this);
    serviceAction.setDefaultChecked(defaulChecked);
    serviceAction.setIndentLevel(indentLevel);
    serviceAction.setExternalizedKey(externalizedKey);
    serviceAction.setServiceActionType(type);
    serviceAction.getArgs().addAll(args);
    serviceAction.setParentServiceAction(parentServiceAction);
    serviceAction.setId(id);
    
    return serviceAction;
  }
  
  /**
   * list of service actions to show on the UI
   * @return list of service actions
   */
  public abstract List getServiceActions();
  
  /**
   * label to show
   * @return select label
   */
  public abstract String getSelectLabelKey();
  
  /**
   * override this method if there is extra logic to run in the template
   * @param selectedServiceActions
   * @return the text lookup key for error or null if none
   */
  public String postCreateSelectedActions(List selectedServiceActions) {
    return null;
  }
  
}