connectivity/com.nokia.carbide.remoteConnections/src/com/nokia/carbide/remoteconnections/interfaces/IConnectionTypeProvider.java
author dadubrow
Fri, 18 Dec 2009 09:17:36 -0600
changeset 701 1912b5c050e6
parent 687 593d05f9d5ca
permissions -rw-r--r--
make disconnect api based on new connection interface
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     1
/*
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     2
* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     3
* All rights reserved.
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     4
* This component and the accompanying materials are made available
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     6
* which accompanies this distribution, and is available
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     8
*
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
     9
* Initial Contributors:
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    11
*
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    12
* Contributors:
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    13
*
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    14
* Description: 
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    15
*
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    16
*/
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    17
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    18
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    19
package com.nokia.carbide.remoteconnections.interfaces;
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    20
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    21
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    22
import java.util.Collection;
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    23
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    24
/**
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    25
 * An interface for accessing connection type extensions from their identifier
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    26
 * and compatible services from connection types
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    27
 */
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    28
public interface IConnectionTypeProvider {
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    29
687
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    30
	/**
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    31
	 * Returns IConnectionType corresponding to the id or null
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    32
	 * @param id String
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    33
	 * @return IConnectionType
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    34
	 */
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    35
	IConnectionType getConnectionType(String id);
0
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    36
	
687
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    37
	/**
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    38
	 * Returns all the known connection types
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    39
	 * @return Collection<IConnectionType>
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    40
	 */
0
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    41
	Collection<IConnectionType> getConnectionTypes();
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    42
	
687
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    43
	/**
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    44
	 * Returns a collection of IService that are supported over a connection type
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    45
	 * @param connectionType IConnectionType
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    46
	 * @return Collection<IService>
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    47
	 */
0
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    48
	Collection<IService> getCompatibleServices(IConnectionType connectionType);
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    49
687
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    50
	/**
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    51
	 * Returns IService corresponding to the id or null
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    52
	 * @param id String
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    53
	 * @return IService
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    54
	 */
0
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    55
	IService findServiceByID(String id);
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    56
	
687
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    57
	/**
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    58
	 * Returns a collection of connection type ids that support a service
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    59
	 * @param service IService
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    60
	 * @return Collection<String>
593d05f9d5ca Changes to remote connections
dadubrow
parents: 0
diff changeset
    61
	 */
0
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    62
	Collection<String> getCompatibleConnectionTypeIds(IService service);
fb279309251b DP tools release version Revision: 200912
Deepak Modgil <Deepak.Modgil@Nokia.com>
parents:
diff changeset
    63
}