Package com.xwiki.projectmanagement.openproject.rest.document

Interface OpenProjectLinkSearchResource

public interface OpenProjectLinkSearchResource
Resource for retrieving pages containing WorkPackageLink to an Open Project entity.
Since:
1.2.0-rc-1
Version:
$Id$

  • Method Details

    • getProjects

      org.xwiki.rest.model.jaxb.SearchResults getProjects(String wikiName, String projectId, Boolean forInstance, Integer number, Integer start, String orderField, String order, Boolean withPrettyNames) throws org.xwiki.rest.XWikiRestException
      Parameters:
      wikiName - the wiki where to search.
      projectId - the OpenProject project id that should match the xwiki pages.
      forInstance - if set to true, the endpoint should retrieve the links that have the instance property matching the OpenProject instance that made the request. Otherwise, the instance property is ignored and all the xwiki pages matching the project id will be returned.
      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 have a WorkPackageLink to an OpenProject entity and that the current user has view rights on.
      Throws:
      org.xwiki.rest.XWikiRestException - if there was any issue retrieving the xwiki pages.

    • getWorkPackages

      org.xwiki.rest.model.jaxb.SearchResults getWorkPackages(String wikiName, String workPackageId, Boolean forInstance, Integer number, Integer start, String orderField, String order, Boolean withPrettyNames) throws org.xwiki.rest.XWikiRestException
      Parameters:
      wikiName - the wiki where to search.
      workPackageId - the OpenProject work package id that should match the xwiki pages.
      forInstance - if set to true, the endpoint should retrieve the links that have the instance property matching the OpenProject instance that made the request. Otherwise, the instance property is ignored and all the xwiki pages matching the work package id will be returned.
      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 have a WorkPackageLink to an OpenProject entity and that the current user has view rights on.
      Throws:
      org.xwiki.rest.XWikiRestException - if there was any issue retrieving the xwiki pages.