View Javadoc

1   /**
2    * Copyright 2005-2014 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.api.identity.visa;
17  
18  import org.kuali.rice.core.api.mo.common.GloballyUnique;
19  import org.kuali.rice.core.api.mo.common.Identifiable;
20  import org.kuali.rice.core.api.mo.common.Versioned;
21  
22  /**
23   * visa information for a KIM identity
24   * 
25   * @author Kuali Rice Team (kuali-rice@googlegroups.com)
26   *
27   */
28  public interface EntityVisaContract extends Versioned, GloballyUnique, Identifiable {
29  
30  	/**
31       * Gets this {@link EntityVisaContract}'s identity id.
32       * @return the identity id for this {@link EntityVisaContract}, or null if none has been assigned.
33       */
34  	String getEntityId();
35  	
36  	/**
37       * Gets this {@link EntityVisaContract}'s visa type key.
38       * @return the visa type key for this {@link EntityVisaContract}, or null if none has been assigned.
39       */
40  	String getVisaTypeKey();
41  	
42  	/**
43       * Gets this {@link EntityVisaContract}'s visa entry.
44       * @return the visa entry for this {@link EntityVisaContract}, or null if none has been assigned.
45       */
46  	String getVisaEntry();
47  	
48  	/**
49       * Gets this {@link EntityVisaContract}'s visa id.
50       * @return the visa id for this {@link EntityVisaContract}, or null if none has been assigned.
51       */
52  	String getVisaId();
53  }