connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/interfaces/IConnectionsManager.java
branchRCL_2_4
changeset 902 ce3a3250a628
parent 900 8b30bf718a17
child 1562 5f0fe8ab4e1b
equal deleted inserted replaced
900:8b30bf718a17 902:ce3a3250a628
    40 		void connectionStoreChanged();
    40 		void connectionStoreChanged();
    41 		void displayChanged();
    41 		void displayChanged();
    42 	}
    42 	}
    43 
    43 
    44 	/**
    44 	/**
       
    45 	 * Return value for IConnectionsManager.ensureConnection
       
    46 	 */
       
    47 	public interface ISelectedConnectionInfo {
       
    48 		IConnection getConnection();
       
    49 		String getStorableId();
       
    50 	}
       
    51 
       
    52 	/**
    45 	 * Internal method for loading connections from persisted state
    53 	 * Internal method for loading connections from persisted state
    46 	 * @deprecated
    54 	 * @deprecated
    47 	 */
    55 	 */
    48 	void loadConnections();
    56 	void loadConnections();
    49 
    57 
   181 	
   189 	
   182 	/**
   190 	/**
   183 	 * Can be called by specific service implementors (e.g., debugger) to ensure some connection
   191 	 * Can be called by specific service implementors (e.g., debugger) to ensure some connection
   184 	 * exists and supports this service. If the connection does not exist or does not support
   192 	 * exists and supports this service. If the connection does not exist or does not support
   185 	 * the service, a CoreException may be thrown after the framework attempts to allow the user
   193 	 * the service, a CoreException may be thrown after the framework attempts to allow the user
   186 	 * to correct the situation. If an IConnection is returned, it is assumed to be 
   194 	 * to correct the situation by showing a connection selection dialog. 
   187 	 * a valid connection in the system that supports the service.
   195 	 * If an ISelectedConnectionInfo is returned, {@link ISelectedConnectionInfo#getConnection()} 
       
   196 	 * is assumed to be a valid connection in the system that supports the service 
       
   197 	 * and {@link ISelectedConnectionInfo#getStorableId()} is the id that can
       
   198  	 * be stored by the caller that represents the user's selection.
   188 	 * @param connectionId String
   199 	 * @param connectionId String
   189 	 * @param service IService
   200 	 * @param service IService
   190 	 * @return IConnection
   201 	 * @return ISelectedConnectionInfo
   191 	 * @throws CoreException
   202 	 * @throws CoreException
   192 	 * @since 2.5
   203 	 * @since 2.5
   193 	 */
   204 	 */
   194 	IConnection ensureConnection(String connectionId, IService service) throws CoreException;
   205 	ISelectedConnectionInfo ensureConnection(String connectionId, IService service) throws CoreException;
   195 	
   206 	
   196 	/**
   207 	/**
   197 	 * Returns a connection from an id (including the current connection id) or null if none found.
   208 	 * Returns a connection from an id (including the current connection id) or null if none found.
   198 	 * @param connectionId String
   209 	 * @param connectionId String
   199 	 * @param service IService
   210 	 * @param service IService