01: package org.contineo.core.doxter;
02:
03: import java.io.InputStream;
04:
05: /**
06: * Created on 17.08.2004
07: *
08: * @author Michael Scholz
09: */
10: public interface Storer {
11: /**
12: * This method has to store a document and if wanted to make a backup of
13: * this document. The location where (DBMS, Filesystem, other) the document
14: * should be stored is defined by the concret implementation. It is possible
15: * to store a new document or a new version of an existing document.
16: *
17: * @param stream
18: * Document as InputStream
19: * @param menupath
20: * Path in contineo containing the menuIds of all parent items.
21: * @param filename
22: * Name of the document.
23: * @param version
24: * Version of the document.
25: * @return Result of the storing process.
26: */
27: boolean store(InputStream stream, String menupath, String filename,
28: String version);
29:
30: /**
31: * Deletes a document from the documentpool and the backuppool.
32: *
33: * @param menupath
34: * Path in contineo containing the menuIds of all parent items.
35: * @return Result of the deleting process.
36: */
37: boolean delete(String menupath);
38:
39: /**
40: * This method regenerates the document repository from the backup.
41: *
42: * @return Result of the restoring process.
43: */
44: boolean restoreAll();
45: } // end interface Storer
|