View Javadoc

1   /**
2    * Copyright 2005-2012 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.util;
17  
18  import java.util.Collection;
19  
20  import org.kuali.rice.kim.api.identity.entity.Entity;
21  
22  /**
23   *
24   * @author Leo Przybylski (przybyls@arizona.edu)
25   */ 
26  public interface Constants {    
27      Collection<String> getTestPrincipalNames();
28  
29      String getDefaultChartCode();
30  
31      /**
32       * Gets the value of entityPrototype
33       *
34       * @return the value of entityPrototype
35       */
36      Entity getEntityPrototype();
37  
38      /**
39       * Gets the value of externalIdTypeProperty
40       *
41       * @return the value of externalIdTypeProperty
42       */
43      String getExternalIdTypeProperty();
44  
45      /**
46       * Gets the value of taxExternalIdTypeCode
47       *
48       * @return the value of taxExternalIdTypeCode
49       */
50      String getTaxExternalIdTypeCode();
51  
52      /**
53       * Gets the value of externalIdProperty
54       *
55       * @return the value of externalIdProperty
56       */
57      String getExternalIdProperty();
58  
59      /**
60       * Gets the value of employeePhoneLdapProperty
61       *
62       * @return the value of employeePhoneLdapProperty
63       */
64      String getEmployeePhoneLdapProperty();
65  
66      /**
67       * Gets the value of employeeMailLdapProperty
68       *
69       * @return the value of employeeMailLdapProperty
70       */
71      String getEmployeeMailLdapProperty();
72  
73      /**
74       * Gets the value of defaultCountryCode
75       *
76       * @return the value of defaultCountryCode
77       */
78      String getDefaultCountryCode();
79  
80      /**
81       * Gets the value of personEntityTypeCode
82       *
83       * @return the value of personEntityTypeCode
84       */
85      String getPersonEntityTypeCode();
86  
87      /**
88       * Gets the value of uaidLdapProperty
89       *
90       * @return the value of uaidLdapProperty
91       */
92      String getKimLdapIdProperty();
93  
94      /**
95       * Gets the value of uidLdapProperty
96       *
97       * @return the value of uidLdapProperty
98       */
99      String getKimLdapNameProperty();
100 
101     /**
102      * Gets the value of snLdapProperty
103      *
104      * @return the value of snLdapProperty
105      */
106     String getSnLdapProperty();
107 
108     /**
109      * Gets the value of givenNameLdapProperty
110      *
111      * @return the value of givenNameLdapProperty
112      */
113     String getGivenNameLdapProperty();
114 
115     /**
116      * Gets the value of entityIdKimProperty
117      *
118      * @return the value of entityIdKimProperty
119      */
120     String getEntityIdKimProperty();
121 
122     /**
123      * Gets the value of parameterNamespaceCode
124      *
125      * @return the value of parameterNamespaceCode
126      */
127     String getParameterNamespaceCode();
128 
129     /**
130      * Gets the value of parameterDetailTypeCode
131      *
132      * @return the value of parameterDetailTypeCode
133      */
134     String getParameterDetailTypeCode();
135 
136     /**
137      * Gets the value of mappedParameterName
138      *
139      * @return the value of mappedParameterName
140      */
141     String getMappedParameterName();
142 
143     /**
144      * Gets the value of unmappedParameterName
145      *
146      * @return the value of unmappedParameterName
147      */
148     String getUnmappedParameterName();
149 
150     /**
151      * Gets the value of mappedValuesName
152      *
153      * @return the value of mappedValuesName
154      */
155     String getMappedValuesName();
156 
157     /**
158      * Gets the value of employeeIdProperty
159      *
160      * @return the value of employeeIdProperty
161      */
162     String getEmployeeIdProperty();
163 
164     /**
165      * Gets the value of departmentLdapProperty
166      *
167      * @return the value of departmentLdapProperty
168      */
169     String getDepartmentLdapProperty();
170 
171     /**
172      * Gets the value of employeeTypeProperty
173      *
174      * @return the value of employeeTypeProperty
175      */
176     String getEmployeeTypeProperty();
177 
178     /**
179      * Gets the value of employeeStatusProperty
180      *
181      * @return the value of employeeStatusProperty
182      */
183     String getEmployeeStatusProperty();
184 
185     /**
186      * Gets the value of defaultCampusCode
187      *
188      * @return the value of defaultCampusCode
189      */
190     String getDefaultCampusCode();
191         
192     /**
193      * Gets the value of the employee affiliation code
194      * 
195      * @return the value of employeeAffiliationCode
196      */
197     String getEmployeeAffiliationCodes();
198 
199     /** 
200      * Gets the mappings between LDAP and KIM affiliations
201      * @return mappings of the form "staff=STAFF,affiliate=AFLT"
202      */
203     String getAffiliationMappings();
204 
205     /**
206      * Gets the mappings for the affiliation ldap property
207      * @return mapping for KIM affiliation and LDAP
208      */
209     String getAffiliationLdapProperty();
210 
211     /**
212      * Gets the mappings for the primary affiliation ldap property
213      * @return mapping for KIM primary affiliation and LDAP
214      */
215     String getPrimaryAffiliationLdapProperty();
216 }