Package com.xwiki.projectmanagement.api
Interface ProjectsApi
-
@Role public interface ProjectsApiThe blueprint for a project management projects api. It allows performing different actions on the projects of the implementer.- Since:
- 1.2.0
- Version:
- $Id$
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PaginatedResult<Project>get(int page, int pageSize, List<org.xwiki.livedata.LiveDataQuery.Filter> filters)Retrieve a list of projects based on a list of filters.Projectget(String id)
-
-
-
Method Detail
-
get
Project get(String id) throws WorkItemNotFoundException, WorkItemRetrievalException
- Parameters:
id- the unique identifier for the project within the project management platform.- Returns:
- the retrieved project that matches the id.
- Throws:
WorkItemNotFoundExceptionWorkItemRetrievalException
-
get
PaginatedResult<Project> get(int page, int pageSize, List<org.xwiki.livedata.LiveDataQuery.Filter> filters) throws WorkItemRetrievalException
Retrieve a list of projects based on a list of filters.- Parameters:
page- the number identifying the page that needs to be retrieved.pageSize- the maximum number of items that can be present in the returned result.filters- a list of filters that the returned items need to match.- Returns:
- a paginated result containing the items matching the list of filters.
- Throws:
WorkItemRetrievalException
-
-