|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.pentaho.platform.repository.content.CoreContentRepositoryOutputHandler
public class CoreContentRepositoryOutputHandler
Field Summary | |
---|---|
static String |
BackgroundFolder
|
static String |
ContentRepoObjectName
|
static String |
DefaultExtension
|
static String |
DefaultMimeType
|
static String |
FileObjectName
|
Fields inherited from interface org.pentaho.platform.api.engine.IOutputHandler |
---|
CONTENT, FILE, OUTPUT_TYPE_CONTENT, OUTPUT_TYPE_DEFAULT, OUTPUT_TYPE_PARAMETERS, RESPONSE |
Constructor Summary | |
---|---|
CoreContentRepositoryOutputHandler(String location,
String contentGUID,
String solution,
IPentahoSession session)
|
|
CoreContentRepositoryOutputHandler(String location,
String contentGUID,
String solution,
String mimeType,
String extension,
IPentahoSession session)
|
Method Summary | |
---|---|
boolean |
allowFeedback()
Determines whether this output handler can send feedback ContentItems or not. |
boolean |
contentDone()
|
String |
getExtension()
|
IContentItem |
getFeedbackContentItem()
Retrieve the ContentItem that describes the request interface for additional or missing information (missing from the original request) |
org.apache.commons.logging.Log |
getLogger()
|
String |
getMimeType()
|
IMimeTypeListener |
getMimeTypeListener()
|
IContentItem |
getOutputContentItem(String objectName,
String contentName,
String solution,
String instanceId,
String inMimeType)
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 inMimeType)
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()
|
int |
getWriteMode()
|
boolean |
isResponseExpected()
Indicates whether or not the handler is expected to have data written to a response output stream managed by the handler. |
void |
setContentItem(IContentItem content,
String objectName,
String contentName)
Sets the output ContentItem for this handler. |
void |
setExtension(String value)
|
void |
setMimeType(String value)
|
void |
setMimeTypeListener(IMimeTypeListener mimeTypeListener)
|
void |
setOutput(String name,
Object value)
Sets an output of the handler. |
void |
setOutputPreference(int value)
Sets the output type that is wanted by the handler. |
void |
setRuntimeContext(IRuntimeContext runtimeContext)
|
void |
setSession(IPentahoSession session)
|
void |
setWriteMode(int value)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DefaultMimeType
public static final String BackgroundFolder
public static final String DefaultExtension
public static final String FileObjectName
public static final String ContentRepoObjectName
Constructor Detail |
---|
public CoreContentRepositoryOutputHandler(String location, String contentGUID, String solution, IPentahoSession session)
public CoreContentRepositoryOutputHandler(String location, String contentGUID, String solution, String mimeType, String extension, IPentahoSession session)
Method Detail |
---|
public void setSession(IPentahoSession session)
setSession
in interface IOutputHandler
public IPentahoSession getSession()
getSession
in interface IOutputHandler
public void setMimeType(String value)
public void setExtension(String value)
public String getMimeType()
public String getExtension()
public void setWriteMode(int value)
public int getWriteMode()
public org.apache.commons.logging.Log getLogger()
public boolean allowFeedback()
IOutputHandler
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.
allowFeedback
in interface IOutputHandler
public boolean contentDone()
contentDone
in interface IOutputHandler
public IContentItem getFeedbackContentItem()
IOutputHandler
getFeedbackContentItem
in interface IOutputHandler
public IContentItem getOutputContentItem(String objectName, String contentName, String solution, String instanceId, String inMimeType)
IOutputHandler
getOutputContentItem
in interface IOutputHandler
objectName
- Name of the objectcontentName
- Name of the content
public IContentItem getOutputContentItem(String objectName, String contentName, String title, String url, String solution, String instanceId, String inMimeType)
IOutputHandler
getOutputContentItem
in interface IOutputHandler
objectName
- Name of the objectcontentName
- Name of the contenttitle
- Title of the objecturl
- URL to view the object
public IOutputDef getOutputDef(String name)
IOutputHandler
getOutputDef
in interface IOutputHandler
name
- name of the output parameter definition requested
public Map getOutputDefs()
IOutputHandler
getOutputDefs
in interface IOutputHandler
public int getOutputPreference()
IOutputHandler
getOutputPreference
in interface IOutputHandler
public void setContentItem(IContentItem content, String objectName, String contentName)
IOutputHandler
setContentItem
in interface IOutputHandler
content
- ContentItem to setobjectName
- Name of the objectcontentName
- Name of the contentpublic void setOutput(String name, Object value)
IOutputHandler
setOutput
in interface IOutputHandler
name
- Name of the outputvalue
- Value of the outputpublic void setOutputPreference(int value)
IOutputHandler
setOutputPreference
in interface IOutputHandler
value
- Output type requestedpublic IMimeTypeListener getMimeTypeListener()
getMimeTypeListener
in interface IOutputHandler
public void setMimeTypeListener(IMimeTypeListener mimeTypeListener)
setMimeTypeListener
in interface IOutputHandler
public void setRuntimeContext(IRuntimeContext runtimeContext)
setRuntimeContext
in interface IOutputHandler
public boolean isResponseExpected()
IOutputHandler
isResponseExpected
in interface IOutputHandler
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |