Coverage Report

Coverage Report - org.kuali.student.common.infc.Type

Classes in this File

 /*
  * Copyright 2011 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may
  * not use this file except in compliance with the License. You may obtain a copy of the License at
  * http://www.osedu.org/licenses/ECL-2.0 Unless required by applicable law or agreed to in writing, software distributed
  * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  * implied. See the License for the specific language governing permissions and limitations under the License.
  */
 package org.kuali.student.common.infc;
 
 
 /**
  * Detailed Information about a Type
  *
  * Types are used in Kuali Student to further refine the entity in question.
  * For example: An organization type may be a "Department" or a "College" or
  * a "Student Group" or a "Thesis Committee".
  * 
  * Most of validation of the the fields on the entity should be based on a combination of type and state.
  *
  * @author Kuali Student Team (Kamal)
  *
  */
 public interface Type extends HasKey, HasAttributes, HasEffectiveDates {
 
     /**
      * Name: Name
      *
      * Friendly name of the Type
      */
     public String getName();
 
     /**
      * Name: Description
      *
      * Narrative description of the type
      */
     public String getDescr();        
         
     /**
      * Name: Reference Object URI
      *
      * The Object URI to which the Type belongs.
      * E.g http://stduent.kuali.org/LuService/CluInfo will be the objectTypeURI for type 'kuali.lu.type.CreditCourse'
      * The refObjectURI has three parts:<ol>
      * <li>http://stduent.kuali.org/ -- which is fixed
      * <li>LuService -- which should match the namespace of the service in which the object is defined
      * <li>CluInfo -- which should match the java class's simple name
      * </ol>
      */
     public String getRefObjectURI();
     
 }

1		/*
2		* Copyright 2011 The Kuali Foundation Licensed under the Educational Community License, Version 2.0 (the "License"); you may
3		* not use this file except in compliance with the License. You may obtain a copy of the License at
4		* http://www.osedu.org/licenses/ECL-2.0 Unless required by applicable law or agreed to in writing, software distributed
5		* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
6		* implied. See the License for the specific language governing permissions and limitations under the License.
7		*/
8		package org.kuali.student.common.infc;
9
10
11		/**
12		* Detailed Information about a Type
13		*
14		* Types are used in Kuali Student to further refine the entity in question.
15		* For example: An organization type may be a "Department" or a "College" or
16		* a "Student Group" or a "Thesis Committee".
17		*
18		* Most of validation of the the fields on the entity should be based on a combination of type and state.
19		*
20		* @author Kuali Student Team (Kamal)
21		*
22		*/
23		public interface Type extends HasKey, HasAttributes, HasEffectiveDates {
24
25		/**
26		* Name: Name
27		*
28		* Friendly name of the Type
29		*/
30		public String getName();
31
32		/**
33		* Name: Description
34		*
35		* Narrative description of the type
36		*/
37		public String getDescr();
38
39		/**
40		* Name: Reference Object URI
41		*
42		* The Object URI to which the Type belongs.
43		* E.g http://stduent.kuali.org/LuService/CluInfo will be the objectTypeURI for type 'kuali.lu.type.CreditCourse'
44		* The refObjectURI has three parts:<ol>
45		* <li>http://stduent.kuali.org/ -- which is fixed
46		* <li>LuService -- which should match the namespace of the service in which the object is defined
47		* <li>CluInfo -- which should match the java class's simple name
48		* </ol>
49		*/
50		public String getRefObjectURI();
51
52		}