Interface TransferSession

public interface TransferSession extends Transfer
{
  // Methods
  public void deleteSource();
  public int getAvailableEffects();
  public int getPreferredEffects();
  public MetaObject getTransferData();
}

This interface defines a data transfer session abstraction that is used to describe a transfer operation. The source of a transfer creates a TransferSession and then initiates the transfer. During data transfer, a recipient obtains a TransferSession and acts on it by interrogating it for the transfer effects supported and the data being transferred.

Transfer
  |
  +--TransferSession

Methods

deleteSource

public void deleteSource();

Deletes the source data. This method facilitates MOVE operations where the destination is only capable of performing a COPY operation. That is, instead of performing a MOVE operation, a COPY operation can be performed and then the data can be deleted from the source.

Return Value:

No return value.

getAvailableEffects

public int getAvailableEffects();

Retrieves the Transfer effects that are available in the session.

Return Value:

Returns a value that identifies the available transfer effects. It can be any one (or a combination of) the following values:

NONE,

COPY,

MOVE, or

LINK.

getPreferredEffects

public int getPreferredEffects();

Retrieves the Transfer effects that are preferred by the originator of the session.

Return Value:

Returns a value that identifies the preferred transfer effects. It can be any one (or a combination of) the following values:

NONE,

COPY,

MOVE, or

LINK.

getTransferData

public MetaObject getTransferData();

Retrieves the data that is associated with the session.

Return Value:

Returns a MetaObject that represents the data offered for transfer.