|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BatchInputFileService
Interface defining methods to manage batch input files.
Method Summary | |
---|---|
boolean |
isBatchInputTypeActive(BatchInputFileType batchInputFileType)
Checks if the batch input type is active (can be used for upload). |
boolean |
isFileUserIdentifierProperlyFormatted(String fileUserIdentifier)
Returns whether a file user identifier is properly formatted. |
List<String> |
listBatchTypeFilesForUser(BatchInputFileType batchInputFileType,
org.kuali.rice.kim.bo.Person user)
Returns a list of batch type file names (without path) that the given user has permissions to manage. |
List<String> |
listInputFileNamesWithDoneFile(BatchInputFileType batchInputFileType)
Returns a list of existing input files for the batch type that have an associated .done file |
Object |
parse(BatchInputFileType batchInputFileType,
byte[] fileByteContent)
Unmarshalls the file contents to an Object using the digestor and digestor rules file specified in the batch input type. |
String |
save(org.kuali.rice.kim.bo.Person user,
BatchInputFileType inputType,
String fileUserIdentifier,
InputStream fileContents,
Object parsedObject)
Stores the inputstream as a file on the server, identified by the given user file name. |
boolean |
validate(BatchInputFileType inputType,
Object parsedObject)
Using the input type object parses and validates the file contents by calling validate on the batch input type. |
Method Detail |
---|
Object parse(BatchInputFileType batchInputFileType, byte[] fileByteContent)
batchInputFileType
- - batch input file type for the file to parsefileByteContent
- - byte contents of file to parse
boolean validate(BatchInputFileType inputType, Object parsedObject)
inputType
- - instance of a BatchInputFileTypeparsedObject
- - the Object built from parsing xml contents
String save(org.kuali.rice.kim.bo.Person user, BatchInputFileType inputType, String fileUserIdentifier, InputStream fileContents, Object parsedObject) throws org.kuali.rice.kns.exception.AuthorizationException, FileStorageException
user
- - user who is requesting the saveinputType
- - instance of a BatchInputFileTypefileUserIdentifier
- - file identifier specified by userfileContents
- - contents of the uploaded fileparsedObject
- - object parsed from the input file
FileStorageException
- - if errors were encountered while attempting to write the file
org.kuali.rice.kns.exception.AuthorizationException
boolean isBatchInputTypeActive(BatchInputFileType batchInputFileType)
batchInputFileType
- - input type to check is active
List<String> listBatchTypeFilesForUser(BatchInputFileType batchInputFileType, org.kuali.rice.kim.bo.Person user) throws org.kuali.rice.kns.exception.AuthorizationException
user
- - user for checking permissions
org.kuali.rice.kns.exception.AuthorizationException
List<String> listInputFileNamesWithDoneFile(BatchInputFileType batchInputFileType)
batchInputFileType
- - batch type to retieve files for
boolean isFileUserIdentifierProperlyFormatted(String fileUserIdentifier)
fileUserIdentifier
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |