01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/entity/tags/sakai_2-4-1/entity-api/api/src/java/org/sakaiproject/entity/api/EntityTransferrer.java $
03: * $Id: EntityTransferrer.java 7915 2006-04-18 18:25:01Z ggolden@umich.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.entity.api;
21:
22: import java.util.List;
23:
24: /**
25: * <p>
26: * Services which implement EntityTransferrer declare themselves as willing and able to transfer/copy their entities from one context to another.
27: * </p>
28: */
29: public interface EntityTransferrer {
30: /**
31: * transfer a copy of Entites from the source context into the destination context
32: *
33: * @param fromContext
34: * The source context
35: * @param toContext
36: * The destination context
37: * @param ids
38: * when null, all entities will be imported; otherwise, only entities with those ids will be imported
39: */
40: void transferCopyEntities(String fromContext, String toContext,
41: List ids);
42:
43: /**
44: * Provide the string array of tool ids, for tools that we claim as manipulating our entities.
45: *
46: * @return
47: */
48: String[] myToolIds();
49: }
|