Package com.xwiki.projectmanagement.openproject.rest.mentions

Interface OpenProjectMentionResource

public interface OpenProjectMentionResource
Endpoint for handling xwiki mentions to OpenProject packages.
Since:
1.2.0
Version:
$Id$

  • Method Details

    • getPagesMentioningWorkPackage

      org.xwiki.rest.model.jaxb.SearchResults getPagesMentioningWorkPackage(String workPackageId, String filterInstance, Integer number, Integer start, String orderField, String order, Boolean withPrettyNames) throws org.xwiki.rest.XWikiRestException
      Parameters:
      workPackageId - the OpenProject work package id that should match the xwiki pages.
      filterInstance - the id of the OpenProject instance that should be taken into consideration when returning mentions.
      number - the maximum number of elements that should be returned.
      start - the offset of the results.
      orderField - the field on which the results should be ordered on.
      order - how the results should be ordered. asc or desc.
      withPrettyNames - denotes whether the results should contain the pretty names of the documents or not.
      Returns:
      a list of xwiki pages that mention the specified work package in their content.
      Throws:
      org.xwiki.rest.XWikiRestException - if there was any issue retrieving the xwiki pages.

    • getMentionsWithId

      org.xwiki.rest.model.jaxb.Objects getMentionsWithId(String pageId, String filterInstance, Integer number, Integer start, Boolean withPrettyNames) throws org.xwiki.rest.XWikiRestException
      Parameters:
      pageId - the unique identifier of the page.
      filterInstance - the id of the OpenProject instance that should be taken into consideration when returning mentions.
      number - the maximum number of elements that should be returned.
      start - the offset of the results.
      withPrettyNames - denotes whether the results should contain the pretty names of the documents or not.
      Returns:
      a list of mention objects that the requested page contains.
      Throws:
      org.xwiki.rest.XWikiRestException - if there was any issue retrieving the xwiki pages.

    • getMentionsWithRef

      org.xwiki.rest.model.jaxb.Objects getMentionsWithRef(String docRef, String filterInstance, Integer number, Integer start, Boolean withPrettyNames) throws org.xwiki.rest.XWikiRestException
      Parameters:
      docRef - the reference of the page.
      filterInstance - the id of the OpenProject instance that should be taken into consideration when returning mentions.
      number - the maximum number of elements that should be returned.
      start - the offset of the results.
      withPrettyNames - denotes whether the results should contain the pretty names of the documents or not.
      Returns:
      a list of mention objects that the requested page contains.
      Throws:
      org.xwiki.rest.XWikiRestException - if there was any issue retrieving the xwiki pages.