Package com._1c.g5.v8.dt.platform.services.core.infobases.sync.connections

Interface IInfobaseConnectionFactory

public interface IInfobaseConnectionFactory

Factory for infobase connections.

See Also:

IInfobaseConnection

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IInfobaseConnectionFactory.IInfobaseConnectionDescription	Describes infobase connection.

Method Summary

Modifier and Type	Method	Description
IInfobaseConnection	create(org.eclipse.core.resources.IProject project)	Create the infobase connection with default type for the given project.
IInfobaseConnection	create(org.eclipse.core.resources.IProject project, String connectionTypeId)	Create the infobase connection with the given type for the given project.
String	getDefaultConnectionTypeId(org.eclipse.core.resources.IProject project)	Returns the default connection type identifier for the given project.
IInfobaseConnectionFactory.IInfobaseConnectionDescription	getInfobaseConnectionDescription(String connectionTypeId)	Returns infobase connection description about infobase connection with the given identifier.
Collection<IInfobaseConnectionFactory.IInfobaseConnectionDescription>	getInfobaseConnectionDescriptions()	Returns a collection of all descriptions for registered infobase connections.
Collection<IInfobaseConnectionFactory.IInfobaseConnectionDescription>	getInfobaseConnectionDescriptions(org.eclipse.core.resources.IProject project)	Returns a collection of all registered infobase connections, that can be used for the given project.

Method Detail

getDefaultConnectionTypeId

String getDefaultConnectionTypeId(org.eclipse.core.resources.IProject project)

Returns the default connection type identifier for the given project.

Parameters:

project - the project to get default connection type identifier for, cannot be null

Returns:

the default connection type identifier for the given project, never null

Throws:

UnsupportedVersionException - if the given project has unsupported version

getInfobaseConnectionDescription

IInfobaseConnectionFactory.IInfobaseConnectionDescription getInfobaseConnectionDescription(String connectionTypeId)

Returns infobase connection description about infobase connection with the given identifier.

Parameters:

id - the infobase connection identifier, cannot be null

Returns:

the infobase connection description about infobase connection with the given identifier, never null

getInfobaseConnectionDescriptions

Collection<IInfobaseConnectionFactory.IInfobaseConnectionDescription> getInfobaseConnectionDescriptions()

Returns a collection of all descriptions for registered infobase connections.

Returns:

a collection of all descriptions for registered infobase connections, never null

getInfobaseConnectionDescriptions

Collection<IInfobaseConnectionFactory.IInfobaseConnectionDescription> getInfobaseConnectionDescriptions(org.eclipse.core.resources.IProject project)

Returns a collection of all registered infobase connections, that can be used for the given project.

Returns:

a collection of registered infobase connections, never null

create

IInfobaseConnection create(org.eclipse.core.resources.IProject project)

Create the infobase connection with default type for the given project.

Parameters:

project - the project to create infobase connection for, cannot be null

Returns:

the infobase connection with default type, never null

Throws:

UnsupportedVersionException - if the given project has unsupported version

create

IInfobaseConnection create(org.eclipse.core.resources.IProject project,
                           String connectionTypeId)

Create the infobase connection with the given type for the given project.

Parameters:

project - the project to create infobase connection for, cannot be null

id - the infobase connection type identifier, cannot be null

Returns:

the infobase connection with the given type, never null

Throws:

UnsupportedVersionException - if the given project has unsupported version