org.pentaho.platform.api.engine
Interface IContentOutputHandler

All Superinterfaces:

IMimeTypeListener

All Known Implementing Classes:

ApacheVFSOutputHandler, BaseOutputHandler, ContentRepositoryOutputHandler, FileOutputHandler, JcrCmsOutputHandler, ZipOutputHandler

public interface IContentOutputHandler
extends IMimeTypeListener

Interface for a class used to stream contents from a Pentaho action sequence to a destination of some kind, e.g. file, database, content management system (CMS)

Author:

jdixon

Method Summary

java.lang.String	getActionName()
java.lang.String	getContentRef()
IContentItem	getFileOutputContentItem() Returns a content item that can be used to stream content to a destination of some kind
java.lang.String	getHandlerId()
java.lang.String	getInstanceId()
java.lang.String	getMimeType()
IPentahoSession	getSession()
java.lang.String	getSolutionName()
java.lang.String	getSolutionPath()
void	setActionName(java.lang.String actionName)
void	setContentRef(java.lang.String contentRef)
void	setHandlerId(java.lang.String handlerId)
void	setInstanceId(java.lang.String instanceId)
void	setMimeType(java.lang.String mimeType)
void	setSession(IPentahoSession session)
void	setSolutionName(java.lang.String solutionName)
void	setSolutionPath(java.lang.String solutionPath)

Methods inherited from interface org.pentaho.platform.api.engine.IMimeTypeListener

setName

Method Detail

getFileOutputContentItem

IContentItem getFileOutputContentItem()

Returns a content item that can be used to stream content to a destination of some kind

getActionName

java.lang.String getActionName()

Returns:

Returns the actionName.

setActionName

void setActionName(java.lang.String actionName)

Parameters:

actionName - The actionName to set.

getHandlerId

java.lang.String getHandlerId()

Returns:

Returns the handlerId.

setHandlerId

void setHandlerId(java.lang.String handlerId)

Parameters:

handlerId - The handlerId to set.

getInstanceId

java.lang.String getInstanceId()

Returns:

Returns the instanceId.

setInstanceId

void setInstanceId(java.lang.String instanceId)

Parameters:

instanceId - The instanceId to set.

getMimeType

java.lang.String getMimeType()

Returns:

Returns the mimeType.

setMimeType

void setMimeType(java.lang.String mimeType)

Specified by:

setMimeType in interface IMimeTypeListener

Parameters:

mimeType - The mimeType to set.

getSession

IPentahoSession getSession()

Returns:

Returns the session.

setSession

void setSession(IPentahoSession session)

Parameters:

session - The session to set.

getSolutionName

java.lang.String getSolutionName()

Returns:

Returns the solutionName.

setSolutionName

void setSolutionName(java.lang.String solutionName)

Parameters:

solutionName - The solutionName to set.

getSolutionPath

java.lang.String getSolutionPath()

Returns:

Returns the solutionPath.

setSolutionPath

void setSolutionPath(java.lang.String solutionPath)

Parameters:

solutionPath - The solutionPath to set.

getContentRef

java.lang.String getContentRef()

Returns:

Returns the contentRef.

setContentRef

void setContentRef(java.lang.String contentRef)

Parameters:

contentRef - The path and name of the content to be stored. This comes from the definition in the outputs section of the Action Sequence