Interface IDesignElement

All Superinterfaces:
IWidget, IWritable, IXmlSerializable, Serializable
All Known Subinterfaces:
IBaseDesignManualTask, IDesignAbortTask, IDesignAction, IDesignAndJoin, IDesignAnnotation, IDesignApplicationManualTask, IDesignBlock, IDesignCellBlock, IDesignComponent, IDesignConnectorTreatmentTask, IDesignContentComponent, IDesignEmbeddedWorkflowTask, IDesignEndTask, IDesignField, IDesignFieldLabel, IDesignFieldTreatmentTask, IDesignForm, IDesignFormBlock, IDesignLineBlock, IDesignLink, IDesignManualTask, IDesignParallel, IDesignProperty, IDesignRoleTreatmentTask, IDesignScriptTreatmentTask, IDesignSectionBlock, IDesignStartTask, IDesignStateTreatmentTask, IDesignTableBlock, IDesignTask, IDesignTest, IDesignTreatmentGroupTask, IDesignTreatmentTask, IDesignWorkflow, InputConnectionPoint, ISelectionSupport, OutputConnectionPoint

public interface IDesignElement extends IWidget, IXmlSerializable
The base interface of all user interface objects.
Since:
1.0, 28/10/2010
Author:
vlygeros
  • Method Details

    • getId

      String getId()
      Gets the identifier of the designed object.
      Returns:
      A java.lang.String object.
    • getUniqueName

      String getUniqueName()
      Gets the unique name representing the designed object.
      Returns:
      A java.lang.String object.
    • getUniqueGroupName

      String getUniqueGroupName()
      Specifies a unique group name to check design object system name on. The default value is getUniqueName().
      Returns:
      A java.lang.String object.
    • getLinkedDesignElementsGroupName

      String getLinkedDesignElementsGroupName()
      Specifies a unique group name with other linked design objects to check system name on.
      Returns:
      A java.util.List object.
    • isVolatile

      boolean isVolatile()
      Checks whether a design object is stored or not.
      Returns:
      false if the design object is stored, true otherwise.
    • isEmbedded

      boolean isEmbedded()
      Checks whether a design object is embedded into a group such as the IDesignTreatmentTask objects embedded into a IDesignTreatmentGroupTask object.
      Returns:
      false if the design object is embedded, true otherwise.
    • isDirty

      boolean isDirty()
      Checks whether a design object is dirty and needs to be rendered.
      Returns:
      true if the design object is dirty, false otherwise.
    • isPersistent

      boolean isPersistent()
      Checks if the design object has been stored.
      Returns:
      true if the object has been stored, false otherwise.
    • setDirty

      void setDirty(boolean isDirty)
      Sets the design object dirty flag.
      Parameters:
      isDirty - The new value to set to.
    • delete

      void delete(IContext context)
      Deletes a design object.
      Parameters:
      context - The execution context of the user.
    • getContainer

      IDesignContainer getContainer()
      Gets the container.
      Returns:
      A IDesignContainer object.
    • allowRemove

      boolean allowRemove()
      Checks whether a design object is removable and needs to be rendered.
      Returns:
      true if the design object is dirty, false otherwise.
    • setAllowRemove

      void setAllowRemove(boolean isRemovable)
      Sets the design object removable flag.
      Parameters:
      isRemovable - The new value to set to.
    • verify

      List<DesignReport> verify()