Replace deprecated DOM.setElementAttribute().
[online-glom:gwt-glom.git] / src / main / java / org / glom / web / client / OnlineGlomServiceAsync.java
1 /*
2  * Copyright (C) 2011 Openismus GmbH
3  *
4  * This file is part of GWT-Glom.
5  *
6  * GWT-Glom is free software: you can redistribute it and/or modify it
7  * under the terms of the GNU Lesser General Public License as published by the
8  * Free Software Foundation, either version 3 of the License, or (at your
9  * option) any later version.
10  *
11  * GWT-Glom is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
14  * for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public License
17  * along with GWT-Glom.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 package org.glom.web.client;
21
22 import java.util.ArrayList;
23
24 import org.glom.web.shared.DataItem;
25 import org.glom.web.shared.DetailsLayoutAndData;
26 import org.glom.web.shared.DocumentInfo;
27 import org.glom.web.shared.Documents;
28 import org.glom.web.shared.NavigationRecord;
29 import org.glom.web.shared.Reports;
30 import org.glom.web.shared.TypedDataItem;
31 import org.glom.web.shared.libglom.layout.LayoutGroup;
32 import org.glom.web.shared.libglom.layout.LayoutItemPortal;
33
34 import com.google.gwt.core.client.GWT;
35 import com.google.gwt.user.client.rpc.AsyncCallback;
36
37 public interface OnlineGlomServiceAsync {
38
39         /**
40          * Utility class to get the RPC Async interface from client-side code
41          */
42         public static final class Util {
43                 private static OnlineGlomServiceAsync instance;
44
45                 public static final OnlineGlomServiceAsync getInstance() {
46                         if (instance == null) {
47                                 instance = (OnlineGlomServiceAsync) GWT.create(OnlineGlomService.class);
48                         }
49                         return instance;
50                 }
51
52                 private Util() {
53                         // Utility class should not be instantiated
54                 }
55         }
56
57         void getConfigurationErrorMessage(AsyncCallback<String> callback);
58
59         void getDetailsData(String documentID, String tableName, TypedDataItem primaryKeyValue,
60                         AsyncCallback<DataItem[]> callback);
61
62         void getDetailsLayoutAndData(String documentID, String tableName, TypedDataItem primaryKeyValue, String localeID,
63                         AsyncCallback<DetailsLayoutAndData> callback);
64
65         void getDocumentInfo(String documentID, String localeID, AsyncCallback<DocumentInfo> callback);
66
67         void getDocuments(AsyncCallback<Documents> callback);
68
69         void getListViewData(String documentID, String tableName, String quickFind, int start, int length,
70                         int sortColumnIndex, boolean isAscending, AsyncCallback<ArrayList<DataItem[]>> callback);
71
72         void getListViewLayout(String documentID, String tableName, final String localeID,
73                         AsyncCallback<LayoutGroup> callback);
74
75         void getRelatedListData(String documentID, String tableName, LayoutItemPortal portal,
76                         TypedDataItem foreignKeyValue, int start, int length, int sortColumnIndex, boolean ascending,
77                         AsyncCallback<ArrayList<DataItem[]>> callback);
78
79         void getRelatedListRowCount(String documentID, String tableName, LayoutItemPortal portal,
80                         TypedDataItem foreignKeyValue, AsyncCallback<Integer> callback);
81
82         void getReportHTML(String documentID, String tableName, String reportName, String quickFind, String localeID,
83                         AsyncCallback<String> callback);
84
85         void getReportsList(String documentID, String tableName, String localeID, AsyncCallback<Reports> callback);
86
87         void getSuitableRecordToViewDetails(String documentID, String tableName, LayoutItemPortal portal,
88                         TypedDataItem primaryKeyValue, AsyncCallback<NavigationRecord> callback);
89 }