| org.pentaho.core.solution.IOutputHandler
All known Subclasses: org.pentaho.core.solution.SimpleOutputHandler, org.pentaho.core.repository.content.ContentRepositoryOutputHandler, org.pentaho.core.solution.HttpOutputHandler,
| IOutputHandler | | public interface IOutputHandler (Code) | | An OutputHandler manages the content generated from a Component execution.
Output can take the form of the generated results from a component, or
content that solicits additional information from the requester. The handler
also manages the relationship with the ActionDefinition and output content
validation.
|
| Method Summary | |
| public boolean | allowFeedback()
Determines whether this output handler can send feedback ContentItems or
not. | | public boolean | contentDone()
| | public IContentItem | getFeedbackContentItem()
| | public MimeTypeListener | getMimeTypeListener()
| | public IContentItem | getOutputContentItem(String objectName, String contentName, String solution, String instanceId, String mimeType)
Retrieve the ContentItem that describes the output from this request's
component execution. | | public IContentItem | getOutputContentItem(String objectName, String contentName, String title, String url, String solution, String instanceId, String mimeType)
Retrieve the ContentItem that describes the output from this request's
component execution. | | public IOutputDef | getOutputDef(String name)
| | public Map | getOutputDefs()
Returns a map of the valid output parameter definitions for this request. | | public int | getOutputPreference()
Gets the output type prefered by the handler. | | public IPentahoSession | getSession()
| | public void | setContentItem(IContentItem content, String objectName, String contentName)
Sets the output ContentItem for this handler.
objectName will be the name of the destination node from the action
sequence output contentName will be the value of the destination node
from the action sequence output e.g. | | public void | setMimeTypeListener(MimeTypeListener mimeTypeListener)
| | public void | setOutput(String name, Object value)
Sets an output of the handler. | | public void | setOutputPreference(int outputType)
Sets the output type that is wanted by the handler. | | public void | setRuntimeContext(IRuntimeContext runtimeContext)
| | public void | setSession(IPentahoSession session)
|
| OUTPUT_TYPE_CONTENT | | final public static int OUTPUT_TYPE_CONTENT(Code) | | |
| OUTPUT_TYPE_DEFAULT | | final public static int OUTPUT_TYPE_DEFAULT(Code) | | |
| OUTPUT_TYPE_PARAMETERS | | final public static int OUTPUT_TYPE_PARAMETERS(Code) | | |
| allowFeedback | | public boolean allowFeedback()(Code) | | Determines whether this output handler can send feedback ContentItems or
not.
Generally, if there is no client on the other side of the request that
could receive and process feedback, then this boolean should be setto
false.
true if feedback is allowed, false otherwise |
| contentDone | | public boolean contentDone()(Code) | | |
| getFeedbackContentItem | | public IContentItem getFeedbackContentItem()(Code) | | Retrieve the ContentItem that describes the request interface for
additional or missing information (missing from the original request)
ContentItem describing user feedback |
| getOutputContentItem | | public IContentItem getOutputContentItem(String objectName, String contentName, String solution, String instanceId, String mimeType)(Code) | | Retrieve the ContentItem that describes the output from this request's
component execution.
Parameters:
objectName - Name of the object
Parameters:
contentName - Name of the content ContentItem describing end result output |
| getOutputContentItem | | public IContentItem getOutputContentItem(String objectName, String contentName, String title, String url, String solution, String instanceId, String mimeType)(Code) | | Retrieve the ContentItem that describes the output from this request's
component execution.
Parameters:
objectName - Name of the object
Parameters:
contentName - Name of the content
Parameters:
title - Title of the object
Parameters:
url - URL to view the object ContentItem describing end result output |
| getOutputDef | | public IOutputDef getOutputDef(String name)(Code) | | Retrieve a single output parameter definition by name
Parameters:
name - name of the output parameter definition requested IOutputDef, output definition object |
| getOutputDefs | | public Map getOutputDefs()(Code) | | Returns a map of the valid output parameter definitions for this request.
Map of parameters in name-value or name-list form |
| getOutputPreference | | public int getOutputPreference()(Code) | | Gets the output type prefered by the handler. Values are defined in
org.pentaho.core.solution.IOutputHander and are OUTPUT_TYPE_PARAMETERS,
OUTPUT_TYPE_CONTENT, or OUTPUT_TYPE_DEFAULT
Output type |
| setContentItem | | public void setContentItem(IContentItem content, String objectName, String contentName)(Code) | | Sets the output ContentItem for this handler.
objectName will be the name of the destination node from the action
sequence output contentName will be the value of the destination node
from the action sequence output e.g. if the outputs section in the ation
sequence looks like this:
content
objectName should be 'response' contentName should be 'content'
Parameters:
content - ContentItem to set
Parameters:
objectName - Name of the object
Parameters:
contentName - Name of the content |
| setOutput | | public void setOutput(String name, Object value)(Code) | | Sets an output of the handler. For example the HTTP handler will accept
output names of 'header' allowing an HTTP header to be set, and
'redirect' allowing the responses sendRedirect to be called.
Parameters:
name - Name of the output
Parameters:
value - Value of the output |
| setOutputPreference | | public void setOutputPreference(int outputType)(Code) | | Sets the output type that is wanted by the handler. Valid values are
OUTPUT_TYPE_PARAMETERS, OUTPUT_TYPE_CONTENT, OUTPUT_TYPE_DEFAULT
Parameters:
outputType - Output type requested |
|
|