001/*
002 * Copyright 2011 The Kuali Foundation Licensed under the
003 * Educational Community License, Version 2.0 (the "License"); you may
004 * not use this file except in compliance with the License. You may
005 * obtain a copy of the License at
006 *
007 * http://www.osedu.org/licenses/ECL-2.0
008 *
009 * Unless required by applicable law or agreed to in writing,
010 * software distributed under the License is distributed on an "AS IS"
011 * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
012 * or implied. See the License for the specific language governing
013 * permissions and limitations under the License.
014 */
015
016package org.kuali.student.r2.lum.clu.infc;
017
018import org.kuali.student.r2.common.infc.HasEffectiveDates;
019import org.kuali.student.r2.common.infc.IdEntity;
020
021import java.util.List;
022
023/**
024 * Detailed information about a single CLU Set.
025 *
026 * @Version 2.0
027 * @Author Sri komandur@uw.edu
028 */
029public interface CluSet extends IdEntity, HasEffectiveDates {
030
031    /**
032     * List of identifiers of directly contained CLU Sets. Present for
033     * enumerated CLU Sets.
034     *
035     * @name Clu Set Ids
036     * @readOnly
037     */
038    public List<String> getCluSetIds();
039
040    /**
041     * List of identifiers of directly contained CLUs. Present for enumerated
042     * CLU Sets.
043     *
044     * @name Clu Ids
045     * @readOnly
046     */
047    public List<String> getCluIds();
048
049    /**
050     * Specifies a search for CLU identifiers. Present for dynamic CLU Sets
051     *
052     * @name Membership Query
053     */
054    public MembershipQuery getMembershipQuery();
055
056    /**
057     * Information about an organization acting in administrative capacity for a
058     * learning unit.The Organization responsible for this cluset
059     *
060     * @name Admin Org
061     */
062    public String getAdminOrg();
063
064    /**
065     * Flags if the Clu Set is reusable or was created for one time use for e.g.
066     * in ReqComponentInfo
067     *
068     * @name Is Reusable
069     */
070    public Boolean getIsReusable();
071
072    /**
073     * Flags set to true if CluSet can be referenced by ReqComponets and other
074     * entities. If set to false, then the CluSet can be referenced only by
075     * other CluSets.
076     *
077     * @name Is Referenceable
078     */
079    public Boolean getIsReferenceable();
080
081}