Interface IExecutionEnvironment

  • All Superinterfaces:
    Comparable<IExecutionEnvironment>

    public interface IExecutionEnvironment
    extends Comparable<IExecutionEnvironment>
    An execution environment describes some range of 1C:Enterprise runtime installations, starting with some version mask. Examples of the execution environment:
    • <8.3>
    • <8.3.8>

    Execution environment can be resolved any time to the 1C:Enterprise runtime installation with the next rules:

    • The default 1C:Enterprise runtime installation for this range, if was specified
    • The latest 1C:Enterprise runtime installation for this range, if none default was specified

    Clients may use IExecutionEnvironmentProvider to get all environments.

    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.
    • Method Detail

      • getName

        String getName()
        Returns UI-representable name of the execution environment.
        Returns:
        the name of the execution environment, never null
      • getVersionMask

        String getVersionMask()
        Returns the version mask, appropriate for this execution environment.
        Returns:
        the version mask, appropriate for this execution environment, never null
      • getDefault

        RuntimeInstallation getDefault​(String runtimeTypeId)
        Returns the default 1C:Enterprise runtime installation, that is specified for this execution environment. Can return null if none default installation was specified.
        Parameters:
        runtimeTypeId - the 1C:Enterprise runtime type id to get default for, cannot be null
        Returns:
        the default 1C:Enterprise runtime installation or null if none was specified
      • setDefault

        void setDefault​(RuntimeInstallation installation)
        Sets the default 1C:Enterprise runtime installation to use by this execution environment.
        Parameters:
        installation - the default 1C:Enterprise runtime installation to use, cannot be null
      • clearDefault

        void clearDefault​(String runtimeTypeId)
        Clears the default 1C:Enterprise runtime installation to use by this execution environment.
        Parameters:
        runtimeTypeId - the 1C:Enterprise runtime type id to clear default for, cannot be null
      • get

        RuntimeInstallation get​(String runtimeTypeId)
                         throws MatchingRuntimeNotFound
        Resolves the 1C:Enterprise installation to use for this execution environment.
        Parameters:
        runtimeTypeId - the 1C:Enterprise runtime type id to get installation for, cannot be null
        Returns:
        the resolved 1C:Enterprise installation, never null
        Throws:
        MatchingRuntimeNotFound - if matching 1C:Enterprise runtime installation was not found
      • get

        RuntimeInstallation get​(String runtimeTypeId,
                                String... componentTypeIds)
                         throws MatchingRuntimeNotFound
        Resolves the 1C:Enterprise installation to use for this execution environment, that have specified 1C:Enterprise runtime components.
        Parameters:
        runtimeTypeId - the 1C:Enterprise runtime type id to get installation for, cannot be null
        componentTypeIds - components identifiers, cannot be null
        Returns:
        the resolved 1C:Enterprise installation, never null
        Throws:
        MatchingRuntimeNotFound - if matching 1C:Enterprise runtime installation was not found
      • get

        RuntimeInstallation get​(String runtimeTypeId,
                                Predicate<RuntimeInstallation> filter)
                         throws MatchingRuntimeNotFound
        Resolves the 1C:Enterprise installation to use for this execution environment, that satisfy the provided filter.
        Parameters:
        runtimeTypeId - the 1C:Enterprise runtime type id to get installation for, cannot be null
        filter - the filter for 1C:Enterprise installation, cannot be null
        Returns:
        the resolved 1C:Enterprise installation, never null
        Throws:
        MatchingRuntimeNotFound - if matching 1C:Enterprise runtime installation was not found
      • get

        RuntimeInstallation get​(String runtimeTypeId,
                                Predicate<RuntimeInstallation> filter,
                                Comparator<RuntimeInstallation> order)
                         throws MatchingRuntimeNotFound
        Resolves the 1C:Enterprise installation to use for this execution environment, that satisfy the provided filter and additionaly maximises the provided order.
        Parameters:
        runtimeTypeId - the 1C:Enterprise runtime type id to get installation for, cannot be null
        filter - the filter for 1C:Enterprise installation, cannot be null
        Returns:
        the resolved 1C:Enterprise installation, never null
        Throws:
        MatchingRuntimeNotFound - if matching 1C:Enterprise runtime installation was not found