Coverage Report - org.kuali.rice.kim.api.group.GroupContract
 
Classes in this File Line Coverage Branch Coverage Complexity
GroupContract
N/A
N/A
1
 
 1  
 /*
 2  
  * Copyright 2006-2011 The Kuali Foundation
 3  
  *
 4  
  * Licensed under the Educational Community License, Version 2.0 (the "License");
 5  
  * you may not use this file except in compliance with the License.
 6  
  * You may obtain a copy of the License at
 7  
  *
 8  
  * http://www.opensource.org/licenses/ecl2.php
 9  
  *
 10  
  * Unless required by applicable law or agreed to in writing, software
 11  
  * distributed under the License is distributed on an "AS IS" BASIS,
 12  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 13  
  * See the License for the specific language governing permissions and
 14  
  * limitations under the License.
 15  
  */
 16  
 
 17  
 package org.kuali.rice.kim.api.group;
 18  
 
 19  
 import org.kuali.rice.core.api.mo.GloballyUnique;
 20  
 import org.kuali.rice.core.api.mo.Versioned;
 21  
 import org.kuali.rice.core.api.mo.active.Inactivatable;
 22  
 import org.kuali.rice.core.xml.dto.AttributeSet;
 23  
 import org.kuali.rice.kim.api.person.PersonContract;
 24  
 
 25  
 import java.util.List;
 26  
 import java.util.Set;
 27  
 
 28  
 public interface GroupContract extends Versioned, GloballyUnique, Inactivatable {
 29  
     /**
 30  
      * This is the unique id for the Group.  This cannot be null or a blank string.
 31  
      *
 32  
      * <p>
 33  
      * This is a unique Id assigned to a Group.
 34  
      * </p>
 35  
      *
 36  
      * @return id
 37  
      */
 38  
     String getId();
 39  
 
 40  
     /**
 41  
      * This is the namespace code for the Group.
 42  
      *
 43  
      * <p>
 44  
      * This is a namespace code assigned to a Group.  Together with name, it makes up another unique identifier for Group
 45  
      * </p>
 46  
      *
 47  
      * @return namespaceCode
 48  
      */
 49  
     String getNamespaceCode();
 50  
 
 51  
     /**
 52  
      * This is the name for the Group.
 53  
      *
 54  
      * <p>
 55  
      * This is a name assigned to a Group.  Together with NamespaceCode, it makes up another unique identifier for Group
 56  
      * </p>
 57  
      *
 58  
      * @return name
 59  
      */
 60  
         String getName();
 61  
 
 62  
     /**
 63  
      * This a description for the Group.
 64  
      *
 65  
      * <p>
 66  
      * This is a description assigned to a Group.
 67  
      * </p>
 68  
      *
 69  
      * @return description
 70  
      */
 71  
         String getDescription();
 72  
 
 73  
     /**
 74  
      * This a Kim Type Id for the Group.
 75  
      *
 76  
      * <p>
 77  
      * This links a Kim Type to the Group to allow custom types of Groups.
 78  
      * </p>
 79  
      *
 80  
      * @return description
 81  
      */
 82  
         String getKimTypeId();
 83  
 
 84  
     /**
 85  
      * This a list of the members of the Group.
 86  
      *
 87  
      * <p>
 88  
      * This returns a list of group members
 89  
      * </p>
 90  
      *
 91  
      * @return members
 92  
      */
 93  
     List<? extends GroupMemberContract> getMembers();
 94  
 
 95  
     /*List<? extends PersonContract> getPersonMembers();
 96  
 
 97  
     List<? extends GroupContract> getGroupMembers();*/
 98  
 
 99  
     /**
 100  
      * This is a set of Attributes for a Group.
 101  
      *
 102  
      * <p>
 103  
      * This is a set of attributes which are key-label pairs that are defined by the Group's Kim Type.
 104  
      * </p>
 105  
      *
 106  
      * @return attributes
 107  
      */
 108  
     List<? extends GroupAttributeContract> getAttributes();
 109  
 
 110  
 
 111  
 
 112  
 
 113  
     /**
 114  
      * This is a set of Attributes for a Group.
 115  
      *
 116  
      * <p>
 117  
      * This is a set of attributes which are key-label pairs that are defined by the Group's Kim Type.
 118  
      * </p>
 119  
      *
 120  
      * @return attributes
 121  
      */
 122  
         //AttributeSet getAttributes();
 123  
 
 124  
 }