connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/interfaces/IConnectionsManager.java
changeset 761 19123c07e2ab
parent 759 d4aeef4e0f16
child 899 b5675f3e69ad
equal deleted inserted replaced
760:f83ff2d4e9d2 761:19123c07e2ab
    53 	 */
    53 	 */
    54 	void storeConnections();
    54 	void storeConnections();
    55 
    55 
    56 	
    56 	
    57 	/**
    57 	/**
    58 	 * Listener interface for connections which are added, removed and set as default
    58 	 * Listener interface for connections which are added, removed and set as current
    59 	 * @since 3.0
    59 	 * @since 3.0
    60 	 */
    60 	 */
    61 	public interface IConnectionListener {
    61 	public interface IConnectionListener {
    62 		void connectionAdded(IConnection connection);
    62 		void connectionAdded(IConnection connection);
    63 		void connectionRemoved(IConnection connection);
    63 		void connectionRemoved(IConnection connection);
    64 		void defaultConnectionSet(IConnection connection);
    64 		void currentConnectionSet(IConnection connection);
    65 	}
    65 	}
    66 	
    66 	
    67 	/**
    67 	/**
    68 	 * Add a listener for internal connection manager events
    68 	 * Add a listener for internal connection manager events
    69 	 * @param listener IConnectionsManagerListener
    69 	 * @param listener IConnectionsManagerListener
   153 	 * @since 3.0
   153 	 * @since 3.0
   154 	 */
   154 	 */
   155 	void removeConnectionListener(IConnectionListener listener);
   155 	void removeConnectionListener(IConnectionListener listener);
   156 
   156 
   157 	/**
   157 	/**
   158 	 * Sets the default connection.
   158 	 * Sets the current connection.
   159 	 * @param connection IConnection
   159 	 * @param connection IConnection
   160 	 * @since 3.0
   160 	 * @since 3.0
   161 	 */
   161 	 */
   162 	void setDefaultConnection(IConnection connection);
   162 	void setCurrentConnection(IConnection connection);
   163 	
   163 	
   164 	/**
   164 	/**
   165 	 * Returns the default connection.
   165 	 * Returns the current connection.
   166 	 * @return IConnection
   166 	 * @return IConnection
   167 	 * @since 3.0
   167 	 * @since 3.0
   168 	 */
   168 	 */
   169 	IConnection getDefaultConnection();
   169 	IConnection getCurrentConnection();
   170 	
   170 	
   171 	/**
   171 	/**
   172 	 * Returns the IClientServiceSiteUI2 for a service. Filters connection types to those that
   172 	 * Returns the IClientServiceSiteUI2 for a service. Filters connection types to those that
   173 	 * are supported by the service. Connection list UI as well as new and edit wizards are filtered.
   173 	 * are supported by the service. Connection list UI as well as new and edit wizards are filtered.
   174 	 * Allows selecting a "default" connection which maps to #getDefaultConnection()
   174 	 * Allows selecting a "current" connection which maps to #getCurrentConnection()
   175 	 * when you use #ensureConenction().
   175 	 * when you use #ensureConenction().
   176 	 * @param service IService
   176 	 * @param service IService
   177 	 * @return IClientServiceSiteUI2
   177 	 * @return IClientServiceSiteUI2
   178 	 * @since 3.0
   178 	 * @since 3.0
   179 	 */
   179 	 */
   192 	 * @since 3.0
   192 	 * @since 3.0
   193 	 */
   193 	 */
   194 	IConnection ensureConnection(String connectionId, IService service) throws CoreException;
   194 	IConnection ensureConnection(String connectionId, IService service) throws CoreException;
   195 	
   195 	
   196 	/**
   196 	/**
   197 	 * Returns a connection from an id (including the default connection id) or null if none found.
   197 	 * Returns a connection from an id (including the current connection id) or null if none found.
   198 	 * @param connectionId String
   198 	 * @param connectionId String
   199 	 * @param service IService
   199 	 * @param service IService
   200 	 * @return IConnection
   200 	 * @return IConnection
   201 	 * @throws CoreException
   201 	 * @throws CoreException
   202 	 * @since 3.0
   202 	 * @since 3.0