Package com.polarion.alm.tracker.model

Interface IModule

All Superinterfaces:
IAdaptable, IChangeListener, IFolderItem, IHasCustomValues, IHasValues, IPObject, IUniqueObject, IWithAttachments<IModuleAttachment>, IWithLinkedOslcResources, IWorkflowObject
public interface IModule extends IWorkflowObject, IFolderItem, IWithAttachments<IModuleAttachment>, IWithLinkedOslcResources
Since:
3.2
Author:
Miroslav Ruza

  • Field Details

  • Method Details

    • addRenderingLayout

      IModule.IRenderingLayoutStruct addRenderingLayout(String label, String type, String layouter)
      Adds a new layout configuration.
      Parameters:
      label - label of the configuration.
      type - Work Item type the layout applies to.
      layouter - layouter to use. Unless custom layouters were registered only IModuleManager.DEFAULT_LAYOUTER or IModuleManager.PARAGRAPH_LAYOUTER or IModuleManager.SECTION_LAYOUTER are valid values..
      Returns:
      the created IRenderingLayoutStruct.
      Since:
      3.5

    • getModuleName

      String getModuleName()
      Module name (name of the module's file, without path).
      Returns:
      Module name (name of the module's file, without path).
      See Also:

    • getTitle

      @Nullable String getTitle()
      Returns:
      Module title.
      Since:
      3.8.2

    • setTitle

      void setTitle(@Nullable String title)
      Sets new document title.
      Since:
      3.8.2

    • updateTitleHeading

      @Nullable IWorkItem updateTitleHeading(@Nullable String title)
      Updates the first Title Heading in document content (if permissions allow it). IPObject.save() is called on the updated Title Heading.
      Returns:
      updated Title Heading or null if no Title Heading in document content was updated.
      Since:
      3.8.2

    • getTitleOrName

      @NotNull String getTitleOrName()
      Returns:
      Title or Module Name if Title is not set
      Since:
      3.8.2

    • getModuleFolder

      String getModuleFolder()
      Returns:
      Folder which this module is stored in; null if the module is directly below modules folder
      Since:
      3.5.0

    • getModuleNameWithSpace

      String getModuleNameWithSpace()
      Method returns module name with space in readable form Format: Space Name / Module Name or Module Name only if it's located in default space
      Returns:
      module name with space
      Since:
      3.5.1

    • getRelativePath

      @NotNull String getRelativePath()
      Returns:
      Module name with space in readable form: Space Name/Module Name
      Since:
      3.10.1

    • getTitleWithSpace

      @NotNull String getTitleWithSpace()
      Returns:
      "Space Name / Title" or "Title" if located in default space (will use Module Name if Title is not set)
      Since:
      3.8.2

    • getAuthor

      IUser getAuthor()
      Returns this module author. The author field can not be changed, therefore there is no set method for this field.

    • getCreated

      Date getCreated()
      Returns:
      the date of a module creation

    • getUpdated

      Date getUpdated()
      Returns:
      the date of a last update of this module

    • getUpdatedBy

      IUser getUpdatedBy()
      Returns:
      user who have last updated this module.

    • getModuleLocation

      ILocation getModuleLocation()
      Module location - location of module folder, relative to modules root in the given project.
      Returns:
      location

    • getAllowedWITypes

      List<ITypeOpt> getAllowedWITypes()
      Returns:
      read only list of work item types allowed to be in this module

    • getStructureLinkRole

      ILinkRoleOpt getStructureLinkRole()
      Returns:
      work item link role

    • areLinksFromParentToChild

      boolean areLinksFromParentToChild()
      Returns:
      true when structure links go from parent to child. (3.2 allows only false)

    • getRootNode

      IModule.IStructureNode getRootNode()
      Returns:
      virtual root node (with no associated work item) of the module structure tree

    • isModified

      boolean isModified()
      Whether this module structure (tree of IStructureNode returned by getRootNode) was modified after it was read from storage (newly created modules are always modified).
      Specified by:
      isModified in interface IPObject
      Returns:
      true if module was modified

    • save

      void save()
      Saves modifications to the module structure (tree of IStructureNode returned by getRootNode)
      Specified by:
      save in interface IPObject
      See Also:

    • delete

      void delete()
      Removes module

    • getContainedWorkItems

      List<IWorkItem> getContainedWorkItems()
      Returns sorted list of active work items contained in this module.

    • filterWorkItems

      @NotNull Set<IWorkItem> filterWorkItems(@Nullable String query)
      Returns the Document's active Work Items that match the query and adds their ancestors. Returns an empty collection if the query is null, empty, or contains only white space. Since 3.17.2 when filtering by outline number, only outline numbers in the given Document are taken into account. For example, for query outlineNumber:2* this method would NOT return Work Items that are referenced in other Documents but happen to match the outline number in the query.
      Since:
      3.5.0

    • containsWorkItem

      boolean containsWorkItem(IWorkItem item)
      Parameters:
      item -
      Returns:
      true if the item is active and contained in this module.

    • getAllWorkItems

      List<IWorkItem> getAllWorkItems()
      Returns all work items (even unreferenced) contained in this module. Works correctly only after commit.
      Returns:
      getContainedWorkItems() + getUnreferencedWorkItems() (not null)
      Since:
      3.5

    • getUnreferencedWorkItems

      List<IWorkItem> getUnreferencedWorkItems()
      Returns unreferenced work items contained in this module(even module is from specific revision). Works correctly only after commit.
      Returns:
      unreferenced work items (not null) or empty list if this is old-style module
      Since:
      3.5

    • createWorkItem

      @Deprecated IWorkItem createWorkItem()
      Deprecated.
      use the createWorkItem(String)
      Creates and persists a Work Item, which will be stored in this Module.

      Note: Since it is already persisted, calling IPObject.save() afterwards on the Work Item is not necessary.

      Returns:
      a persisted IWorkItem

    • createWorkItem

      IWorkItem createWorkItem(String type)
      Creates and persists a Work Item, which will be stored in this Module.

      Note: Since it is already persisted, calling IPObject.save() afterwards on the Work Item is not necessary.

      Parameters:
      type - Work Item type (not null)
      Returns:
      a persisted IWorkItem
      Since:
      3.5.0

    • createUnreferencedWorkItem

      IWorkItem createUnreferencedWorkItem()
      Creates unreferenced work item stored in this module. The instance is not persisted (IPObject.save() must be called).

      Behaves the same as createWorkItem() for old-style modules.

      Returns:
      not persisted work item
      Since:
      3.5.0

    • removeWorkItem

      void removeWorkItem(@NotNull IWorkItem item)
      Removes contained or external Work Item from the Document.
      Parameters:
      item - can be null

    • getStructureNodeOfWI

      IModule.IStructureNode getStructureNodeOfWI(IWorkItem workitem)
      Returns the structure node representing this work item if the work item is from this module
      Parameters:
      workitem -

    • getWorkItem

      IWorkItem getWorkItem(String id)
      Returns work item with given id. null is returned when such a work item does not exist in this module. Works only for internal work items, for external work items it returns null even when the external work item with given id exists in this module.
      Returns:
      work item with given id or null if not present in this module
      Since:
      3.5.0

    • getWorkItem

      IWorkItem getWorkItem(String projectId, String id)
      Returns work item with given project id and id. null is returned when such a work item does not exist in this module. Works for both internal and external work items.
      Returns:
      work item with given project id and id or null if not present in this module
      Since:
      3.6.0

    • moveIn

      void moveIn(Collection<IWorkItem> wis)
      Moves workitems from XML storage to this module. Workitems from LiveDoc are skipped, because it is not supported to move them to module.
      Parameters:
      wis -

    • moveIn

      void moveIn(Collection<IWorkItem> wis, String sort)
      Moves workitems from XML storage to this module. Workitems from LiveDoc are skipped, because it is not supported to move them to module. Note it moves also all workitems which are (direct or indirect) children of passed workitems.
      Parameters:
      wis -
      sort - sort order by which the children of moved-in workitems are sorted (can be null, the format is same as for IIndexSearch.sort(String).
      Since:
      3.3.1

    • moveInWithReport

      IModule.IMoveReport moveInWithReport(Collection<IWorkItem> wis, String sort)
      Moves workitems from XML storage to this module and reports which were skipped and which additional were moved. Workitems from LiveDoc are skipped, because it is not supported to move them to module. Note it moves also all workitems which are (direct or indirect) children of passed workitems.
      Parameters:
      wis -
      sort - sort order by which the children of moved-in workitems are sorted (can be null), the format is same as for IIndexSearch.sort(String).
      Since:
      3.4

    • moveOut

      void moveOut(Collection<IWorkItem> wis)
      Moves workitems out from module to normal XML storage. Workitems which are not in this module are skipped. Note it moves also all workitems which are (direct or indirect) children of passed workitems.
      Parameters:
      wis -
      Since:
      3.3

    • moveOutWithReport

      IModule.IMoveReport moveOutWithReport(Collection<IWorkItem> wis)
      Moves workitems out from module to normal XML storage and reports which were skipped and which additional were moved. Workitems which are not in this module are skipped. Note it moves also all workitems which are (direct or indirect) children of passed workitems.
      Parameters:
      wis -
      Returns:
      report about moved work items (not null).
      Since:
      3.4

    • setDerivedFrom

      void setDerivedFrom(IModule source)
      Set the reference to the derived module. This method should not be usually called directly, but user should rather use IModuleManager.createDerivedModule
      Parameters:
      source - - might be historical object
      Since:
      3.3

    • getDerivedFrom

      IModule getDerivedFrom()
      Returns:
      return module from which is this module derived
      Since:
      3.3

    • getDerivedFields

      Collection<String> getDerivedFields()
      If this module is derived (getDerivedFrom() does not return null), this method returns the set of field IDs that are derived. This means the IModuleManager.updateDerivedModule(IModule, String, Set, Set) replaces the content of this fields with the values from original module.
      Since:
      3.3

    • setDerivedFields

      void setDerivedFields(Collection<String> fields)
      Set the derived fields (@see getDerivedField to get to know what is the derived field)
      Parameters:
      fields - = comma separated list
      Since:
      3.3

    • getDerivedFromLinkRole

      ILinkRoleOpt getDerivedFromLinkRole()
      If this module is derived (getDerivedFrom does not return false) this method returns the link role that is used to link derived item to original item
      Since:
      3.3

    • setDerivedFromLinkRole

      void setDerivedFromLinkRole(ILinkRoleOpt role)
      Set the derived_from link role (@see getDerivedFromLinkRole to get to know what is this link role)
      Parameters:
      role -
      Since:
      3.3

    • setBranchedFrom

      void setBranchedFrom(IModule value)
      Sets Module from which was this one branched.
      Since:
      3.6.0

    • setVariant

      void setVariant(@Nullable IWorkItem variant)
      Sets the Variant work item from which this Module was created
      Since:
      3.9.0

    • getVariant

      @Nullable IWorkItem getVariant()
      Gets the Variant work item this Module was created from. Returns null, if Module was not created through a Variant
      Since:
      3.9.0

    • getBranchedFrom

      IModule getBranchedFrom()
      Returns Module from which was this one branched.
      Since:
      3.6.0

    • setBranchedWithQuery

      void setBranchedWithQuery(String value)
      Sets query from which was this Module branched.
      Since:
      3.6.0

    • getBranchedWithQuery

      String getBranchedWithQuery()
      Returns query from which was this Module branched or null if Module was branched without query.
      Since:
      3.6.0

    • usesOutlineNumbering

      boolean usesOutlineNumbering()
      Returns true if outline numbering of workitems is used for this module.
      Since:
      3.4

    • setUsesOutlineNumbering

      void setUsesOutlineNumbering(boolean uses)
      Sets whether outline numbering of workitems is used for this module.
      Since:
      3.4

    • getOutlineNumbering

      @NotNull IModule.IOutlineNumberingDef getOutlineNumbering()
      Returns configuration of outline numbering of workitems for this module.
      Since:
      3.4

    • getOutlineNumberingPrefix

      @Nullable String getOutlineNumberingPrefix()
      Gets prefix for outline numbering or null if prefix is not defined.
      Since:
      3.8.2

    • setOutlineNumberingPrefix

      void setOutlineNumberingPrefix(String prefix)
      Sets prefix of outline numbering of workitems for this module.
      Since:
      3.4

    • getOutlineNumberOfWorkitem

      String getOutlineNumberOfWorkitem(IWorkItem wi)
      Returns outline number of work item. If the number is not defined, either empty string or null could be returned.
      Since:
      3.4

    • isOldStyleModule

      boolean isOldStyleModule()
      Returns:
      true if this is old-style module
      Since:
      3.5

    • getHomePageContent

      Text getHomePageContent()
      Returns home page content.
      Returns:
      content of module's home page or null
      Since:
      3.5

    • setHomePageContent

      void setHomePageContent(Text content)
      Set home page content. If this is not an old-style module then any prior change of the module structure will be forgotten and calls to getRootNode(), getStructureNodeOfWI(IWorkItem), getContainedWorkItems(), containsWorkItem(IWorkItem), getUnreferencedWorkItems() or any other method working with module structure will not return correct values or perform correctly unless save() and IPObject.update() are called.

      Behavioral differences when used with old-style modules:

      Parameters:
      content - Wiki markup to set (not null)
      Since:
      3.5

    • getRenderingLayouts

      List<IModule.IRenderingLayoutStruct> getRenderingLayouts()
      Returns rendering layouts.
      Returns:
      mutable list of rendering layouts (not null)
      Since:
      3.5

    • renderHomePageContent

      Text renderHomePageContent(String target, String userAgent, String query)
      Returns rendered home page content.

      Returns unchanged content for old-style modules.

      Parameters:
      target - target of rendering, e.g. RENDERING_TARGET_EDITOR, RENDERING_TARGET_COMPARE, ...
      userAgent - user-agent string of the browser if applicable, can be null
      query - Lucene query string for filtering visible Work Items, null or empty string means no filtering
      Returns:
      rendered home page content (null only if getHomePageContent() returns null)
      Since:
      3.5

    • renderHomePageContent

      Text renderHomePageContent(String target, String userAgent, String query, String language)
      Returns localized rendered home page content.

      Returns unchanged content for old-style modules.

      Parameters:
      target - target of rendering, e.g. RENDERING_TARGET_EDITOR, RENDERING_TARGET_COMPARE, ...
      userAgent - user-agent string of the browser if applicable, can be null
      query - Lucene query string for filtering visible Work Items, null or empty string means no filtering
      language - id of the language to be used when rendering the content or null for default language (see ILanguageDefinition)
      Returns:
      localized rendered home page content (null only if getHomePageContent() returns null)
      Since:
      3.6.1

    • renderHomePageContent

      Text renderHomePageContent(String target, String userAgent, String query, ILocalId currentDocumentId)
      Parameters:
      target -
      userAgent -
      query -
      currentDocumentId -
      Since:
      3.5.1

    • createAttachment

      @NotNull IModuleAttachment createAttachment(@NotNull String fileName, @Nullable String title, @NotNull InputStream data)
      See IWithAttachments.createAttachment(String, String, InputStream)
      Specified by:
      createAttachment in interface IWithAttachments<IModuleAttachment>
      Parameters:
      fileName - The file name, can not be null.
      title - The title (can be null - file name is used then).
      data - The content input stream, can not be null
      Returns:
      the temporary IAttachement created
      Since:
      3.5.0

    • getAttachments

      @NotNull IPObjectList<IModuleAttachment> getAttachments()
      See IWithAttachments.getAttachments()
      Specified by:
      getAttachments in interface IWithAttachments<IModuleAttachment>
      Returns:
      attachments (never null)
      Since:
      3.5.0

    • getAttachment

      @Nullable IModuleAttachment getAttachment(@NotNull String fileName)
      See IWithAttachments.getAttachment(String)
      Specified by:
      getAttachment in interface IWithAttachments<IModuleAttachment>
      Parameters:
      fileName - attachment's id (not null)
      Returns:
      attachment or null if not found
      Since:
      3.5.0

    • deleteAttachment

      void deleteAttachment(@NotNull IModuleAttachment attachment)
      See IWithAttachments.deleteAttachment(IAttachmentBase)
      Specified by:
      deleteAttachment in interface IWithAttachments<IModuleAttachment>
      Parameters:
      attachment - attachment (not null)
      Since:
      3.5.0

    • createComment

      IModuleComment createComment(Text text)
      Creates the (temporary) comment object, which can be manipulated by the client. However, the comment is not persisted until it's explicitly saved.

      The fields workItem, project, author, date are pre-filled with the values.

      Parameters:
      text - Text, can not be null.
      Returns:
      the Comment object, with the necessary fields filled in
      Since:
      3.5.0

    • getComments

      IPObjectList<IModuleComment> getComments()
      Returns all comments of this module.
      Returns:
      all comments (not null)
      Since:
      3.5.0

    • getRootComments

      IPObjectList<IModuleComment> getRootComments()
      Shortcut for getRootComments(true).
      Since:
      3.5.0

    • getRootComments

      IPObjectList<IModuleComment> getRootComments(boolean includeResolved)
      Returns root comments of this module. Optionally includes resolved comments.
      Returns:
      root IModuleComments (not null)
      Since:
      3.7.1
      See Also:

    • getHeadingWorkItemType

      ITypeOpt getHeadingWorkItemType()
      Returns:
      type of the heading work items, not null
      Since:
      3.5.0

    • removeComment

      void removeComment(IModuleComment comment)
      Remove comment object and all of it's children from module and persistence
      Parameters:
      comment - comment to remove
      Since:
      3.5.0

    • getHomePageContentParts

      List<String[]> getHomePageContentParts()
      Returns:
      List of String arrays having the ID in first element and html content part in second.
      Since:
      3.5.0

    • checkConflictInParts

      boolean checkConflictInParts(Set<String> partIds, Set<String> addedPartIds, Set<String> modifiedPartIds, Set<String> removedPartIds, IModule revisionModule)
      Checks if there is some conflict which would prevent merging of changes using the mergeContentParts method.
      Parameters:
      partIds - - ordered set of IDs of parts as the current user sees them in his UI (can not be null).
      addedPartIds - - set of IDs of added parts (can not be null)
      modifiedPartIds - - set of IDs of modified parts (can not be null)
      removedPartIds - - set of IDs of removed parts (can not be null)
      revisionModule - - instance of IModule read from revision from which the editing started (can not be null)
      Returns:
      true when there is some conflict detected
      Since:
      3.5.0

    • mergeContentParts

      Map<String,String> mergeContentParts(Set<String> partIds, Map<String,String> addedParts, Map<String,String> modifiedParts, Set<String> removedPartIds)
      Merges partial changes with changes done by someone else, conflicts must be checked first by calling checkConflictInParts, result of calling this method when the conflict is detected is not defines.
      Parameters:
      partIds - - ordered set of IDs of parts as the current user sees them in his UI (can not be null).
      addedParts - - map of added parts; key is the ID; value is the content including the start and end tag (can not be null)
      modifiedParts - - map of modified parts; key is the ID; value is the content including the start and end tag (can not be null)
      removedPartIds - - set of IDs of removed parts (can not be null)
      Returns:
      map with the ID under which the added parts were actually persisted; keys are keys from addedParts; values are the actual IDs (never returns null)
      Since:
      3.5.0

    • isAutoSuspect

      boolean isAutoSuspect()
      Since:
      3.5.0

    • setAutoSuspect

      void setAutoSuspect(boolean autoSuspect)
      Since:
      3.5.0

    • handleDocumentComments

      String handleDocumentComments(String html, String userAgent)
      Process comments in form of span with id and add comment icon with tooltip
      Parameters:
      html - HTML string containing comments
      userAgent -
      Returns:
      string with comments replaced for display on UI
      Since:
      3.5.0

    • compareRevisions

      IBaselineDiff compareRevisions(String revision1, String revision2)
      Compares two revisions of this module.
      Parameters:
      revision1 - first revision (pass null for HEAD/current)
      revision2 - second revision (pass null for HEAD/current)
      Returns:
      IBaselineDiff (not null) with only IBaselineDiff.getWorkItemDiff() filled
      Throws:
      UnresolvableObjectException - if module did not exist in one of given revisions
      Since:
      3.5.0

    • compareWith

      @NotNull IBaselineDiff compareWith(@NotNull IModule module, @Nullable String revision1, @Nullable String revision2, @Nullable String query1, @Nullable String query2)
      Compares with other module.
      Parameters:
      revision1 - first revision (pass null for HEAD/current)
      revision2 - second revision (pass null for HEAD/current)
      query1 - first query (pass null for HEAD/current)
      query2 - second query (pass null for HEAD/current)
      Returns:
      IBaselineDiff (not null) with only IBaselineDiff.getWorkItemDiff() filled
      Throws:
      UnresolvableObjectException - if module did not exist in one of given revisions
      Since:
      3.6.0

    • move

      void move(String newModuleFolder, String newModuleName)
      Moves or renames this document/module.
      Parameters:
      newModuleFolder - new module folder to move this document to. Can be null, that means the document is kept in its current folder.
      newModuleName - new name of the document. Can be null, that means the document will keep its current name.
      Since:
      3.5.1

    • getDerivedModules

      IPObjectList getDerivedModules()
      Returns all documents/modules which are derived from this one.
      Returns:
      documents/modules which are derived from this one
      Since:
      3.5.1

    • getBranchedModules

      IPObjectList getBranchedModules()
      Returns all documents/modules which are branched from this one.
      Since:
      3.6.0

    • findCommentsReferencingWorkItem

      List<IModuleComment> findCommentsReferencingWorkItem(IWorkItem workItem)
      Finds comments for which the IModuleComment.getReferredWorkItem() equals the given work item
      Since:
      3.6.0

    • getCommentById

      IModuleComment getCommentById(String id)
      Returns the comment with the given id (returns also the newly created comments)
      Since:
      3.7.3

    • unreference

      void unreference(@NotNull IWorkItem workItem)
      Moves workItem to documents recycle bin, does nothing when the workItem cannot be found
      Parameters:
      workItem - the workItem to be recycled
      Since:
      3.8.0

    • compareCustomFields

      @Deprecated @NotNull IBaselineDiff compareCustomFields(@Nullable String revision1, @Nullable String revision2)
      Deprecated.
      Use compareFields(String, String).
      Compares custom fields of two revisions of the document.
      Since:
      3.8.0

    • compareCustomFieldsWith

      @Deprecated @NotNull IBaselineDiff compareCustomFieldsWith(@NotNull IModule module, String revision1, String revision2)
      Deprecated.
      Use compareFields(String, String).
      Compares custom fields of two documents.
      Since:
      3.8.0

    • compareFields

      @NotNull IModificationDiff compareFields(@Nullable String revision1, @Nullable String revision2)
      Compares fields of two revisions of the document.
      Parameters:
      revision1 - the first revision or null for head
      revision2 - the second revision or null for head
      Since:
      3.8.1

    • compareFieldsWith

      @NotNull IModificationDiff compareFieldsWith(@NotNull IModule module, @Nullable String revision1, @Nullable String revision2)
      Compares fields of a revision of this document with fields of a revision of the specified document.
      Parameters:
      module - the module to compare with this module
      revision1 - the revision of this module, null for head
      revision2 - the revision of the second module, null for head
      Since:
      3.8.1

    • can

      @NotNull IDocumentPermissions can()
      Specified by:
      can in interface IPObject
      Specified by:
      can in interface IWorkflowObject
      Since:
      3.8.2

    • getWorkflowSignaturesManager

      @NotNull IDocumentWorkflowSignaturesManager getWorkflowSignaturesManager()
      Description copied from interface: IWorkflowObject
      Returns signatures manager that can be used for all signature related tasks.
      Specified by:
      getWorkflowSignaturesManager in interface IWorkflowObject
      Since:
      3.9.0

    • getWorkflowSignatures

      @NotNull List<IDocumentWorkflowSignature> getWorkflowSignatures()
      Description copied from interface: IWorkflowObject
      Returns all workflow signatures in the creation order. Usually the clients will use the signatures manager to work with signatures.
      Specified by:
      getWorkflowSignatures in interface IWorkflowObject
      Since:
      3.9.0
      See Also:

    • getExternalWorkItems

      @NotNull List<IWorkItem> getExternalWorkItems()
      Returns all external Work Items contained in Document content.
      Since:
      3.8.3

    • addExternalWorkItem

      void addExternalWorkItem(@NotNull IWorkItem externalWorkItem)
      Adds external Work Item into Document content. The external Work Item must not exist in Document content yet and must not be heading type (getHeadingWorkItemType()). If external Work Item has revision (IPObject.getRevision() then it is frozen in document content.
      Throws:
      IllegalStateException - when given Work Item is heading type, exists in Document content or is not external (stored within Document).
      Since:
      3.8.3

    • overwriteExternalWorkItem

      @NotNull IWorkItem overwriteExternalWorkItem(@NotNull IWorkItem externalWorkItem)
      Replace the given external Work Item in the Document content with a new one. The newly created Work Item within the Document will have updated values from the given one according to the layout defined in the Document. The content of the document will be updated.
      Returns:
      The new persisted IWorkItem.
      Throws:
      IllegalArgumentException - If the given external Work Item does not exist in the document.
      Since:
      3.8.3

    • freezeExternalWorkItem

      void freezeExternalWorkItem(@NotNull IWorkItem externalWorkItem, @NotNull String revision)
      Freezes given external Work Item on given revision in Document content. The external Work Item must not be heading type (getHeadingWorkItemType()). Whether or not the given item is revisioned is ignored.
      Parameters:
      externalWorkItem - Work Item to freeze
      revision - revision to which work item will be frozen
      Since:
      3.8.3

    • unfreezeExternalWorkItem

      void unfreezeExternalWorkItem(@NotNull IWorkItem externalWorkItem)
      Un-freezes given external Work Item. Revision of given Work Item is deleted from Document content. Whether or not the given item is revisioned is ignored.
      Parameters:
      externalWorkItem - work item to un-freeze
      Since:
      3.8.3

    • getHeadingSidebarFields

      @Nullable String getHeadingSidebarFields()
      Returns field configuration for Work Item properties sidebar panel. IDs of fields are comma separated.
      Since:
      3.9.1

    • buildHomePage

      @NotNull IModuleHomePageBuilder buildHomePage()
      Returns builder of the home page that is useful for clients that build the full home page at once, in which case it is more convenient to use than the structure nodes API, and it also has much better performance in this scenario. You need to call IModuleHomePageBuilder.set() at the end to actually set the new home page content to the module.
      Since:
      3.10.1

    • createWorkItemsQuery

      @NotNull IModuleWorkItemsQueryBuilder createWorkItemsQuery()
      Creates a query for Work Items in this Document.
      Since:
      3.17.2

    • getBranchedWithInitializedFields

      @NotNull Collection<String> getBranchedWithInitializedFields()
      Returns the list of Work Item fields that were cleared and initialized with default values when this Document was branched.
      Since:
      3.23.10

    • setBranchedWithInitializedFields

      void setBranchedWithInitializedFields(@NotNull Collection<String> fields)
      Sets the Work Item initialized fields (@see getBranchedWithInitializedFields to get to know what is the Work Item initialized field)
      Since:
      3.23.10