Interface IXProcessUploadParams

public interface IXProcessUploadParams

Interface for the parameters passed to the IXItemBasic.processUpload(IXProcessUploadParams) method.

Since:

7.0.11

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
XItem	getItem()
List<IUploadPostProcessor>	getPostProcessorChain()
int	getRepetitionIndex()
Path	getTempDir()	A temporary directory that can be used to store files.
IXUpload	getUpload()
IXForm	getXForm()
boolean	isRepeated()

Method Details

getItem

XItem getItem()

Returns:

The item for which the upload is processed.

getRepetitionIndex

int getRepetitionIndex()

Returns:

The repetition index (which may not start at 0 and is not uniformly increasing, treat this as an ID), when the element is repeated. When the element is not repeated, returns 0.

getTempDir

Path getTempDir()

A temporary directory that can be used to store files. If you need to write arbitrary files, you should create a temporary subdirectory in this directory.

Returns:

The temporary directory.

getUpload

IXUpload getUpload()

Returns:

The upload that was submitted.

getXForm

IXForm getXForm()

Returns:

The form which contains the element.

isRepeated

boolean isRepeated()

Returns:

Whether the element is a repeated element.

getPostProcessorChain

List<IUploadPostProcessor> getPostProcessorChain()

Returns:

the (possibly empty) list of upload postprocessors