com.sapportals.wcm.service.reporting

Interface IScheduledReport

All Known Implementing Classes:

ScheduledReport

public interface IScheduledReport

Holds together IReportInput and a future, possibly repeating, execution date.

Copyright (c) SAP AG 2003-2004

Method Summary

IScheduledReport	create(IResourceContext context) Persist the scheduled report as a new resource and return a scheduled report instance where getResource() returns the resource the scheduled report was persisted in.
Date	getLastExecuted() Get date/time when schedule was last executed.
String	getName() Get name of scheduled report.
Date	getNextSchedule() Get date/time when report execution is next due.
ScheduleRepeat	getRepeating() Get repeating interval for repeated execution of report.
IReportInput	getReportInput() Get the input for the scheduled report
IResource	getResource() Get the resource, this scheduled report, is persisted in.
Date	getSchedule() Get date/time when report execution is/was scheduled.
boolean	isActive() Determine if scheduled report is activated.
IScheduledReport	setActive(boolean active) Create a new scheduled report with given active state.
IScheduledReport	setInput(IReportInput input) Create a new scheduled report with given input.
IScheduledReport	setLastExecuted(Date date) Create a new scheduled report with given last execution date.
IScheduledReport	setName(String name) Create a new scheduled report with given name set.
IScheduledReport	setRepeating(ScheduleRepeat repeat) Create a new scheduled report with given repeat interval.
IScheduledReport	setSchedule(Date date) Create a new scheduled report with given schedule date.
IScheduledReport	update(IResource resource) Persist the scheduled report and return a scheduled report instance where getResource() returns the resource the scheduled report was persisted in.

Method Detail

getName

public String getName()

Get name of scheduled report. The name is for display only and has no uniqueness properties.

Returns:

name of scheduled report

getSchedule

public Date getSchedule()

Get date/time when report execution is/was scheduled. If no execution date is set, null is returned. The date reflects when the report was first scheduled for execution. User getNextScheduled() to retrieve the time of the next scheduled execution.

Returns:

date/time of scheduled report execution

getLastExecuted

public Date getLastExecuted()

Get date/time when schedule was last executed. If the schedule was never executed, null is returned.

Returns:

date/time of last report execution or null

getRepeating

public ScheduleRepeat getRepeating()

Get repeating interval for repeated execution of report.

Returns:

repeating interval

isActive

public boolean isActive()

Determine if scheduled report is activated.

Returns:

if scheduled report is activated.

getNextSchedule

public Date getNextSchedule()

Get date/time when report execution is next due. If no execution date is set or no repeat interval is set on an already executed schedule, null is returned.

Returns:

date/time of next report execution

getReportInput

public IReportInput getReportInput()

Get the input for the scheduled report

Returns:

input for scheduled report

getResource

public IResource getResource()

Get the resource, this scheduled report, is persisted in. Maybe null of schedule is not persisted.

Returns:

resource where scheduled report is persisted or null if report is not persisted yet

setName

public IScheduledReport setName(String name)

Create a new scheduled report with given name set. Does not change the object itself.

Parameters:

name - of new scheduled report

Returns:

scheduled report with name set.

setInput

public IScheduledReport setInput(IReportInput input)

Create a new scheduled report with given input. Does not change the object itself.

Parameters:

input - of new scheduled report

Returns:

scheduled report with input

setSchedule

public IScheduledReport setSchedule(Date date)

Create a new scheduled report with given schedule date. Does not change the object itself.

Parameters:

date - date of new scheduled report

Returns:

scheduled report with schedule date

setLastExecuted

public IScheduledReport setLastExecuted(Date date)

Create a new scheduled report with given last execution date. Does not change the object itself.

Parameters:

date - of last schedule execution

Returns:

scheduled report with last execution date

setRepeating

public IScheduledReport setRepeating(ScheduleRepeat repeat)

Create a new scheduled report with given repeat interval. Does not change the object itself.

Parameters:

repeat - repeat of new scheduled report

Returns:

scheduled report with schedule repeat

setActive

public IScheduledReport setActive(boolean active)

Create a new scheduled report with given active state. Does not change the object itself.

Parameters:

active - state of new scheduled report

Returns:

scheduled report with given active state

update

public IScheduledReport update(IResource resource)
                        throws ResourceException

Persist the scheduled report and return a scheduled report instance where getResource() returns the resource the scheduled report was persisted in.

Parameters:

resource - to be overwritten with setting from scheduled report

Returns:

scheduled report with persisting resource set

Throws:

ResourceException

create

public IScheduledReport create(IResourceContext context)
                        throws ResourceException

Persist the scheduled report as a new resource and return a scheduled report instance where getResource() returns the resource the scheduled report was persisted in.

Returns:

scheduled report with persisting resource set

Throws:

ResourceException