|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOutputHandler
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.
Field Summary | |
---|---|
static String |
CONTENT
|
static String |
FILE
|
static int |
OUTPUT_TYPE_CONTENT
|
static int |
OUTPUT_TYPE_DEFAULT
|
static int |
OUTPUT_TYPE_PARAMETERS
|
static String |
RESPONSE
|
Method Summary | |
---|---|
boolean |
allowFeedback()
Determines whether this output handler can send feedback ContentItems or not. |
boolean |
contentDone()
|
IContentItem |
getFeedbackContentItem()
Retrieve the ContentItem that describes the request interface for additional or missing information (missing from the original request) |
IMimeTypeListener |
getMimeTypeListener()
|
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. |
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. |
IOutputDef |
getOutputDef(String name)
Retrieve a single output parameter definition by name |
Map |
getOutputDefs()
Returns a map of the valid output parameter definitions for this request. |
int |
getOutputPreference()
Gets the output type prefered by the handler. |
IPentahoSession |
getSession()
|
void |
setContentItem(IContentItem content,
String objectName,
String contentName)
Sets the output ContentItem for this handler. |
void |
setMimeTypeListener(IMimeTypeListener mimeTypeListener)
|
void |
setOutput(String name,
Object value)
Sets an output of the handler. |
void |
setOutputPreference(int outputType)
Sets the output type that is wanted by the handler. |
void |
setRuntimeContext(IRuntimeContext runtimeContext)
|
void |
setSession(IPentahoSession session)
|
Field Detail |
---|
static final int OUTPUT_TYPE_PARAMETERS
static final int OUTPUT_TYPE_CONTENT
static final int OUTPUT_TYPE_DEFAULT
static final String RESPONSE
static final String CONTENT
static final String FILE
Method Detail |
---|
Map getOutputDefs()
void setSession(IPentahoSession session)
IPentahoSession getSession()
boolean contentDone()
IOutputDef getOutputDef(String name)
name
- name of the output parameter definition requested
IContentItem getFeedbackContentItem()
IContentItem getOutputContentItem(String objectName, String contentName, String solution, String instanceId, String mimeType)
objectName
- Name of the objectcontentName
- Name of the content
IContentItem getOutputContentItem(String objectName, String contentName, String title, String url, String solution, String instanceId, String mimeType)
objectName
- Name of the objectcontentName
- Name of the contenttitle
- Title of the objecturl
- URL to view the object
boolean allowFeedback()
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.
void setContentItem(IContentItem content, String objectName, String contentName)
content
- ContentItem to setobjectName
- Name of the objectcontentName
- Name of the contentvoid setOutputPreference(int outputType)
outputType
- Output type requestedint getOutputPreference()
void setOutput(String name, Object value)
name
- Name of the outputvalue
- Value of the outputIMimeTypeListener getMimeTypeListener()
void setMimeTypeListener(IMimeTypeListener mimeTypeListener)
void setRuntimeContext(IRuntimeContext runtimeContext)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |