View Javadoc
1   /*
2    * Licensed to The Apereo Foundation under one or more contributor license
3    * agreements. See the NOTICE file distributed with this work for additional
4    * information regarding copyright ownership.
5    *
6    *
7    * The Apereo Foundation licenses this file to you under the Educational
8    * Community License, Version 2.0 (the "License"); you may not use this file
9    * except in compliance with the License. You may obtain a copy of the License
10   * at:
11   *
12   *   http://opensource.org/licenses/ecl2.txt
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
16   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
17   * License for the specific language governing permissions and limitations under
18   * the License.
19   *
20   */
21  
22  package org.opencastproject.workflow.api;
23  
24  import java.util.Collections;
25  import java.util.HashMap;
26  import java.util.Map;
27  
28  /** Product type of a workflow definition and its parameters. */
29  public class ConfiguredWorkflow {
30    private final WorkflowDefinition workflowDefinition;
31    private final Map<String, String> parameters;
32  
33    private static final Map<String, String> noparams = Collections.unmodifiableMap(new HashMap<String, String>());
34  
35    /** Constructor. */
36    public ConfiguredWorkflow(WorkflowDefinition workflowDefinition, Map<String, String> parameters) {
37      this.workflowDefinition = workflowDefinition;
38      this.parameters = parameters;
39    }
40  
41    /** Create a workflow with parameters. */
42    public static ConfiguredWorkflow workflow(WorkflowDefinition workflowDefinition, Map<String, String> parameters) {
43      return new ConfiguredWorkflow(workflowDefinition, parameters);
44    }
45  
46    /** Create a parameterless workflow. */
47    public static ConfiguredWorkflow workflow(WorkflowDefinition workflowDefinition) {
48      return new ConfiguredWorkflow(workflowDefinition, noparams);
49    }
50  
51    /** Get the workflow definition. */
52    public WorkflowDefinition getWorkflowDefinition() {
53      return workflowDefinition;
54    }
55  
56    /** Get the workflow's parameter map. */
57    public Map<String, String> getParameters() {
58      return parameters;
59    }
60  }