ACLTransition.java

/**
 * Licensed to The Apereo Foundation under one or more contributor license
 * agreements. See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 *
 * The Apereo Foundation licenses this file to you 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://opensource.org/licenses/ecl2.txt
 *
 * 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.opencastproject.authorization.xacml.manager.api;

import org.opencastproject.util.data.Option;
import org.opencastproject.workflow.api.ConfiguredWorkflowRef;

import java.util.Date;

/** Definition of a transition from one ACL to another. */
public interface ACLTransition {
  /**
   * Return the transition identifier.
   *
   * @return the transition identifier
   */
  long getTransitionId();

  /**
   * Return the organization identifier.
   *
   * @return the organization identifier
   */
  String getOrganizationId();

  /**
   * Return the date when the contained ACL will be applied.
   *
   * @return the date of application
   */
  Date getApplicationDate();

  /**
   * Return the workflow id and its parameters.
   *
   * @return the workflow definition identifier to start after application
   */
  Option<ConfiguredWorkflowRef> getWorkflow();

  /**
   * Returns <code>true</code> if the transition has already been applied.
   *
   * @return <code>true</code> if the transition has already been applied.
   */
  boolean isDone();
}