1 /*
2 * Copyright 2007-2009 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.service;
17
18 import org.kuali.rice.kim.bo.entity.dto.KimEntityDefaultInfo;
19
20 /**
21 *
22 * This service archives KimEntityDefaultInfo. It's purpose is to provide long term
23 * storage for basic entity data that may be removed from the IdentityService implementation's
24 * backing store.
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 *
28 */
29 public interface IdentityArchiveService {
30
31 /**
32 * Gets the KimEntityDefaultInfo from the cache for the given entityId.
33 */
34 KimEntityDefaultInfo getEntityDefaultInfoFromArchive( String entityId );
35
36 /**
37 * Gets the KimEntityDefaultInfo from the cache for the entity with the given principalId.
38 */
39 KimEntityDefaultInfo getEntityDefaultInfoFromArchiveByPrincipalId( String principalId );
40
41 /**
42 * Gets the KimEntityDefaultInfo from the cache for the entity with the given principalName.
43 */
44 KimEntityDefaultInfo getEntityDefaultInfoFromArchiveByPrincipalName( String principalName );
45
46 /**
47 * Saves the given KimEntityDefaultInfo into the cache.
48 */
49 void saveDefaultInfoToArchive( KimEntityDefaultInfo entity );
50
51 }