/*
 *
 * Copyright (C) 2007-2015 Licensed to the Comunes Association (CA) under
 * one or more contributor license agreements (see COPYRIGHT for details).
 * The CA licenses this file to you under the GNU Affero General Public
 * License version 3, (the "License"); you may not use this file except in
 * compliance with the License. This file is part of kune.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package cc.kune.core.client.actions;

import cc.kune.common.client.actions.AbstractExtendedAction;
import cc.kune.core.shared.dto.AccessRolDTO;

import com.google.inject.Inject;

/**
 * The Class RolAction.
 */
public abstract class RolAction extends AbstractExtendedAction {

  /** The auth need. */
  private final boolean authNeed;

  /** The higher rol. */
  private AccessRolDTO higherRol;

  /** The rol required. */
  private final AccessRolDTO rolRequired;

  /**
   * Instantiates a new rol action.
   * 
   * @param rolRequired
   *          the rol required to allow this action
   * @param higherRol
   *          the higher rol to allo this action
   * @param authNeed
   *          if we need to be authenticated to execute this action
   */
  public RolAction(final AccessRolDTO rolRequired, final AccessRolDTO higherRol, final boolean authNeed) {
    this.rolRequired = rolRequired;
    this.higherRol = higherRol;
    this.authNeed = authNeed;
  }

  /**
   * Instantiates a new rol action.
   * 
   * @param rolRequired
   *          the Rol required to allow this action
   * @param authNeed
   *          if we need to be authenticated to execute this action
   */
  @Inject
  public RolAction(final AccessRolDTO rolRequired, final boolean authNeed) {
    this.rolRequired = rolRequired;
    this.authNeed = authNeed;
  }

  /**
   * Gets the higher rol.
   * 
   * @return the higher rol
   */
  public AccessRolDTO getHigherRol() {
    return higherRol;
  }

  /**
   * Gets the rol required.
   * 
   * @return the rol required
   */
  public AccessRolDTO getRolRequired() {
    return rolRequired;
  }

  /**
   * Checks if is auth need.
   * 
   * @return true, if is auth need
   */
  public boolean isAuthNeed() {
    return authNeed;
  }

  /**
   * When used, sets the maximum rol to allow this action, this is useful to
   * allow actions only for viewers and/or editors, but not for admins, for
   * instance.
   * 
   * @param higherRol
   *          the new higher rol
   */
  public void setHigherRol(final AccessRolDTO higherRol) {
    this.higherRol = higherRol;
  }

}