Coverage Report

Coverage Report - org.kuali.rice.kim.bo.entity.KimEntity

Classes in this File

 /*
  * Copyright 2007-2008 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.opensource.org/licenses/ecl2.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.rice.kim.bo.entity;
 
 import java.util.List;
 
 import org.kuali.rice.kns.bo.Inactivateable;
 
 
 /**
  * Represents an Entity (person/vendor/system) within the Rice system. 
  * 
  * @author Kuali Rice Team (rice.collab@kuali.org)
  *
  */
 public interface KimEntity extends Inactivateable {
         
     /**
      * Gets this {@link KimEntity}'s entity id.
      * @return the id for this {@link KimEntity}, or null if none has been assigned.
      */
         String getEntityId();
         
         /**
          * Gets this {@link KimEntity}'s entity types
          * @return the List of {@link KimEntityEntityType}S for this {@link KimEntity}.
          * The returned List will never be null, an empty List will be assigned and returned if needed. 
          */
         List<? extends KimEntityEntityType> getEntityTypes();
         
     /**
      * Gets this {@link KimEntity}'s principals
      * @return the List of {@link KimPrincipal}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
      */
         List<? extends KimPrincipal> getPrincipals();
         
     /**
      * Gets this {@link KimEntity}'s external identifiers
      * @return the List of {@link KimEntityExternalIdentifier}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
      */
         List<? extends KimEntityExternalIdentifier> getExternalIdentifiers();
 
     /**
      * Gets this {@link KimEntity}'s affiliations
      * @return the List of {@link KimEntityAffiliation}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
      */
         List<? extends KimEntityAffiliation> getAffiliations();
 
         /**
          * Gets this {@link KimEntity}'s names
          * @return the List of {@link KimEntityName}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
          */
         List<? extends KimEntityName> getNames();
         
         
     /**
      * Gets this {@link KimEntity}'s employment information List
      * @return the List of {@link KimEntityEmploymentInformation}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
      */
         List<? extends KimEntityEmploymentInformation> getEmploymentInformation();
 
     /**
      * Gets this {@link KimEntity}'s privacy preferences
      * @return the {@link KimEntityPrivacyPreferences} for this {@link KimEntity}, 
      * or null if none has been assigned.
      */        
         KimEntityPrivacyPreferences getPrivacyPreferences();
         
         /**
          * Gets this {@link KimEntity}'s demographic information
          * @return the {@link KimEntityBioDemographics} for this {@link KimEntity}, 
          * or null if none has been assigned.
          */
         KimEntityBioDemographics getBioDemographics();
         
     /**
      * Gets this {@link KimEntity}'s citizenship information
      * @return the List of {@link KimEntityCitizenship}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
      */
         List<? extends KimEntityCitizenship> getCitizenships();
         
         /**
          * Gets this {@link KimEntity}'s entity type for the given type code
          * @param entityTypeCode the type code
          * @return the EntityEntityType object corresponding to the given code or null if this
          * entity does not have data for that type.
          */
         KimEntityEntityType getEntityType( String entityTypeCode );
         
         /**
          * Gets this {@link KimEntity}'s employment information
          * @return the primary {@link KimEntityEmploymentInformation} for this {@link KimEntity}, 
          * or null if none has been assigned.
          */
         KimEntityEmploymentInformation getPrimaryEmployment();
 
         /**
          * Gets this {@link KimEntity}'s default affiliation
      * @return the default {@link KimEntityAffiliation} for the entity.  If no default is defined, then
      * it returns the first one found.  If none are defined, it returns null.
      */
         KimEntityAffiliation getDefaultAffiliation();
         
         /**
          * Gets this {@link KimEntity}'s external identifier for the given type code
          * @param externalIdentifierTypeCode the type code
      * @return the {@link KimEntityExternalIdentifier} for this {@link KimEntity}, or null if none has been assigned.
      */
         KimEntityExternalIdentifier getEntityExternalIdentifier( String externalIdentifierTypeCode );
         
         /** 
          * Gets this {@link KimEntity}'s default name
          * @return the default {@link KimEntityName} record for the entity.  If no default is defined, then
          * it returns the first one found.  If none are defined, it returns null.
          */
         KimEntityName getDefaultName();
 
     /**
      * Gets this {@link KimEntity}'s ethnicities
      * @return the List of {@link KimEntityEthnicity}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
      */
         public List<? extends KimEntityEthnicity> getEthnicities();
 
     /**
      * Gets this {@link KimEntity}'s residencies
      * @return the List of {@link KimEntityResidency}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
      */
         public List<? extends KimEntityResidency> getResidencies();
 
     /**
      * Gets this {@link KimEntity}'s visas
      * @return the List of {@link KimEntityVisa}S for this {@link KimEntity}.
      * The returned List will never be null, an empty List will be assigned and returned if needed. 
      */
         public List<? extends KimEntityVisa> getVisas();
 
 }

