View Javadoc

1   /*
2    * Copyright 2011 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   */
15  
16  package org.kuali.student.r2.lum.clu.infc;
17  
18  import org.kuali.student.r2.common.infc.HasEffectiveDates;
19  import org.kuali.student.r2.common.infc.IdEntity;
20  
21  import java.util.List;
22  
23  /**
24   * Tree representation of clu sets
25   *
26   * @Version 2.0
27   * @Author Sri komandur@uw.edu
28   */
29  public interface CluSetTreeView extends IdEntity, HasEffectiveDates {
30  
31      /**
32       * Information about an organization acting in administrative capacity for a
33       * learning unit.The Organization responsible for this cluset
34       *
35       * @name Admin Org
36       */
37      public String getAdminOrg();
38  
39      /**
40       * Flags if the Clu Set is reusable or was created for one time use for e.g.
41       * in ReqComponentInfo
42       *
43       * @name Is Reusable
44       */
45      public Boolean getIsReusable();
46  
47      /**
48       * Flags set to true if CluSet can be referenced by ReqComponents and other
49       * entities. If set to false, then the CluSet can be referenced only by
50       * other CluSets.
51       *
52       * @name Is Referenceable
53       */
54      public Boolean getIsReferenceable();
55  
56      /**
57       * List of of directly contained CLU Sets. Present for enumerated CLU Sets.
58       *
59       * @name Clu Sets
60       */
61      public List<? extends CluSetTreeView> getCluSets();
62  
63      /**
64       * List of directly contained CLUs. Present for enumerated CLU Sets.
65       *
66       * @name Clus
67       */
68      public List<? extends Clu> getClus();
69  
70  }