com.belladati.sdk

Interface BellaDatiService

All Superinterfaces:

Serializable

public interface BellaDatiService
extends Serializable

A service accessing one specific BellaDati server as an authenticated user.

This instance manages the user's access token obtained during authentication. It uses the BellaDatiConnection used during authentication to access the server.

Service instances may be serialized, saved, and restored for later use. This will instantiate a new HTTP client, but reuse the existing authentication credentials. Use this to save a user's session when closing your application so they don't have to log in again on their next use.

Author:

Chris Hennigfeld

Method Summary

Methods

Modifier and Type	Method and Description
ViewLoader	createViewLoader(String viewId, ViewType viewType) Creates a loader to load the JSON representation of the view with the given ID and type.
CachedList<AttributeValue>	getAttributeValues(String reportId, String attributeCode) Returns the possible values for the attribute with the given code in the report with the specified ID.
PaginatedIdList<DashboardInfo>	getDashboardInfo() Returns a paginated list to access dashboards visible to the current user.
PaginatedIdList<DataSetInfo>	getDataSetInfo() Returns a paginated list to access data sets visible to the current user.
CachedList<DataSourceImport>	getDataSourceImports(String id) Returns the list of import configurations for the data source with the given ID.
CachedList<DataSource>	getDataSources(String id) Returns the list of data sources for the data set with the given ID.
PaginatedList<Comment>	getReportComments(String reportId) Returns a paginated list to access the comments of the report with the given ID.
PaginatedIdList<ReportInfo>	getReportInfo() Returns a paginated list to access reports visible to the current user.
Dashboard	loadDashboard(String id) Loads the dashboard with the specified ID.
Object	loadDashboardThumbnail(String id) Loads a thumbnail image for the dashboard with the given ID.
DataSet	loadDataSet(String id) Loads the data set with the specified ID.
Report	loadReport(String id) Loads the report with the specified ID.
Object	loadReportThumbnail(String id) Loads a thumbnail image for the report with the given ID.
User	loadUser(String userId) Loads the user with the given ID.
Object	loadUserImage(String userId) Loads the profile image of the user with the given ID.
Object	loadViewContent(String viewId, ViewType viewType, Collection<Filter<?>> filters) Loads the JSON representation of the view with the given ID and type.
Object	loadViewContent(String viewId, ViewType viewType, Filter<?>... filters) Loads the content of the view with the given ID and type.
void	postComment(String reportId, String text) Posts a comment to the report with the given ID.
DataSourcePendingImport	setupDataSourceImport(String id, Date date) Sets up a DataSourcePendingImport instance for the data source with the given ID.
void	uploadData(String id, DataTable data) Uploads the given data into this data set.

Method Detail

getDashboardInfo

PaginatedIdList<DashboardInfo> getDashboardInfo()

Returns a paginated list to access dashboards visible to the current user.

Initially, the returned list is empty. Call PaginatedList.load() to load report data.

Returns:

a paginated list to access dashboards visible to the current user

loadDashboard

Dashboard loadDashboard(String id)
                        throws NotFoundException

Loads the dashboard with the specified ID.

This method makes an API call to BellaDati and may take some time to complete.

Parameters:

id - ID of the dashboard to load

Returns:

the dashboard with the specified ID

Throws:

NotFoundException - if the ID wasn't found

loadDashboardThumbnail

Object loadDashboardThumbnail(String id)
                              throws IOException,
                                     NotFoundException

Loads a thumbnail image for the dashboard with the given ID. The Java type of the image being returned depends on the implementation.

Parameters:

id - ID of the dashboard whose thumbnail to load

Returns:

a thumbnail image for the dashboard with the given ID

Throws:

IOException - if no image exists or it cannot be loaded

NotFoundException - if the ID wasn't found

getReportInfo

PaginatedIdList<ReportInfo> getReportInfo()

Returns a paginated list to access reports visible to the current user.

Initially, the returned list is empty. Call PaginatedList.load() to load report data.

Returns:

a paginated list to access reports visible to the current user

loadReport

Report loadReport(String id)
                  throws NotFoundException

Loads the report with the specified ID.

This method makes an API call to BellaDati and may take some time to complete.

Parameters:

id - ID of the report to load

Returns:

the report with the specified ID

Throws:

NotFoundException - if the ID wasn't found

loadReportThumbnail

Object loadReportThumbnail(String id)
                           throws IOException,
                                  NotFoundException

Loads a thumbnail image for the report with the given ID. The Java type of the image being returned depends on the implementation.

Parameters:

id - ID of the report whose thumbnail to load

Returns:

a thumbnail image for the report with the given ID

Throws:

IOException - if no image exists or it cannot be loaded

NotFoundException - if the ID wasn't found

getReportComments

PaginatedList<Comment> getReportComments(String reportId)
                                         throws NotFoundException

