Package com.gooddata.md

Class ScheduledMail

java.lang.Object

com.gooddata.md.AbstractObj

com.gooddata.md.ScheduledMail

All Implemented Interfaces:

Obj, Queryable, Updatable, Serializable

public class ScheduledMail
extends AbstractObj
implements Queryable, Updatable

A scheduled mail MD object. It represents a schedule on mail-sending of exported dashboards and reports.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gooddata.md.AbstractObj

meta

Fields inherited from interface com.gooddata.md.Obj

CREATE_URI, CREATE_WITH_ID_URI, OBJ_TEMPLATE, OBJ_URI, URI

Constructor Summary

Constructors

Constructor	Description
ScheduledMail(String title, String summary)	Creates an almost empty instance of the object.
ScheduledMail(String title, String summary, String recurrency, org.joda.time.LocalDate startDate, String timeZone, Collection<String> toAddresses, Collection<String> bccAddresses, String subject, String body, List<Attachment> attachments)	Creates full, safe mail schedule object.

Method Summary

Modifier and Type	Method	Description
ScheduledMail	addBccAddress(String bccAdd)
ScheduledMail	addDashboardAttachment(String uri, Integer allTabs, String executionContext, String... tabs)
ScheduledMail	addReportAttachment(ReportDefinition reportDefinition, Map<String,String> exportOptions, ExportFormat... formats)
ScheduledMail	addReportAttachment(ReportDefinition reportDefinition, Map<String,String> exportOptions, ReportExportFormat... formats)	Deprecated. use addReportAttachment(ReportDefinition, Map, ExportFormat...)
ScheduledMail	addReportAttachment(ReportDefinition reportDefinition, Map<String,String> exportOptions, String... formats)
ScheduledMail	addToAddress(String toAdd)
Collection<? extends Attachment>	getAttachments()
Collection<String>	getBccAddresses()
String	getBody()
String	getSubject()
Collection<String>	getToAddresses()
ScheduledMailWhen	getWhen()
ScheduledMail	setAttachments(List<Attachment> attachments)
ScheduledMail	setBcc(Collection<String> bccAddresses)
ScheduledMail	setBody(String body)
ScheduledMail	setRecurrency(String recurrency)
ScheduledMail	setStartDate(org.joda.time.LocalDate startDate)
ScheduledMail	setSubject(String subject)
ScheduledMail	setTimeZone(String timeZone)
ScheduledMail	setTo(Collection<String> toAddresses)
String	toString()

Methods inherited from class com.gooddata.md.AbstractObj

getAuthor, getCategory, getContributor, getCreated, getFlags, getId, getIdentifier, getSummary, getTags, getTitle, getUpdated, getUri, isDeprecated, isLocked, isProduction, isSharedWithSomeone, isUnlisted, setCategory, setDeprecated, setFlags, setIdentifier, setLocked, setProduction, setSharedWithSomeone, setSummary, setTags, setTitle, setUnlisted, uris

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gooddata.md.Obj

getUri

Constructor Detail

ScheduledMail

public ScheduledMail(String title,
                     String summary)

Creates an almost empty instance of the object. It's up to the user's responsibility to call all the necessary setters.

Parameters:

title - the title of the MD object

summary - the summary of the MD object

ScheduledMail

public ScheduledMail(String title,
                     String summary,
                     String recurrency,
                     org.joda.time.LocalDate startDate,
                     String timeZone,
                     Collection<String> toAddresses,
                     Collection<String> bccAddresses,
                     String subject,
                     String body,
                     List<Attachment> attachments)

Creates full, safe mail schedule object.

Parameters:

title - the title of the MD object

summary - the summary of the MD object

recurrency - schedule in format defined in schedule

startDate - schedule starting date

timeZone - time zone of the starting date

toAddresses - collection of email addresses to send the mail to

bccAddresses - collection of blind copy addresses to send the mail to

subject - the subject of the scheduled mail

body - the text body of the scheduled mail

attachments - reports and dashboards to send in the scheduled email

Method Detail

getWhen

public ScheduledMailWhen getWhen()

getToAddresses

public Collection<String> getToAddresses()

getBccAddresses

public Collection<String> getBccAddresses()

getSubject

public String getSubject()

getBody

public String getBody()

getAttachments

public Collection<? extends Attachment> getAttachments()

setRecurrency

public ScheduledMail setRecurrency(String recurrency)

setStartDate

public ScheduledMail setStartDate(org.joda.time.LocalDate startDate)

setTimeZone

public ScheduledMail setTimeZone(String timeZone)

setTo

public ScheduledMail setTo(Collection<String> toAddresses)

setBcc

public ScheduledMail setBcc(Collection<String> bccAddresses)

setSubject

public ScheduledMail setSubject(String subject)

setBody

public ScheduledMail setBody(String body)

setAttachments

public ScheduledMail setAttachments(List<Attachment> attachments)

addToAddress

public ScheduledMail addToAddress(String toAdd)

addBccAddress

public ScheduledMail addBccAddress(String bccAdd)

addReportAttachment

public ScheduledMail addReportAttachment(ReportDefinition reportDefinition,
                                         Map<String,String> exportOptions,
                                         String... formats)

addReportAttachment

@Deprecated
public ScheduledMail addReportAttachment(ReportDefinition reportDefinition,
                                         Map<String,String> exportOptions,
                                         ReportExportFormat... formats)

Deprecated.

use addReportAttachment(ReportDefinition, Map, ExportFormat...)

addReportAttachment

public ScheduledMail addReportAttachment(ReportDefinition reportDefinition,
                                         Map<String,String> exportOptions,
                                         ExportFormat... formats)

addDashboardAttachment

public ScheduledMail addDashboardAttachment(String uri,
                                            Integer allTabs,
                                            String executionContext,
                                            String... tabs)

toString

public String toString()

Overrides:

toString in class AbstractObj