Interface DerivedElementsEditorBean

    • Method Detail

      • getUnitId

        java.lang.String getUnitId()
        Returns template unit ID
        Returns:
        template unit ID
      • setAttributeId

        void setAttributeId​(java.lang.String value)
        Sets template unit ID
        Parameters:
        value - unit ID
      • getElementList

        KeyedList getElementList()
        Returns Derived Elements collection
        Returns:
        Derived Elements collection
      • setCurrentElement

        void setCurrentElement​(java.lang.String id)
        Sets the current Derived Element
        Parameters:
        id - Derived Element ID
      • getCurrentElement

        WebDerivedElement getCurrentElement()
        Returns current Derived Element
        Returns:
        current Derived Element
      • getAttribute

        WebAttribute getAttribute()
        Returns attribute Derived Elements belong to.
        Returns:
        attribute Derived Elements belong to.
      • getCurrentElementBean

        DerivedElementBean getCurrentElementBean()
        Returns a bean representing current element
        Returns:
        a bean representing current element
      • move

        int move​(java.lang.String deId,
                 int offset)
        Moves specified Derived Element by specified offset
        Parameters:
        deId - element ID
        offset - offset
        Returns:
        new element position
      • remove

        WebDerivedElement remove​(java.lang.String deId)
        Removes specified Derived Element
        Parameters:
        deId - element ID
        Returns:
        removed element
      • getValidationErrorInfo

        WebBeanError getValidationErrorInfo()
        Returns validation error info.
        Returns:
        validation error info.
      • setValidationErrorInfo

        void setValidationErrorInfo​(WebBeanError err)
        Sets validation error info.
        Parameters:
        err - error info.
      • saveElements

        void saveElements​(java.lang.String name,
                          java.lang.String description,
                          java.lang.String folderId,
                          boolean overwrite)
                   throws WebBeanException
        Save template attribute's local derived elements as a stand alone object. It also replaces local derived elements with the reference to the saved stand alone object.
        Parameters:
        name - - name of saved object
        description - - object description
        folderId - - DSS ID of the folder where the object shall be saved
        overwrite - - indicates whether the saave operation can overwrite existing object with the same name
        Throws:
        WebBeanException
      • importElements

        void importElements​(java.lang.String deId)
                     throws WebBeanException
        Adds a reference to the stand alone derived element to template attribute. If the template attribute had another stand alone or local derived elements all of them will be removed.
        Parameters:
        deId - DSS ID of the stand alone derived element.
        Throws:
        WebBeanException
      • convertToLocalElements

        void convertToLocalElements()
                             throws WebBeanException
        Converts stand-alone derived elements to local derived elements.
        Throws:
        WebBeanException
      • open

        void open​(java.lang.String attId)
           throws WebException
        Opens the editor to edit derived elements of the specified template attribute
        Parameters:
        attId - DSS ID of the template attribute
        Throws:
        WebObjectsException
        WebException
        java.lang.IllegalArgumentException
      • getFormatEditor

        AppComponent getFormatEditor()
        Returns format editor bean that can be used to edit the current derived element formats
      • acceptElementChanges

        void acceptElementChanges()
        Generate deltas for all changes in the current derived element
      • isEditable

        boolean isEditable()
      • setForSort

        void setForSort​(boolean value)
      • setForSortStr

        void setForSortStr​(java.lang.String value)
      • isForSort

        boolean isForSort()
      • hasElementChanged

        boolean hasElementChanged()
      • cancellChanges

        void cancellChanges()
      • isModified

        boolean isModified()
        Returns whether or not current derived elements is modified
      • setModified

        void setModified​(boolean isModified)
        Sets the modified status of current derived elements
      • getLinkedObjectName

        java.lang.String getLinkedObjectName()
        Returns name of linked derived elements
        Returns:
        the name of linked derived elements, or null if derived elements is not stand-alone.
      • getSourceMode

        int getSourceMode()