com.belladati.sdk.report

Interface Report

All Superinterfaces:

IdElement, Localizable, Resource

public interface Report
extends Resource, Localizable

A BellaDati report. A report holds a list of View objects that are loaded as part of the report.

Author:

Chris Hennigfeld

Method Summary

Methods

Modifier and Type	Method and Description
List<Attribute>	getAttributes() Returns a list of all attributes used in this report.
PaginatedList<Comment>	getComments() Returns a paginated list to access the comments of this report.
DataSetInfo	getDataSet() Returns the data set this report is built on.
String	getDescription() Returns the description of this report.
Date	getLastChange() Returns the last change date of this report.
String	getOwnerName() Returns the name of the report owner.
List<View>	getViews() Returns a list of views in this report.
void	postComment(String text) Posts a comment to this report.

Methods inherited from interface com.belladati.sdk.util.Resource

getId, getName

Methods inherited from interface com.belladati.sdk.util.Localizable

getName, hasLocalization

Method Detail

getDescription

String getDescription()

Returns the description of this report.

Returns:

the description of this report

getOwnerName

String getOwnerName()

Returns the name of the report owner.

Returns:

the name of the report owner

getLastChange

Date getLastChange()

Returns the last change date of this report.

Returns:

the last change date of this report, or null if it was never changed

getViews

List<View> getViews()

Returns a list of views in this report.

Returns:

a list of views in this report

getAttributes

List<Attribute> getAttributes()

Returns a list of all attributes used in this report. You can use these attributes to filter the report's views.

Returns:

a list of all attributes used in this report

getComments

PaginatedList<Comment> getComments()

Returns a paginated list to access the comments of this report.

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

Returns:

a paginated list to access the comments of this report

postComment

void postComment(String text)

Posts a comment to this report. To see the comment, reload the list returned from getComments().

Parameters:

text - text of the comment to post

getDataSet

DataSetInfo getDataSet()

Returns the data set this report is built on.

Returns:

the data set this report is built on