org.cyclos.services.system

Interface RawFileService

All Superinterfaces:

Service

public interface RawFileService
extends Service

Service used to upload temp files and download the content of raw files

Author:

luis

Method Summary

Modifier and Type	Method and Description
java.util.List<RawFileVO>	listTemp(java.lang.String guestKey, CustomFieldVO customField) Lists the temporary files owned by the current user or guest.
RawFileVO	load(@NotNull java.lang.Long id) Loads a vo by id
SerializableInputStream	readContent(@NotNull java.lang.Long id) Reads the contents of the given file
void	remove(@NotNull java.lang.Long id) Removes the given file
void	removeAll(@NotNull java.util.List<java.lang.Long> ids) Removes the files with the given ids
void	saveName(@NotNull java.lang.Long id, java.lang.String name) Saves the name of the given file
RawFileVO	saveTemp(java.lang.String guestKey, CustomFieldVO customFieldVO, java.lang.String name, java.lang.String contentType, SerializableInputStream content) Saves the given file content.

Method Detail

listTemp

java.util.List<RawFileVO> listTemp(java.lang.String guestKey,
                                   CustomFieldVO customField)
                            throws FrameworkException

Lists the temporary files owned by the current user or guest. Guests are matched by guest key or remote address if none is given

Throws:

FrameworkException

load

RawFileVO load(@NotNull
               @NotNull java.lang.Long id)
        throws FrameworkException

Loads a vo by id

Throws:

FrameworkException

readContent

SerializableInputStream readContent(@NotNull
                                    @NotNull java.lang.Long id)
                             throws FrameworkException

Reads the contents of the given file

Throws:

FrameworkException

remove

void remove(@NotNull
            @NotNull java.lang.Long id)
     throws FrameworkException

Removes the given file

Throws:

FrameworkException

removeAll

void removeAll(@NotNull
               @NotNull java.util.List<java.lang.Long> ids)
        throws FrameworkException

Removes the files with the given ids

Throws:

FrameworkException

saveName

void saveName(@NotNull
              @NotNull java.lang.Long id,
              java.lang.String name)
       throws FrameworkException

Saves the name of the given file

Throws:

FrameworkException

saveTemp

RawFileVO saveTemp(java.lang.String guestKey,
                   CustomFieldVO customFieldVO,
                   java.lang.String name,
                   java.lang.String contentType,
                   SerializableInputStream content)
            throws FrameworkException

Saves the given file content. Temporary files are used for CustomFieldType.FILE custom field then it must be specified through the customFieldVO parameter and it must contains also the nature to allow load the correct custom field sub-class.

Throws:

FrameworkException