org.gersteinlab.tyna.webservice
Interface TYNA

All Superinterfaces:
java.rmi.Remote
All Known Implementing Classes:
TYNASoapBindingImpl

public interface TYNA
extends java.rmi.Remote

        This interface defines the tYNA web service.
        

Version:
1.0 (May 27, 2006) Change History: 1.0 - Initial version
Author:
Kevin Yuk-Lap Yip

Method Summary
 java.lang.String downloadNetwork(java.lang.String username, java.lang.String password, int networkId, int networkFormatId)
          Download a network from the tYNA database.
 NetworkFormat[] listNetworkFormats()
          List the network formats supported by tYNA.
 Network[] listNetworks(java.lang.String username, java.lang.String password, java.lang.String listType)
          List the metadata of the networks in the tYNA database.
 NetworkType[] listNetworkTypes()
          List the network types supported by tYNA.
 void uploadNetwork(java.lang.String username, java.lang.String password, java.lang.String networkData, Network networkMetadata)
          Upload a network into the tYNA database.
 

Method Detail

listNetworks

Network[] listNetworks(java.lang.String username,
                       java.lang.String password,
                       java.lang.String listType)
                       throws java.rmi.RemoteException
List the metadata of the networks in the tYNA database.

Parameters:
username - The login name of ther user, null if not required
password - The password of the user, null if not required
listType - List type: "private" for private ones (must be owned) only "owned" for owned ones (public or private) only "" for owned or public
Returns:
An array of Network objects that describe the metadata of the networks
Throws:
java.rmi.RemoteException - If any problem occurs during the listing process

listNetworkFormats

NetworkFormat[] listNetworkFormats()
                                   throws java.rmi.RemoteException
List the network formats supported by tYNA.

Returns:
An array of NetworkFormat objects that describe the network formats
Throws:
java.rmi.RemoteException - If any problem occurs during the listing process

listNetworkTypes

NetworkType[] listNetworkTypes()
                               throws java.rmi.RemoteException
List the network types supported by tYNA.

Returns:
An array of NetworkType objects that describe the network types
Throws:
java.rmi.RemoteException - If any problem occurs during the listing process

uploadNetwork

void uploadNetwork(java.lang.String username,
                   java.lang.String password,
                   java.lang.String networkData,
                   Network networkMetadata)
                   throws java.rmi.RemoteException
Upload a network into the tYNA database.

Parameters:
username - The login name of the user, null if not required
password - The password of the user, null if not required
networkData - The network serialized as a string
networkMetadata - The metadata of the network
Throws:
java.rmi.RemoteException - If any problem occurs during the upload process

downloadNetwork

java.lang.String downloadNetwork(java.lang.String username,
                                 java.lang.String password,
                                 int networkId,
                                 int networkFormatId)
                                 throws java.rmi.RemoteException
Download a network from the tYNA database.

Parameters:
username - The login name of ther user, null if not required
password - The password of the user, null if not required
networkId - The ID of the network
networkFormatId - The ID of the serialization format
Returns:
The serialized network
Throws:
java.rmi.RemoteException - If any problem occurs during the download process