com.highqsoft.xsd

Interface TransferIF

All Superinterfaces:

ImplementationIF

All Known Implementing Classes:

FileServer

public interface TransferIF
extends ImplementationIF

This is the interface that a object must fulfill that be useable for an transfer tag of the filetransfer element.

Since:

$Date: 2017/04/06 13:30:31 $

Version:

$Revision: 1.10 $

Author:

Andreas Hofmann

See Also:

ImplementationIF

Method Summary

Methods

Modifier and Type	Method and Description
void	delete(java.lang.String name) Delete the data associated with the given name.
void	deleteForInstance(java.lang.String name, T_LONGLONG aid, T_LONGLONG iid) Delete the data associated with the given name.
java.io.InputStream	read(java.lang.String name) Read the data associated with the given name.
java.io.InputStream	readForInstance(java.lang.String name, T_LONGLONG aid, T_LONGLONG iid) Read the data associated with the given name.
java.lang.String	save(java.lang.String name, java.lang.String subDir, java.io.InputStream stream) Save the data associated with the given intput stream.
java.lang.String	saveForInstance(java.lang.String name, java.lang.String subDir, T_LONGLONG aid, T_LONGLONG iid, java.io.InputStream stream) Save the data associated with the given intput stream.
void	setSessionRef(java.lang.String referenceName) Set the session reference to that this transferable belongs.

Methods inherited from interface com.highqsoft.xsd.ImplementationIF

getContext, getDescriptor, init, setArguments, setContext, setDescriptor

Method Detail

setSessionRef

void setSessionRef(java.lang.String referenceName)

Set the session reference to that this transferable belongs.

Parameters:

referenceName - the reference name.

save

java.lang.String save(java.lang.String name,
                    java.lang.String subDir,
                    java.io.InputStream stream)
                      throws java.lang.Exception

Save the data associated with the given intput stream.

Parameters:

name - the name of the file.

subDir - an alternative sub directory, that can be specified, if the filename should not used to determine the destination folder.

stream - the input stream, ready to read by the server.

Returns:

the url string of the created file.

Throws:

java.lang.Exception

saveForInstance

java.lang.String saveForInstance(java.lang.String name,
                               java.lang.String subDir,
                               T_LONGLONG aid,
                               T_LONGLONG iid,
                               java.io.InputStream stream)
                                 throws java.lang.Exception

Save the data associated with the given intput stream. Specify the ApplicationElement id and the InstanceElement id of the component that holds the external reference.

Parameters:

name - the name of the file.

subDir - an alternative sub directory, that can be specified, if the filename should not used to determine the destination folder.

aid - the application element id.

iid - the instance element id.

stream - the input stream, ready to read by the server.

Returns:

the url string of the created file.

Throws:

java.lang.Exception

delete

void delete(java.lang.String name)
            throws java.lang.Exception

Delete the data associated with the given name.

Parameters:

name - the name of the file.

Throws:

java.lang.Exception

deleteForInstance

void deleteForInstance(java.lang.String name,
                     T_LONGLONG aid,
                     T_LONGLONG iid)
                       throws java.lang.Exception

Delete the data associated with the given name. Specify the ApplicationElement id and the InstanceElement id of the component that holds the external reference.

Parameters:

name - the name of the file.

Throws:

java.lang.Exception

read

java.io.InputStream read(java.lang.String name)
                         throws java.lang.Exception

Read the data associated with the given name.

Parameters:

name - the name of the file.

Returns:

stream the input stream, ready to read by the server.

Throws:

java.lang.Exception

readForInstance

java.io.InputStream readForInstance(java.lang.String name,
                                  T_LONGLONG aid,
                                  T_LONGLONG iid)
                                    throws java.lang.Exception

Read the data associated with the given name.

Parameters:

name - the name of the file.

aid - the application element id.

iid - the instance element id.

Returns:

stream the input stream, ready to read by the server.

Throws:

java.lang.Exception