Package com.e1c.g5.v8.dt.form.extension

Interface IFormExtensionManagementService

All Known Implementing Classes:
FormExtensionManagementService
public interface IFormExtensionManagementService
Extensiond management facility which is responsible to support the adoption process

  • Method Details

    • addAdoptChangeListener

      void addAdoptChangeListener(IAdoptEventListener listener)
      Adds adopt process status listener.
      Parameters:
      listener - event listener, cannot be null

    • adoptObject

      void adoptObject(Object object)
      Adopts form object
      Parameters:
      eObject - The object to adop

    • fireAdoptEvent

      void fireAdoptEvent(Form form, AdoptStatus status)
      Trigger event on adopt process
      Parameters:
      form - form to be adopted, cannot be null
      status - adopt process status, cannot be null

    • getAdopted

      Boolean getAdopted(Object object)
      Gets the adopted status of the object (if applicable). Checks the hierarchy of the object to find the nearest adopted status
      Parameters:
      object - The object to get adopted status for. May not be null
      Returns:
      The adopted status of the object. null means the non-adopted native element of the form

    • isAdoptedObject

      boolean isAdoptedObject(Object object)
      Returns true if the object was adopted from source form
      Parameters:
      object - the object being examined, cannot be null
      Returns:
      true if the object was adopted from source form

    • isAutoAdoptedObject

      boolean isAutoAdoptedObject(Object object)
      Returns true if the object is in source form and not adopted
      Parameters:
      object - the object being examined, cannot be null
      Returns:
      true if the object is in source form and not adopted

    • isOwnExtensionObject

      boolean isOwnExtensionObject(Object object)
      Returns true if the object was created in form extension
      Parameters:
      object - the object being examined, cannot be null
      Returns:
      true if the object was created in form extension

    • isUnchangedObject

      boolean isUnchangedObject(Object object)
      Checks if the given object is unchanged according to the rules of the form adoption
      Parameters:
      object - The object to check. May not be null
      Returns:
      True if the object was changed by the user/service

    • removeAdoptChangeListener

      void removeAdoptChangeListener(IAdoptEventListener listener)
      Removes event listener
      Parameters:
      listener - the event listener to remove (not null)

    • getChangedFormItemFeatures

      Collection<org.eclipse.emf.ecore.EStructuralFeature> getChangedFormItemFeatures(FormVisualEntity formVisualEntity)
      Returns collection of all unchanged features of the form item. The given form item should be from adopted form.
      Parameters:
      formVisualEntity - the form visual entity, cannot be null
      Returns:
      collection of all unchanged features of the form visual entity or empty collection for not adopted or non-extension form, never null

    • isExtensionBelongingUnderlyingObject

      boolean isExtensionBelongingUnderlyingObject(Object element)
      Returns true if underlying object of form data item has been created from the extension or adopted to the extension by user.
      Parameters:
      element - some form object, cannot be null
      Returns:
      true if underlying object has been created from the extension or adopted to the extension by user

    • isExtensionBelongingUnderlyingObject

      boolean isExtensionBelongingUnderlyingObject(AbstractDataPath dataPath, Form form)
      Returns true if data path belongs to the extension
      Parameters:
      dataPath - the data path to check, can be null
      form - , the form, cannot be null
      Returns:

    • isExtensionBelongingUnderlyingObject

      boolean isExtensionBelongingUnderlyingObject(DataItem dataItem)
      Returns true if underlying object (Command or FormAttribute) of form data item has been created from the extension or adopted to the extension by user.
      Parameters:
      dataItem - some form data item (either Button or FormField), cannot be null
      Returns:
      true if underlying object has been created from the extension or adopted to the extension by user