public interface BellaDatiService extends Serializable
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.Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
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.
|
PaginatedIdList<DashboardInfo> getDashboardInfo()
PaginatedList.load()
to load report data.Dashboard loadDashboard(String id) throws NotFoundException
id
- ID of the dashboard to loadNotFoundException
- if the ID wasn't foundObject loadDashboardThumbnail(String id) throws IOException, NotFoundException
id
- ID of the dashboard whose thumbnail to loadIOException
- if no image exists or it cannot be loadedNotFoundException
- if the ID wasn't foundPaginatedIdList<ReportInfo> getReportInfo()
PaginatedList.load()
to load report data.Report loadReport(String id) throws NotFoundException
id
- ID of the report to loadNotFoundException
- if the ID wasn't foundObject loadReportThumbnail(String id) throws IOException, NotFoundException
id
- ID of the report whose thumbnail to loadIOException
- if no image exists or it cannot be loadedNotFoundException
- if the ID wasn't foundPaginatedList<Comment> getReportComments(String reportId) throws NotFoundException
PaginatedList.load()
to load report data. Subsequent calls to this method for the same report
always return the same list.reportId
- ID of the report whose comments to accessNotFoundException
- if the ID wasn't foundvoid postComment(String reportId, String text) throws NotFoundException
reportId
- ID of the report to which to post a commenttext
- text of the comment to postNotFoundException
- if the ID wasn't foundObject loadViewContent(String viewId, ViewType viewType, Filter<?>... filters) throws NotFoundException
viewId
- ID of the view to loadviewType
- type of the view to loadfilters
- optional filters to use when loading the viewNotFoundException
- if the ID wasn't foundObject loadViewContent(String viewId, ViewType viewType, Collection<Filter<?>> filters) throws NotFoundException
viewId
- ID of the view to loadviewType
- type of the view to loadfilters
- filters to use when loading the viewNotFoundException
- if the ID wasn't foundCachedList<AttributeValue> getAttributeValues(String reportId, String attributeCode) throws NotFoundException
CachedCollection.load()
to populate it initially.reportId
- ID of the report in which the attribute is usedattributeCode
- code of the attribute whose values to loadNotFoundException
- if the ID wasn't foundUser loadUser(String userId) throws NotFoundException
id
- ID of the user to loadNotFoundException
- if the ID wasn't foundObject loadUserImage(String userId) throws IOException, NotFoundException
id
- ID of the user whose image to loadIOException
- if no image exists or it cannot be loadedNotFoundException
- if the ID wasn't foundCopyright © 2013. All rights reserved.