Coverage Report

Coverage Report - org.kuali.student.datadictionary.infc.DictionaryEntry

Classes in this File

 /*
  * Copyright 2011 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 1.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.opensource.org/licenses/ecl1.php
  *
  * 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.datadictionary.infc;
 
 import java.util.List;
 
 /**
  * This is an info ojbect that contains the dictionary information about an
  * object known to the system
  *
  * @author nwright
  */
 public interface DictionaryEntry  {
 
     /**
      * Name: Object Class
      *
      * The class of the object to which this dictionary entry refers
      * @return the objectClass
      */
     public String getObjectClass();
 
     /**
      * Name: Name
      *
      * get Name
      */
     public String getName();
 
     /**
      * Name: Object Label
      *
      * The object label provides a short name of the business
      * object for use on help screens.
      *
      * @param objectLabel The objectLabel to set.
      */
     public String getObjectLabel();
 
     /**
      * Name: Object Description
      *
      * The object description provides a brief description
      * of the business object for use on help screens.
      */
     public String getObjectDescription();
 
     /**
      * Name: Title Attribute
      *
      * The titleAttribute element is the name of the attribute that
      * will be used as an inquiry field when the lookup search results
      * fields are displayed.
      *
      * For some business objects, there is no obvious field to serve
      * as the inquiry field. in that case a special field may be required
      * for inquiry purposes.
      */
     public String getTitleAttribute();
 
     /**
      * Name: Prmary Keys
      *
      * The primary key(s) associatd with the object.
      *
      * TODO: determine how/if this works with the than the "unique" flag on attribute definition
      * TODO: determine how/if this works with the id
      *
      * @return the primaryKeys
      */
     public List<String> getPrimaryKeys();
 
     /**
      * Name: Attribute Defiitions
      *
      * Get the definitions of the attributes (fields) on the object
      */
     public List<? extends AttributeDefinitionInfc> getAttributes();
 }

1		/*
2		* Copyright 2011 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 1.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/ecl1.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		package org.kuali.student.datadictionary.infc;
17
18		import java.util.List;
19
20		/**
21		* This is an info ojbect that contains the dictionary information about an
22		* object known to the system
23		*
24		* @author nwright
25		*/
26		public interface DictionaryEntry {
27
28		/**
29		* Name: Object Class
30		*
31		* The class of the object to which this dictionary entry refers
32		* @return the objectClass
33		*/
34		public String getObjectClass();
35
36		/**
37		* Name: Name
38		*
39		* get Name
40		*/
41		public String getName();
42
43		/**
44		* Name: Object Label
45		*
46		* The object label provides a short name of the business
47		* object for use on help screens.
48		*
49		* @param objectLabel The objectLabel to set.
50		*/
51		public String getObjectLabel();
52
53		/**
54		* Name: Object Description
55		*
56		* The object description provides a brief description
57		* of the business object for use on help screens.
58		*/
59		public String getObjectDescription();
60
61		/**
62		* Name: Title Attribute
63		*
64		* The titleAttribute element is the name of the attribute that
65		* will be used as an inquiry field when the lookup search results
66		* fields are displayed.
67		*
68		* For some business objects, there is no obvious field to serve
69		* as the inquiry field. in that case a special field may be required
70		* for inquiry purposes.
71		*/
72		public String getTitleAttribute();
73
74		/**
75		* Name: Prmary Keys
76		*
77		* The primary key(s) associatd with the object.
78		*
79		* TODO: determine how/if this works with the than the "unique" flag on attribute definition
80		* TODO: determine how/if this works with the id
81		*
82		* @return the primaryKeys
83		*/
84		public List<String> getPrimaryKeys();
85
86		/**
87		* Name: Attribute Defiitions
88		*
89		* Get the definitions of the attributes (fields) on the object
90		*/
91		public List<? extends AttributeDefinitionInfc> getAttributes();
92		}