org.kuali.ole.sys.batch.service

Interface BatchInputFileSetService

All Superinterfaces:

InitiateDirectory

All Known Implementing Classes:

BatchInputFileSetServiceImpl

public interface BatchInputFileSetService
extends InitiateDirectory

This interface defines the methods needed to save/download/delete file sets in the batch upload system

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isBatchInputTypeActive(BatchInputFileSetType batchInputFileSetType) Checks if the batch input type is active (can be used for upload).
boolean	isFileUserIdentifierProperlyFormatted(String fileUserIdentifier) Returns whether a file set identifier is properly formatted.
Map<String,String>	save(org.kuali.rice.kim.api.identity.Person user, BatchInputFileSetType inputType, String fileUserIdentifer, Map<String,InputStream> typeToStreamMap) Stores the input streams (the values in the Map parameter) as files on the server, identified by the given user file name and file user identifier

Methods inherited from interface org.kuali.ole.sys.batch.InitiateDirectory

getRequiredDirectoryNames, prepareDirectories

Method Detail

save

Map<String,String> save(org.kuali.rice.kim.api.identity.Person user,
                      BatchInputFileSetType inputType,
                      String fileUserIdentifer,
                      Map<String,InputStream> typeToStreamMap)
                        throws org.kuali.rice.krad.exception.AuthorizationException,
                               FileStorageException

Stores the input streams (the values in the Map parameter) as files on the server, identified by the given user file name and file user identifier

Parameters:

user - - user who is requesting the save

inputType - - instance of a BatchInputFileSetType

fileUserIdentifer - - file identifier specified by user

typeToStreamMap - - contents of the uploaded files, keyed by the input file type

Returns:

a Map of type to file name mappings of the saved files

Throws:

FileStorageException - - if errors were encountered while attempting to write the file

org.kuali.rice.krad.exception.AuthorizationException

isBatchInputTypeActive

boolean isBatchInputTypeActive(BatchInputFileSetType batchInputFileSetType)

Checks if the batch input type is active (can be used for upload).

Parameters:

BatchInputFileSetType - - input type to check is active

Returns:

boolean - true if type is active, false if not active

isFileUserIdentifierProperlyFormatted

boolean isFileUserIdentifierProperlyFormatted(String fileUserIdentifier)

Returns whether a file set identifier is properly formatted.

Parameters:

fileUserIdentifier -

Returns: