01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/archive/tags/sakai_2-4-1/import-api/src/java/org/sakaiproject/importer/api/ImportService.java $
03: * $Id: ImportService.java 17726 2006-11-01 15:39:28Z lance@indiana.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 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.importer.api;
21:
22: import java.util.Collection;
23:
24: /**
25: * The ImportService provides a top level framework to handled import data collected from
26: * a content package or other archive.
27: *
28: */
29: public interface ImportService {
30:
31: /**
32: * Check the validity of the file data passed.
33: *
34: * @param archiveFileData is a byte array of data gathered from an archive file or package.
35: * @return true if file data is valid.
36: */
37: boolean isValidArchive(byte[] archiveFileData);
38:
39: /**
40: * Parse the archive file data and create an Import Data Source object containing the results.
41: *
42: * @param archiveFileData is a byte array of data gathered from an archive file or package.
43: * @return ImportDataSource containing parsing results.
44: */
45: ImportDataSource parseFromFile(byte[] archiveFileData);
46:
47: /**
48: * doImportItems
49: *
50: * @param importable a collection of things to import (?)
51: * @param siteId is the the id of the site to import to.
52: */
53: void doImportItems(Collection importables, String siteId);
54:
55: }
|