Package com._1c.g5.v8.dt.platform.services.core.runtimes

Interface IRuntimeInstallationLookup

All Known Implementing Classes:

AbstractRuntimeInstallationLookup, StandardLinuxLocationsRuntimeLookup, StandardWin32LocationsRuntimeLookup

public interface IRuntimeInstallationLookup

Describes an 1C:Enterprise runtime local installations lookup. 1C:Enterprise runtime installation lookups are defined by extensions. A 1C:Enterprise runtime installation lookup extension is defined in plugin.xml.
Following is an example definition of a 1C:Enterprise runtime installation lookup extension:

 <extension point="com._1c.g5.v8.dt.platform.services.core.runtimeInstallationLookups">
   <lookup
      class="com.example.ExampleLookupClass">
      runtimeType="com._1c.g5.v8.dt.platform.services.core.runtimeType.EnterprisePlatform"
   </lookup>
 </extension>
 

Defined 1C:Enterprise runtime installations lookups are automatically used for 1C:Enterprise runtime local installations lookup of the registered 1C:Enterprise runtime type. Lookup can search installations in the target folder or in standard search locations. Standard search locations are depending on OS or lookup implementation.

This interface is intended to be implemented and registered by clients.

Instances are not intended to be explicitly used by client. Clients may use IRuntimeInstallationManager instead.

See Also:

IRuntimeInstallationManager

Method Summary

Modifier and Type	Method	Description
Collection<RuntimeInstallation>	lookup(IRuntimeInstallationNameGenerator nameGenerator, IRuntimeInstallationDiscriminator discriminator, Collection<String> existingNames, org.eclipse.core.runtime.IProgressMonitor monitor)	Searches for local installations of 1C:Enterprise runtime in default locations.
Collection<RuntimeInstallation>	lookup(Path location, IRuntimeInstallationNameGenerator nameGenerator, IRuntimeInstallationDiscriminator discriminator, Collection<String> existingNames, org.eclipse.core.runtime.IProgressMonitor monitor)	Searches for local installations of 1C:Enterprise runtime in the target directory and all its sub-directories.

Method Detail

lookup

Collection<RuntimeInstallation> lookup(IRuntimeInstallationNameGenerator nameGenerator,
                                       IRuntimeInstallationDiscriminator discriminator,
                                       Collection<String> existingNames,
                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                throws org.eclipse.core.runtime.CoreException

Searches for local installations of 1C:Enterprise runtime in default locations. Default locations depends on the current OS.

The name generator can be used to generate unique name for found 1C:Enterprise runtime installations. The discriminator can be used to resolve version of found installation. Version resolving will be based on all registered resolver extensions.

Note that long running lookup operations can be cancelled by the client, and implementation is intended to check cancellation status of the provided progress monitor.

Parameters:

nameGenerator - the name generator for found 1C:Enterprise runtime installations, cannot be null

discriminator - the discriminator for found 1C:Enterprise runtime installations, cannot be null

existingNames - a collection of already existing 1C:Enterprise runtime installations names, delegate cannot create 1C:Enterprise runtime installation with any of these names, cannot be null

monitor - the progress monitor to report progress to and check cancellation status, cannot be null

Returns:

a list of 1C:Enterprise runtime installations, never null, can be empty, if none installations were found

Throws:

org.eclipse.core.runtime.CoreException - if installation lookup fails for some reason

See Also:

IRuntimeInstallationNameGenerator, IRuntimeInstallationDiscriminator

lookup

Collection<RuntimeInstallation> lookup(Path location,
                                       IRuntimeInstallationNameGenerator nameGenerator,
                                       IRuntimeInstallationDiscriminator discriminator,
                                       Collection<String> existingNames,
                                       org.eclipse.core.runtime.IProgressMonitor monitor)
                                throws org.eclipse.core.runtime.CoreException

Searches for local installations of 1C:Enterprise runtime in the target directory and all its sub-directories.

The name generator can be used to generate unique name for found 1C:Enterprise runtime installations. The discriminator can be used to resolve version of found installation. Version resolving will be based on all registered resolver extensions.

Note that long running lookup operations can be cancelled by the client, and implementation is intended to check cancellation status of the provided progress monitor.

Parameters:

location - the target directory to search 1C:Enterprise runtime installations in, cannot be null

nameGenerator - the name generator for found 1C:Enterprise runtime installations, cannot be null

discriminator - the discriminator for found 1C:Enterprise runtime installations, cannot be null

existingNames - a collection of already existing 1C:Enterprise runtime installations names, delegate cannot create 1C:Enterprise runtime installation with any of these names, cannot be null

monitor - the progress monitor to report progress to and check cancellation status, cannot be null

Returns:

a list of 1C:Enterprise runtime installations, never null, can be empty, if none installations were found

Throws:

org.eclipse.core.runtime.CoreException - if installation lookup fails for some reason

See Also:

IRuntimeInstallationNameGenerator, IRuntimeInstallationDiscriminator