Package org.ctan.site.services.upload

Interface SubmitService

All Known Implementing Classes:

Submit11Service

public interface SubmitService

This class contains the submit service interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SubmitService.FieldOptions	The class FieldOptions contains the transport object for field descriptions.
static class	SubmitService.Fields	The class Fields contains the transport object for field specifications.
static class	SubmitService.UploadData	The class UploadData contains the transport object for the upload meta data.

Method Summary

Modifier and Type	Method	Description
SubmitService.Fields	getFields(String api)	The method getFields provides means to retrieve the supported fields and their attributes.
String	getVersion()	This is the getter for the version number.
Messages	upload(String api, SubmitService.UploadData data, String fileName, InputStream stream, User user)	This method performs a validation and a following upload if the validation has succeeded.
Messages	validate(String api, SubmitService.UploadData data, String filename, InputStream stream)	This service method performs a validation and tries to store the data as upload.

Method Details

getFields

SubmitService.Fields getFields(String api)

The method getFields provides means to retrieve the supported fields and their attributes.

Parameters:

api - the number of the requested API

Returns:

the fields

Throws:

UnsupportedOperationException - if a wrong API version is given

getVersion

String getVersion()

This is the getter for the version number.

Returns:

the version number

upload

Messages upload(String api,
 SubmitService.UploadData data,
 String fileName,
 InputStream stream,
 User user)

This method performs a validation and a following upload if the validation has succeeded.

Parameters:

api - the version of the API

data - the parameters

fileName - the name of the file

stream - the file input stream

user - the authenticated user or null

Returns:

the list of messages

validate

Messages validate(String api,
 SubmitService.UploadData data,
 String filename,
 InputStream stream)

This service method performs a validation and tries to store the data as upload.

Parameters:

api - the version of the API

data - the parameters

filename - the file name

stream - the input stream for the file

Returns:

the messages