org.pentaho.platform.api.repository
Interface ISubscribeContent

All Known Implementing Classes:

SubscribeContent

public interface ISubscribeContent

This class defines an action sequence (e.g. a report) that users can create subscriptions to. This class contains a reference to the action sequence that will be executed when the subscription is viewed online or scheduled. Parameters to the action sequence can be defined here. These parameters will be applied to every subscription to the action sequence. These parameter values can be overriden by the individual subscriptions if the user interface allows.

Author:

James Dixon

Method Summary

void	addSchedule(ISchedule schedule)
void	clearsSchedules() removes all schedules.
boolean	equals(Object other)
String	getActionReference() Gets the reference to the action sequence used by subscriptions to this content
String	getId() Gets the id of this content
Map<String,Object>	getParameters() Gets the parameters for the content
int	getRevision()
List<ISchedule>	getSchedules()
String	getType()
int	hashCode()
boolean	hasSchedule(ISchedule schedule)
boolean	removeSchedule(ISchedule schedule)
void	setActionReference(String actionReference)
void	setParameters(Map<String,Object> parameters) Sets the parameters that will be provided to the action sequence when it is executed as part of a subscription
void	setSchedules(List<ISchedule> schedules)
void	setType(String contentType)

Method Detail

equals

boolean equals(Object other)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

getRevision

int getRevision()

Returns:

Returns the revision.

getActionReference

String getActionReference()

Gets the reference to the action sequence used by subscriptions to this content

Returns:

Action sequence reference

addSchedule

void addSchedule(ISchedule schedule)

getSchedules

List<ISchedule> getSchedules()

hasSchedule

boolean hasSchedule(ISchedule schedule)

removeSchedule

boolean removeSchedule(ISchedule schedule)

clearsSchedules

void clearsSchedules()

removes all schedules.

setParameters

void setParameters(Map<String,Object> parameters)

Sets the parameters that will be provided to the action sequence when it is executed as part of a subscription

Parameters:

parameters - The parameters to pass to the action sequence

getParameters

Map<String,Object> getParameters()

Gets the parameters for the content

Returns:

Parameter HashMap

getId

String getId()

Gets the id of this content

Returns:

getType

String getType()

setType

void setType(String contentType)

setActionReference

void setActionReference(String actionReference)

setSchedules

void setSchedules(List<ISchedule> schedules)