Package com.xwiki.projectmanagement.rest

Interface WorkItemsResource

public interface WorkItemsResource

The resource that exposes CRUD operations over the work items of the different project management implementations.

Since:

1.0

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createWorkItem(String wiki, String projectManagementHint, WorkItem workItem)	Create a work item based the project management implementation.
javax.ws.rs.core.Response	deleteWorkItem(String wiki, String projectManagementHint, String workItemId)	Removes a work item identified by an id.
javax.ws.rs.core.Response	getWorkItem(String wiki, String projectManagementHint, String workItemId)	Retrieve a work item from a specific project management implementation.
javax.ws.rs.core.Response	getWorkItems(String wiki, String projectManagementHint, int page, int pageSize)	Retrieve a list of work items.
javax.ws.rs.core.Response	updateWorkItem(String wiki, String projectManagementHint, WorkItem workItem)	Update a work item.

Method Detail

getWorkItem

javax.ws.rs.core.Response getWorkItem(String wiki,
                                      String projectManagementHint,
                                      String workItemId)

Retrieve a work item from a specific project management implementation.

Parameters:

wiki - the wiki from where the project management implementation can retrieve. Depending on the implementation, different wikis can have different configurations or the wiki might be irrelevant to the query.

projectManagementHint - the hint of the project management implementation.

workItemId - the id of the work item.

Returns:

a work item model. HTTP 200: successful retrieval. HTTP 401: the user is not logged in. HTTP 403: the user does not have the rights to retrieve the work items.

getWorkItems

javax.ws.rs.core.Response getWorkItems(String wiki,
                                       String projectManagementHint,
                                       int page,
                                       int pageSize)

Retrieve a list of work items.

Parameters:

wiki - the wiki from where the project management implementation can retrieve. Depending on the implementation, different wikis can have different configurations or the wiki might be irrelevant to the query.

projectManagementHint - the hint of the project management implementation.

page - the page number that is being requested.

pageSize - the maximum number of elements that can be returned by this query.

Returns:

a paginated result of work items specific to the page number. HTTP 200: successful retrieval. HTTP 401: the user is not logged in. HTTP 403: the user does not have the rights to retrieve the work items.

createWorkItem

javax.ws.rs.core.Response createWorkItem(String wiki,
                                         String projectManagementHint,
                                         WorkItem workItem)

Create a work item based the project management implementation.

Parameters:

wiki - the wiki from where the project management implementation can retrieve. Depending on the implementation, different wikis can have different configurations or the wiki might be irrelevant to the query.

projectManagementHint - the hint of the project management implementation.

workItem - the work item that needs to be created.

Returns:

the created work item. HTTP 200: successful retrieval. HTTP 400: invalid payload. HTTP 401: the user is not logged in. HTTP 403: the user does not have the rights to retrieve the work items. HTTP 409: work item could not be created due to a similar resource already existing.

updateWorkItem

javax.ws.rs.core.Response updateWorkItem(String wiki,
                                         String projectManagementHint,
                                         WorkItem workItem)

Update a work item.

Parameters:

wiki - the wiki from where the project management implementation can retrieve. Depending on the implementation, different wikis can have different configurations or the wiki might be irrelevant to the query.

projectManagementHint - the hint of the project management implementation.

workItem - the work item that needs to be updated.

Returns:

the updated work item. HTTP 200: successful retrieval. HTTP 400: invalid payload. HTTP 401: the user is not logged in. HTTP 403: the user does not have the rights to retrieve the work items. HTTP 404: the work item that needs updating could not be found.

deleteWorkItem

javax.ws.rs.core.Response deleteWorkItem(String wiki,
                                         String projectManagementHint,
                                         String workItemId)

Removes a work item identified by an id.

Parameters:

wiki - the wiki from where the project management implementation can retrieve. Depending on the implementation, different wikis can have different configurations or the wiki might be irrelevant to the query.

projectManagementHint - the hint of the project management implementation.

workItemId - the id of the work item that needs to be removed.

Returns:

the deleted item. HTTP 200: successful retrieval. HTTP 401: the user is not logged in. HTTP 403: the user does not have the rights to retrieve the work items. HTTP 404: the work item does not exist.