Package com._1c.g5.v8.dt.core.navigator.order.index

Interface IBmNavigatorOrderIndexProvider

  • public interface IBmNavigatorOrderIndexProvider
    Service that manages the navigator order index lifecycle.

    • Method Detail

      • clearObjectIndex

        void clearObjectIndex​(long bmObjectId)
        Clears the navigator order index from obsolete data.
        Parameters:
        bmObjectId - the bm object id to remove index for

      • clearFeatureOrder

        void clearFeatureOrder​(org.eclipse.emf.ecore.EObject object,
                       String featureName)
        Clears the navigator order index from obsolete data for the given object and its feature.
        Parameters:
        object - the object to get clear index for, cannot be null
        featureName - the feature name to clear objects order for, cannot be null

      • getObjectOrderDescription

        INavigatorOrderDescription getObjectOrderDescription​(org.eclipse.emf.ecore.EObject object)
        Returns the navigator order description for child objects of the given object and its feature.
        Parameters:
        object - the object to get order for, cannot be null
        featureName - the given object feature name to get feature value objects order description, cannot be null
        Returns:
        the navigator order description, may be null

      • updateObjectOrderDescription

        void updateObjectOrderDescription​(org.eclipse.emf.ecore.EObject object,
                                  INavigatorOrderDescription orderDescription)
        Updates the navigator order description for the given object.
        Parameters:
        object - the object to update order description for, cannot be null
        orderDescription - a new navigator order description, cannot be null

      • updateObjectsOrder

        void updateObjectsOrder​(org.eclipse.emf.ecore.EObject object,
                        String featureName,
                        Map<Long,​Integer> objectsOrder)
        Updates the navigator objects order for the given object and its feature.
        Parameters:
        object - the object to update order for, cannot be null
        featureName - the given object feature name to update feature value objects order, cannot be null
        objectsOrder - a new objects order, cannot be null

      • isAvailbale

        boolean isAvailbale()
        Tells whether the service is available.
        Returns:
        true if the service is available and false otherwise