Interface IMdObjectAvailability


  • public interface IMdObjectAvailability
    Metadata object availiability allows clients to check whether the provided metadata objects or metadata classes are currently available, based on some object properties or parent configuration properties.

    Note that avaliability is defined for metadata top level objects only, so clients need to provide top level metadata objects or classes to the check methods. Otherwise, false will be returned.

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean isAvailable​(org.eclipse.emf.ecore.EClass eClass, IV8Project v8project)
      Returns whether the provided metadata class is currently available in the provided V8 project.
      boolean isAvailable​(org.eclipse.emf.ecore.EClass eClass, org.eclipse.emf.ecore.EObject context)
      Returns whether the provided metadata class is currently available in the V8 project of the provided context object (some of the target V8 project object).
      boolean isAvailable​(org.eclipse.emf.ecore.EObject eObject)
      Returns whether the provided metadata object is currently available.
      boolean isAvailable​(org.eclipse.emf.ecore.EObject eObject, IV8Project v8project)
      Returns whether the provided metadata object is currently available in the provided V8 project.
      boolean isAvailable​(org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature feature)
      Returns whether the feature of the provided metadata object is currently available.
      boolean isAvailable​(org.eclipse.emf.ecore.EObject eObject, org.eclipse.emf.ecore.EStructuralFeature feature, IV8Project v8project)
      Returns whether the feature of the provided metadata object is currently available in the provided V8 project.
      boolean markAsDisabled​(org.eclipse.emf.ecore.EClass eClass, org.eclipse.emf.ecore.EObject context)
      Returns whether the provided metadata object class is currently unavailable and need to be marked as disabled.
      boolean markAsDisabled​(org.eclipse.emf.ecore.EObject eObject)
      Returns whether the provided metadata object is currently unavailable and need to be marked as disabled.
    • Method Detail

      • isAvailable

        boolean isAvailable​(org.eclipse.emf.ecore.EObject eObject)
        Returns whether the provided metadata object is currently available. Top level metadata object is expected, false will be returned otherwise.

        This is convenience method, fully equivalent to:

         isAvailable(eObject, v8projectManager.getProject(eObject))
         
        Parameters:
        eObject - the metadata object to check availability, cannot be null
        Returns:
        whether the provided metadata object is currently available
      • isAvailable

        boolean isAvailable​(org.eclipse.emf.ecore.EObject eObject,
                            org.eclipse.emf.ecore.EStructuralFeature feature)
        Returns whether the feature of the provided metadata object is currently available. Top level metadata object is expected, false will be returned otherwise.

        This is convenience method, fully equivalent to:

         isAvailable(eObject, feature, v8projectManager.getProject(eObject))
         
        Parameters:
        eObject - the metadata object to check feature availability in, cannot be null
        feature - the context feature to check availability, cannot be null
        Returns:
        whether the provided metadata object is currently available
      • isAvailable

        boolean isAvailable​(org.eclipse.emf.ecore.EObject eObject,
                            IV8Project v8project)
        Returns whether the provided metadata object is currently available in the provided V8 project. Top level metadata object is expected, false will be returned otherwise.
        Parameters:
        eObject - the metadata object to check availability, cannot be null
        v8project - the V8 project to check in, cannot be null
        Returns:
        whether the provided metadata object is currently available
      • isAvailable

        boolean isAvailable​(org.eclipse.emf.ecore.EObject eObject,
                            org.eclipse.emf.ecore.EStructuralFeature feature,
                            IV8Project v8project)
        Returns whether the feature of the provided metadata object is currently available in the provided V8 project. Top level metadata object is expected, false will be returned otherwise.
        Parameters:
        eObject - the metadata object to check feature availability in, cannot be null
        feature - the context feature to check availability, cannot be null
        v8project - the V8 project to check in, cannot be null
        Returns:
        whether the provided metadata object is currently available
      • isAvailable

        boolean isAvailable​(org.eclipse.emf.ecore.EClass eClass,
                            IV8Project v8project)
        Returns whether the provided metadata class is currently available in the provided V8 project. Top level metadata object class is expected, false will be returned otherwise.
        Parameters:
        eClass - the metadata class to check availability, cannot be null
        v8project - the V8 project to check in, cannot be null
        Returns:
        whether the provided metadata class is currently available in the provided V8 project
      • isAvailable

        boolean isAvailable​(org.eclipse.emf.ecore.EClass eClass,
                            org.eclipse.emf.ecore.EObject context)
        Returns whether the provided metadata class is currently available in the V8 project of the provided context object (some of the target V8 project object). Top level metadata object class is expected, false will be returned otherwise.

        This is convenience method, fully equivalent to:

         isAvailable(eClass, v8projectManager.getProject(context))
         
        Parameters:
        eClass - the metadata class to check availability, cannot be null
        context - the context V8 project object, cannot be null
        Returns:
        whether the provided metadata class is currently available in the V8 project of the provided context object
      • markAsDisabled

        boolean markAsDisabled​(org.eclipse.emf.ecore.EObject eObject)
        Returns whether the provided metadata object is currently unavailable and need to be marked as disabled. Top level metadata object is expected, false will be returned otherwise.
        Parameters:
        eObject - the metadata object to check availability, cannot be null
        v8project - the V8 project to check in, cannot be null
        Returns:
        whether the provided metadata object is currently unavailable and need to be marked as disabled
      • markAsDisabled

        boolean markAsDisabled​(org.eclipse.emf.ecore.EClass eClass,
                               org.eclipse.emf.ecore.EObject context)
        Returns whether the provided metadata object class is currently unavailable and need to be marked as disabled. Top level metadata object is expected, false will be returned otherwise.
        Parameters:
        eClass - the metadata class to check availability, cannot be null
        context - the context V8 project object, cannot be null
        Returns:
        whether the provided metadata object class is currently unavailable and need to be marked as disabled