Returns a paginated list to access the comments of the report with the given ID.

Initially, the returned list is empty. Call PaginatedList.load() to load report data. Subsequent calls to this method for the same report always return the same list.

Parameters:

reportId - ID of the report whose comments to access

Returns:

a paginated list to access the comments of the report with the given ID

Throws:

NotFoundException - if the ID wasn't found

postComment

void postComment(String reportId,
               String text)
                 throws NotFoundException

Posts a comment to the report with the given ID.

Parameters:

reportId - ID of the report to which to post a comment

text - text of the comment to post

Throws:

NotFoundException - if the ID wasn't found

loadViewContent

Object loadViewContent(String viewId,
                     ViewType viewType,
                     Filter<?>... filters)
                       throws NotFoundException

Loads the content of the view with the given ID and type.

Parameters:

viewId - ID of the view to load

viewType - type of the view to load

filters - optional filters to use when loading the view

Returns:

the content of the view

Throws:

NotFoundException - if the ID wasn't found

loadViewContent

Object loadViewContent(String viewId,
                     ViewType viewType,
                     Collection<Filter<?>> filters)
                       throws NotFoundException

Loads the JSON representation of the view with the given ID and type.

Parameters:

viewId - ID of the view to load

viewType - type of the view to load

filters - filters to use when loading the view

Returns:

the JSON representation of the view

Throws:

NotFoundException - if the ID wasn't found

createViewLoader

ViewLoader createViewLoader(String viewId,
                          ViewType viewType)

Creates a loader to load the JSON representation of the view with the given ID and type.

Parameters:

viewId - ID of the view to load

viewType - type of the view to load

Returns:

a loader to load the JSON representation of the view

getAttributeValues

CachedList<AttributeValue> getAttributeValues(String reportId,
                                            String attributeCode)
                                              throws NotFoundException

Returns the possible values for the attribute with the given code in the report with the specified ID. This is a cached list, call CachedCollection.loadFirstTime() to populate it initially.

Parameters:

reportId - ID of the report in which the attribute is used

attributeCode - code of the attribute whose values to load

Returns:

all possible values for the attribute

Throws:

NotFoundException - if the ID wasn't found

loadUser

User loadUser(String userId)
              throws NotFoundException

Loads the user with the given ID.

Parameters:

userId - ID of the user to load

Returns:

the user with the specified ID

Throws:

NotFoundException - if the ID wasn't found

loadUserImage

Object loadUserImage(String userId)
                     throws IOException,
                            NotFoundException

Loads the profile image of the user with the given ID. The Java type of the image being returned depends on the implementation.

Parameters:

userId - ID of the user whose image to load

Returns:

the profile image of the user with the given ID

Throws:

IOException - if no image exists or it cannot be loaded

NotFoundException - if the ID wasn't found

getDataSetInfo

PaginatedIdList<DataSetInfo> getDataSetInfo()

Returns a paginated list to access data sets visible to the current user.

Initially, the returned list is empty. Call PaginatedList.load() to load data set data.

Returns:

a paginated list to access data sets visible to the current user

loadDataSet

DataSet loadDataSet(String id)
                    throws NotFoundException

Loads the data set with the specified ID.

This method makes an API call to BellaDati and may take some time to complete.

Parameters:

id - ID of the data set to load

Returns:

the data set with the specified ID

Throws:

NotFoundException - if the ID wasn't found

uploadData

void uploadData(String id,
              DataTable data)
                throws UnknownServerColumnException

Uploads the given data into this data set. This method doesn't perform any validation of the data; the caller should ensure it matches the data set's structure.

Parameters:

id - ID of the data set to upload to

data - the data to upload

Throws:

UnknownServerColumnException - if the data table contains a column that doesn't exist in the data set

getDataSources

CachedList<DataSource> getDataSources(String id)
                                      throws NotFoundException

Returns the list of data sources for the data set with the given ID. This is a cached list, call CachedCollection.loadFirstTime() to populate it initially.

Parameters:

id - ID of the data set whose sources to load

Returns:

the list of data sources for the data set with the given ID

Throws:

NotFoundException - if the ID wasn't found

getDataSourceImports

CachedList<DataSourceImport> getDataSourceImports(String id)
                                                  throws NotFoundException

Returns the list of import configurations for the data source with the given ID. This is a cached list, call CachedCollection.loadFirstTime() to populate it initially.

Parameters:

id - ID of the data source whose import configurations to load

Returns:

the list of import configurations for the data source with the given ID

Throws:

NotFoundException - if the ID wasn't found

setupDataSourceImport

DataSourcePendingImport setupDataSourceImport(String id,
                                            Date date)

Sets up a DataSourcePendingImport instance for the data source with the given ID. Call DataSourcePendingImport.post() to submit it to the server.

Parameters:

date - the date/time on which the import takes place

Returns:

the import object for further configuration and submission