Package org.xwiki.filter.job

Class FilterStreamConverterJobRequest

java.lang.Object

org.xwiki.job.AbstractRequest

org.xwiki.filter.job.FilterStreamConverterJobRequest

All Implemented Interfaces:

Serializable, FilterStreamJobRequest, Request

public class FilterStreamConverterJobRequest
extends AbstractRequest
implements FilterStreamJobRequest

The request used to configure "filter.converter" job.

Since:

6.2M1

Version:

$Id: 0f31e1e45f3685221f927735b3d208f31f590619 $

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.xwiki.filter.job.FilterStreamJobRequest

JOBID_PREFIX

Fields inherited from interface org.xwiki.job.Request

PROPERTY_CONTEXT, PROPERTY_INTERACTIVE, PROPERTY_REMOTE

Constructor Summary

Constructors

Constructor	Description
FilterStreamConverterJobRequest(FilterStreamType inputType, Map<String,Object> inputProperties, FilterStreamType outputType, boolean eventsFolded, Map<String,Object> outputProperties)
FilterStreamConverterJobRequest(FilterStreamType inputType, Map<String,Object> inputProperties, FilterStreamType outputType, Map<String,Object> outputProperties)
FilterStreamConverterJobRequest(Request request)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getInputProperties()
FilterStreamType	getInputType()
Map<String,Object>	getOutputProperties()
FilterStreamType	getOutputType()
boolean	isEventsFolded()

Methods inherited from class org.xwiki.job.AbstractRequest

containsProperty, equals, getContext, getId, getProperties, getProperty, getProperty, getPropertyNames, hashCode, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, removeProperty, setContext, setId, setId, setId, setInteractive, setProperty, setRemote, setStatusLogIsolated, setStatusSerialized, setVerbose

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xwiki.job.Request

containsProperty, getContext, getId, getProperty, getProperty, getPropertyNames, isInteractive, isRemote, isStatusLogIsolated, isStatusSerialized, isVerbose, setContext

Constructor Detail

FilterStreamConverterJobRequest

public FilterStreamConverterJobRequest(FilterStreamType inputType,
                                       Map<String,Object> inputProperties,
                                       FilterStreamType outputType,
                                       Map<String,Object> outputProperties)

Parameters:

inputType - the type of the input module

inputProperties - the configuration of the input module

outputType - the type of the output module

outputProperties - the configuration of the output module

FilterStreamConverterJobRequest

public FilterStreamConverterJobRequest(FilterStreamType inputType,
                                       Map<String,Object> inputProperties,
                                       FilterStreamType outputType,
                                       boolean eventsFolded,
                                       Map<String,Object> outputProperties)

Parameters:

inputType - the type of the input module

inputProperties - the configuration of the input module

outputType - the type of the output module

eventsFolded - true if events produced during the conversion should be folded

outputProperties - the configuration of the output module

FilterStreamConverterJobRequest

public FilterStreamConverterJobRequest(Request request)

Parameters:

request - the request to copy

Method Detail

getInputType

public FilterStreamType getInputType()

Returns:

the type of the input module

getInputProperties

public Map<String,Object> getInputProperties()

Returns:

the configuration of the input module

getOutputType

public FilterStreamType getOutputType()

Returns:

the type of the output module

isEventsFolded

public boolean isEventsFolded()

Returns:

true if events produced during the conversion should be folded

Since:

8.2RC1

getOutputProperties

public Map<String,Object> getOutputProperties()

Returns:

the configuration of the output module