Package CSF.Zpt.BatchRendering

Classes
class	BatchOptionsBuilder
	Default implementation of IBatchOptionsInputHelper.
class	BatchRenderer
	Default implementation of IBatchRenderer. More...
class	BatchRenderingDocumentResponse
	Batch rendering document response. More...
class	BatchRenderingException
	Exception raised when batch rendering fails for an unexpected reason. More...
class	BatchRenderingOptions
	Concrete implementation of IBatchRenderingOptions. More...
class	BatchRenderingOptionsValidator
	Default implementation of IBatchRenderingOptionsValidator. More...
class	BatchRenderingResponse
	Represents the response from a batch-rendering operation. More...
class	ErrorTolerantBatchRenderer
	Implementation of BatchRenderer which catches exceptions raised when rendering documents and rolls the failures into the output. More...
interface	IBatchOptionsInputHelper
	Interface for a type which enables selection of the input options for IBatchRenderingOptions. More...
interface	IBatchOptionsMultipleInputOutputHelper
	Interface for a type which enables selection of the output options for IBatchRenderingOptions, when the input options indicate the potential for multiple documents. More...
interface	IBatchOptionsSingleInputOutputHelper
	Interface for a type which enables selection of the output options for IBatchRenderingOptions, when the input options indicate a single document. More...
interface	IBatchRenderer
	Interface for a type which provides batch-rendering services, parsing and rendering potentially multiple documents in a single job. More...
interface	IBatchRenderingDocumentResponse
	Represents the response for a single document within an IBatchRenderingResponse. More...
interface	IBatchRenderingOptions
	Represents batch rendering options, indicating the inputs and outputs for a IBatchRenderer. More...
interface	IBatchRenderingOptionsValidator
	Interface for a service which renders IBatchRenderingOptions instances. More...
interface	IBatchRenderingResponse
	Represents the response from a batch-rendering task. More...
class	InvalidBatchRenderingOptionsException
	Exception raised when a constructed instance of IBatchRenderingOptions is invalid. More...
interface	IRenderingJob
	Represents a task to render a single IZptDocument. More...
interface	IRenderingJobFactory
	Interface for a factory type which creates instances of IRenderingJob. More...
class	RenderingJob
class	RenderingJobFactory
	Default implementation of IRenderingJobFactory. More...

Enumerations
enum	BatchRenderingDocumentErrorType { BatchRenderingDocumentErrorType.Default = 0 }
	Enumerates the expected error types which can occur whilst rendering a single document. More...
enum	BatchRenderingFatalErrorType { BatchRenderingFatalErrorType.NoInputsSpecified = 1, BatchRenderingFatalErrorType.InputCannotBeBothStreamAndPaths, BatchRenderingFatalErrorType.NoOutputsSpecified, BatchRenderingFatalErrorType.OutputCannotBeBothStreamAndPaths }
	Enumerates the expected fatal error types which can occur whilst rendering a batch of documents. More...

Enumeration Type Documentation

enum CSF.Zpt.BatchRendering.BatchRenderingDocumentErrorType

Enumerates the expected error types which can occur whilst rendering a single document.

Enumerator
Default	TODO: Create more useful error types. See issue #104

enum CSF.Zpt.BatchRendering.BatchRenderingFatalErrorType

Enumerates the expected fatal error types which can occur whilst rendering a batch of documents.

Enumerator
NoInputsSpecified	Indicates that no input paths or streams were specified, thus the renderer has no work to do.
InputCannotBeBothStreamAndPaths	The renderer does not support rendering from both streams and paths. This indicates that both were provided.
NoOutputsSpecified	Indicates that no output mechanism was specified (either s filesystem path or a stream).
OutputCannotBeBothStreamAndPaths	The renderer does not support rendering to both streams and paths. This indicates that both were provided.