Coverage Report - org.kuali.student.r2.core.organization.infc.OrgTree
 
Classes in this File Line Coverage Branch Coverage Complexity
OrgTree
N/A
N/A
1
 
 1  
 /*
 2  
  * Copyright 2010 The Kuali Foundation 
 3  
  *
 4  
  * Licensed under the Educational Community License, Version 2.0 (the
 5  
  * "License"); you may not use this file except in compliance with the
 6  
  * License. You may obtain a copy of the License at
 7  
  *
 8  
  * http://www.osedu.org/licenses/ECL-2.0
 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
 13  
  * implied. See the License for the specific language governing
 14  
  * permissions and limitations under the License.
 15  
  */
 16  
 
 17  
 /*
 18  
  * OrgTreeInfo is not defined in the service contract. This is currently
 19  
  * an implementation-specific class.
 20  
  */
 21  
 
 22  
 package org.kuali.student.r2.core.organization.infc;
 23  
 
 24  
 /**
 25  
  * This is used to retrieve a flattened organization hierarchy from a
 26  
  * reference organization node down a specified number of levels.
 27  
  *
 28  
  * @author tom
 29  
  */
 30  
 public interface OrgTree {
 31  
 
 32  
     /**
 33  
      * Gets the display name for this tree.
 34  
      *
 35  
      * @name Display Name
 36  
      * @required
 37  
      * @readOnly
 38  
      */   
 39  
     public String getDisplayName();
 40  
 
 41  
     /**
 42  
      * Gets the Id of the Organization Hierarchy.
 43  
      *
 44  
      * @name Org Hierarchy Id
 45  
      * @required
 46  
      * @readOnly
 47  
      */   
 48  
     public String getOrgHierarchyId();
 49  
 
 50  
     /**
 51  
      * Gets the Id of the reference or starting Organization node in
 52  
      * this tree.
 53  
      *
 54  
      * @name Org Id
 55  
      * @required
 56  
      * @readOnly
 57  
      */   
 58  
     public String getOrgId();
 59  
 
 60  
     /**
 61  
      * Gets the Id of the parent to the Organization node.
 62  
      *
 63  
      * @name Parent Id
 64  
      * @readOnly
 65  
      */   
 66  
     public String getParentId();
 67  
 
 68  
     /**
 69  
      * Gets the total number of positions in this organization
 70  
      * (assuming).
 71  
      *
 72  
      * @name Positions
 73  
      * @required
 74  
      * @readOnly
 75  
      */               
 76  
     public Long getPositions();
 77  
 
 78  
     /**
 79  
      * Gets the Id of the current position (for person?). 
 80  
      *
 81  
      * @name Position Id
 82  
      * @readOnly
 83  
      */   
 84  
     public String getPositionId();
 85  
 
 86  
     /**
 87  
      * Gets the Id of the person at the current position.
 88  
      *
 89  
      * @name Person Id
 90  
      * @readOnly
 91  
      */       
 92  
     public String getPersonId();
 93  
 
 94  
     /**
 95  
      * Gets the type key of the relation. (or person relation???)
 96  
      *
 97  
      * @name Relation Type Key
 98  
      * @readOnly
 99  
      */           
 100  
     public String getRelationTypeKey();
 101  
 }