1		/*
2		* Copyright 2007-2008 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		package org.kuali.rice.kim.bo.entity;
17
18		import java.util.List;
19
20		import org.kuali.rice.kns.bo.Inactivateable;
21
22
23		/**
24		* Represents an Entity (person/vendor/system) within the Rice system.
25		*
26		* @author Kuali Rice Team (rice.collab@kuali.org)
27		*
28		*/
29		public interface KimEntity extends Inactivateable {
30
31		/**
32		* Gets this {@link KimEntity}'s entity id.
33		* @return the id for this {@link KimEntity}, or null if none has been assigned.
34		*/
35		String getEntityId();
36
37		/**
38		* Gets this {@link KimEntity}'s entity types
39		* @return the List of {@link KimEntityEntityType}S for this {@link KimEntity}.
40		* The returned List will never be null, an empty List will be assigned and returned if needed.
41		*/
42		List<? extends KimEntityEntityType> getEntityTypes();
43
44		/**
45		* Gets this {@link KimEntity}'s principals
46		* @return the List of {@link KimPrincipal}S for this {@link KimEntity}.
47		* The returned List will never be null, an empty List will be assigned and returned if needed.
48		*/
49		List<? extends KimPrincipal> getPrincipals();
50
51		/**
52		* Gets this {@link KimEntity}'s external identifiers
53		* @return the List of {@link KimEntityExternalIdentifier}S for this {@link KimEntity}.
54		* The returned List will never be null, an empty List will be assigned and returned if needed.
55		*/
56		List<? extends KimEntityExternalIdentifier> getExternalIdentifiers();
57
58		/**
59		* Gets this {@link KimEntity}'s affiliations
60		* @return the List of {@link KimEntityAffiliation}S for this {@link KimEntity}.
61		* The returned List will never be null, an empty List will be assigned and returned if needed.
62		*/
63		List<? extends KimEntityAffiliation> getAffiliations();
64
65		/**
66		* Gets this {@link KimEntity}'s names
67		* @return the List of {@link KimEntityName}S for this {@link KimEntity}.
68		* The returned List will never be null, an empty List will be assigned and returned if needed.
69		*/
70		List<? extends KimEntityName> getNames();
71
72
73		/**
74		* Gets this {@link KimEntity}'s employment information List
75		* @return the List of {@link KimEntityEmploymentInformation}S for this {@link KimEntity}.
76		* The returned List will never be null, an empty List will be assigned and returned if needed.
77		*/
78		List<? extends KimEntityEmploymentInformation> getEmploymentInformation();
79
80		/**
81		* Gets this {@link KimEntity}'s privacy preferences
82		* @return the {@link KimEntityPrivacyPreferences} for this {@link KimEntity},
83		* or null if none has been assigned.
84		*/
85		KimEntityPrivacyPreferences getPrivacyPreferences();
86
87		/**
88		* Gets this {@link KimEntity}'s demographic information
89		* @return the {@link KimEntityBioDemographics} for this {@link KimEntity},
90		* or null if none has been assigned.
91		*/
92		KimEntityBioDemographics getBioDemographics();
93
94		/**
95		* Gets this {@link KimEntity}'s citizenship information
96		* @return the List of {@link KimEntityCitizenship}S for this {@link KimEntity}.
97		* The returned List will never be null, an empty List will be assigned and returned if needed.
98		*/
99		List<? extends KimEntityCitizenship> getCitizenships();
100
101		/**
102		* Gets this {@link KimEntity}'s entity type for the given type code
103		* @param entityTypeCode the type code
104		* @return the EntityEntityType object corresponding to the given code or null if this
105		* entity does not have data for that type.
106		*/
107		KimEntityEntityType getEntityType( String entityTypeCode );
108
109		/**
110		* Gets this {@link KimEntity}'s employment information
111		* @return the primary {@link KimEntityEmploymentInformation} for this {@link KimEntity},
112		* or null if none has been assigned.
113		*/
114		KimEntityEmploymentInformation getPrimaryEmployment();
115
116		/**
117		* Gets this {@link KimEntity}'s default affiliation
118		* @return the default {@link KimEntityAffiliation} for the entity. If no default is defined, then
119		* it returns the first one found. If none are defined, it returns null.
120		*/
121		KimEntityAffiliation getDefaultAffiliation();
122
123		/**
124		* Gets this {@link KimEntity}'s external identifier for the given type code
125		* @param externalIdentifierTypeCode the type code
126		* @return the {@link KimEntityExternalIdentifier} for this {@link KimEntity}, or null if none has been assigned.
127		*/
128		KimEntityExternalIdentifier getEntityExternalIdentifier( String externalIdentifierTypeCode );
129
130		/**
131		* Gets this {@link KimEntity}'s default name
132		* @return the default {@link KimEntityName} record for the entity. If no default is defined, then
133		* it returns the first one found. If none are defined, it returns null.
134		*/
135		KimEntityName getDefaultName();
136
137		/**
138		* Gets this {@link KimEntity}'s ethnicities
139		* @return the List of {@link KimEntityEthnicity}S for this {@link KimEntity}.
140		* The returned List will never be null, an empty List will be assigned and returned if needed.
141		*/
142		public List<? extends KimEntityEthnicity> getEthnicities();
143
144		/**
145		* Gets this {@link KimEntity}'s residencies
146		* @return the List of {@link KimEntityResidency}S for this {@link KimEntity}.
147		* The returned List will never be null, an empty List will be assigned and returned if needed.
148		*/
149		public List<? extends KimEntityResidency> getResidencies();
150
151		/**
152		* Gets this {@link KimEntity}'s visas
153		* @return the List of {@link KimEntityVisa}S for this {@link KimEntity}.
154		* The returned List will never be null, an empty List will be assigned and returned if needed.
155		*/
156		public List<? extends KimEntityVisa> getVisas();
157
158		}