1 /*
2 * *************************************************************************************************************************************************************
3 *
4 * blueHour: open source accounting
5 * http://tidalwave.it/projects/bluehour
6 *
7 * Copyright (C) 2013 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
8 *
9 * *************************************************************************************************************************************************************
10 *
11 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12 * You may obtain a copy of the License at
13 *
14 * http://www.apache.org/licenses/LICENSE-2.0
15 *
16 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18 *
19 * *************************************************************************************************************************************************************
20 *
21 * git clone https://bitbucket.org/tidalwave/bluehour-src
22 * git clone https://github.com/tidalwave-it/bluehour-src
23 *
24 * *************************************************************************************************************************************************************
25 */
26 package it.tidalwave.accounting.importer.ibiz;
27
28 import javax.annotation.Nonnull;
29 import javax.annotation.concurrent.Immutable;
30 import java.io.IOException;
31 import java.nio.file.Path;
32 import it.tidalwave.accounting.importer.ibiz.impl.DefaultIBizImporter;
33 import it.tidalwave.accounting.model.Accounting;
34 import lombok.AllArgsConstructor;
35 import lombok.Getter;
36 import lombok.ToString;
37 import lombok.With;
38
39 /***************************************************************************************************************************************************************
40 *
41 * An object capable to import data from iBiz.
42 *
43 * @author Fabrizio Giudici
44 *
45 **************************************************************************************************************************************************************/
46 public interface IBizImporter extends Accounting
47 {
48 /***********************************************************************************************************************************************************
49 *
50 **********************************************************************************************************************************************************/
51 @AllArgsConstructor // FIXME (access = PRIVATE)
52 @Immutable @With @Getter @ToString
53 public static class Builder
54 {
55 private final Path path;
56
57 @Nonnull
58 public IBizImporter create()
59 {
60 return new DefaultIBizImporter(this);
61 }
62 }
63
64 /***********************************************************************************************************************************************************
65 * Runs a full import round.
66 *
67 * @throws IOException in case of error
68 **********************************************************************************************************************************************************/
69 public void importAll()
70 throws IOException;
71 }