Package com.xwiki.projectmanagement

Interface ProjectManagementManager

@Role
public interface ProjectManagementManager

Offers access to the CRUD operations of different project management clients.

Since:

1.0

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
WorkItem	createWorkItem(String client, WorkItem workItem)	Create a work item.
boolean	deleteWorkItem(String client, String workItemId)	The work item that will be deleted.
WorkItem	getWorkItem(String client, String workItemId)	Retrieve a work item from a specific project management client.
PaginatedResult<WorkItem>	getWorkItems(String client, int page, int pageSize, List<org.xwiki.livedata.LiveDataQuery.Filter> filters, List<org.xwiki.livedata.LiveDataQuery.SortEntry> sortEntries)	Retrieve a list of work items based on a filter.
WorkItem	updateWorkItem(String client, WorkItem workItem)	Update a work item.

Method Detail

getWorkItem

WorkItem getWorkItem(String client,
                     String workItemId)
              throws WorkItemException

Retrieve a work item from a specific project management client.

Parameters:

client - the hint of the client implementation.

workItemId - the identifier of the work item that needs retrieval.

Returns:

the work item matching the id.

Throws:

WorkItemException - if the work item was not found.

getWorkItems

PaginatedResult<WorkItem> getWorkItems(String client,
                                       int page,
                                       int pageSize,
                                       List<org.xwiki.livedata.LiveDataQuery.Filter> filters,
                                       List<org.xwiki.livedata.LiveDataQuery.SortEntry> sortEntries)
                                throws WorkItemException

Retrieve a list of work items based on a filter.

Parameters:

client - the hint of the client implementation.

page - the number identifying the page that needs retrieval.

pageSize - the maximum number of items the result can have.

filters - a list of filters that the returned items must satisfy.

sortEntries - a list of sort entries that denote how the results should be arranged.

Returns:

a paginated result containing the list of items that satisfy the filters.

Throws:

WorkItemException - if there was an exception during the retrieval of the tasks.

createWorkItem

WorkItem createWorkItem(String client,
                        WorkItem workItem)
                 throws WorkItemException

Create a work item.

Parameters:

client - the hint of the client implementation.

workItem - the work item that will be created.

Returns:

the work item that was created.

Throws:

WorkItemCreationException - if there was an exception during the creation of the work item.

WorkItemException

updateWorkItem

WorkItem updateWorkItem(String client,
                        WorkItem workItem)
                 throws WorkItemException

Update a work item.

Parameters:

client - the hint of the client implementation.

workItem - the work item that will be updated.

Returns:

the work item that was updated.

Throws:

WorkItemException - if there was an exception during the updating of the work item.

deleteWorkItem

boolean deleteWorkItem(String client,
                       String workItemId)
                throws WorkItemException

The work item that will be deleted.

Parameters:

client - the hint of the client implementation.

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

Returns:

true if the work item was deleted; false otherwise.

Throws:

WorkItemException - if there was any exception during the deletion of the work item.