com.belladati.sdk.report

Interface ReportInfo

All Superinterfaces:

IdElement, Localizable, ResourceInfo<Report>

public interface ReportInfo
extends ResourceInfo<Report>, Localizable

Information object about a BellaDati report. Use this to get meta-information about the report. To retrieve the report contents, call ResourceInfo.loadDetails().

Author:

Chris Hennigfeld

Method Summary

Methods

Modifier and Type	Method and Description
PaginatedList<Comment>	getComments() Returns a paginated list to access the comments of the associated report.
String	getDescription() Returns the associated report's description.
Date	getLastChange() Returns the last change date of the associated report.
String	getOwnerName() Returns the name of the associated report's owner.
Object	loadThumbnail() Loads a thumbnail image for the associated report.
void	postComment(String text) Posts a comment to the associated report.

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

getId, getName, loadDetails

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

getName, hasLocalization

Method Detail

getDescription

String getDescription()

Returns the associated report's description.

Returns:

the associated report's description, or an empty string if no description exists

getOwnerName

String getOwnerName()

Returns the name of the associated report's owner.

Returns:

the name of the associated report's owner

getLastChange

Date getLastChange()

Returns the last change date of the associated report.

Returns:

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

loadThumbnail

Object loadThumbnail()
                     throws IOException

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

Returns:

a thumbnail image for the associated report

Throws:

IOException - if no image exists or it cannot be loaded

getComments

PaginatedList<Comment> getComments()

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

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

Returns:

a paginated list to access the comments of the associated report

postComment

void postComment(String text)

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

Parameters:

text - text of the comment to post