com.danube.scrumworks.api
Interface ScrumWorksEndpoint

All Superinterfaces:

java.rmi.Remote

public interface ScrumWorksEndpoint
extends java.rmi.Remote

Service endpoint interface for ScrumWorksEJB.

Method Summary

void	addBacklogItemsToTheme(BacklogItemWSO[] backlogItems, ThemeWSO theme)
BacklogItemWSO	createBacklogItem(BacklogItemWSO backlogItem) Creates a backlog item.
ImpedimentWSO	createImpediment(ImpedimentWSO impediment, ProductWSO product) Creates a new impediment.
ReleaseWSO	createRelease(ReleaseWSO release, ProductWSO product) Creates a new release in the given product.
SprintWSO	createSprint(SprintWSO sprint) Creates a sprint for the given team.
SprintWSO	createSprintWithNonWorkingDays(SprintWSO sprint, java.lang.Long[] nonWorkingDays) Creates a new sprint with the given SprintWSO instance.
TaskWSO	createTask(TaskWSO task) Creates a task.
ThemeWSO	createTheme(ThemeWSO theme, ProductWSO product) Creates a new theme in the given product.
void	deleteBacklogItem(BacklogItemWSO backlogItem) Deletes a backlog item from the backlog along with its estimates.
void	deleteEmptyRelease(ReleaseWSO release) Deletes an empty release.
void	deleteEmptySprint(SprintWSO sprint) Deletes an empty sprint.
void	deleteTask(TaskWSO task) Deletes a task from the backlog.
TaskWSO	deleteTaskEstimate(TaskWSO task, java.util.Date date) Removes a task's estimate for the given day.
void	deleteTheme(ThemeWSO theme) Deletes a theme.
BacklogItemWSO[]	getActiveBacklogItems(ProductWSO product) Returns a list of all active backlog items for a given product.
BacklogItemWSO[]	getActiveBacklogItemsForRelease(ReleaseWSO release) Returns a list of active backlog items for a given release, in the same order as they appear in the backlog scheduler.
BacklogItemWSO[]	getActiveBacklogItemsForSprint(SprintWSO sprint) Returns a list of active backlog items for a given sprint, in the same order as they appear in the backlog scheduler.
java.lang.String	getAuthenticatedTest() Dummy method for checking connectivity and authentication.
BacklogItemWSO	getBacklogItem(java.lang.Long backlogItemId) Returns the backlog item with the given id.
BacklogItemWSO	getBacklogItemByKey(java.lang.String backlogItemKey) Returns the backlog item with the given key.
BacklogItemEstimateWSO[]	getBacklogItemEstimates(BacklogItemWSO backlogItem) Gets the list of backlog item estimates for a given backlog item.
BacklogItemWSO[]	getBacklogItems(java.lang.Long[] backlogItemIds) Returns the backlog items with the given ids.
BacklogItemWSO[]	getBacklogItemsForTheme(ThemeWSO theme)
DashboardReleaseStatisticsWSO[]	getDashboardStatistics(ProductWSO product, java.util.Date startDate, java.util.Date endDate)
ImpedimentWSO[]	getImpediments(ProductWSO product) Gets the impediments for a given product.
BacklogItemWSO[]	getInactiveBacklogItems(ProductWSO product) Returns a list of all inactive backlog items for a given product.
PermissionWSO[]	getPermissions()
ProductWSO[]	getProducts() Returns a list of all products in ScrumWorks.
ReleaseWSO[]	getReleases(ProductWSO product) Returns the releases associated with the given product.
java.lang.Long[]	getSprintNonWorkingDays(java.lang.Long sprintId) Obtain the non working days for the given sprint id.
SprintWSO[]	getSprints(ProductWSO product) Returns the list of sprints for the given product.
SprintWSO[]	getSprintsForTeam(ProductWSO product, TeamWSO team) Returns the list of sprints for the given product and team.
TaskEstimateWSO[]	getTaskEstimates(TaskWSO task) Returns the task estimates for the given task in chronological order.
TaskHoursSpentWSO[]	getTaskHoursSpentForTask(java.lang.String displayName, TaskWSO task) Returns the hours spent by a user on a single task, ordered by date
TaskWSO[]	getTasks(BacklogItemWSO backlogItem) Returns the tasks for the given backlog item.
TaskWSO[]	getTasksForSprint(SprintWSO sprint) Returns the list of tasks for the given sprint ordered by backlog item rank then task rank.
TeamWSO	getTeam(SprintWSO sprint) Returns the team for the given sprint.
UserWSO[]	getTeamMembers(TeamWSO team) Returns the list of team members for the given team.
TeamWSO[]	getTeams() Returns the list of teams in the system.
TeamWSO[]	getTeamsForProduct(ProductWSO product) Returns the teams associated with the given product.
java.lang.String	getTest() Dummy method for checking connectivity.
ThemeWSO[]	getThemes(ProductWSO product) Lists all themes for the given product
java.lang.String	getTimezone() Returns the TimeZone the server is in.
TaskHoursSpentWSO[]	getTotalTaskHoursSpentForTask(TaskWSO task) Returns the total hours spent by all users for the given task, ordered by date
UserWSO[]	getUsers() Returns the list of users in the system.
java.lang.String[]	getUsersForSprint(SprintWSO sprint) Returns the list of all user names with timesheet entries for all tasks within the given sprint.
void	markBacklogItemInactive(BacklogItemWSO backlogItem) Marks a backlog item inactive.
void	mergeThemes(ThemeWSO themeToMerge, ThemeWSO themeToMergeInto) Merges a theme into another one.
BacklogItemWSO	moveBacklogItemAfter(BacklogItemWSO itemToMove, BacklogItemWSO dudeBefore)
BacklogItemWSO	moveBacklogItemIntoRelease(BacklogItemWSO itemToMove, ReleaseWSO release)
BacklogItemWSO	moveBacklogItemIntoSprint(BacklogItemWSO itemToMove, SprintWSO sprint)
BacklogItemWSO[]	moveBacklogItemsAfter(BacklogItemWSO[] itemsToMove, BacklogItemWSO dudeBefore) Moves a set of backlog items after a backlog item.
BacklogItemWSO[]	moveBacklogItemsIntoRelease(BacklogItemWSO[] itemsToMove, ReleaseWSO release) Moves a set of backlog items into a release.
BacklogItemWSO[]	moveBacklogItemsIntoSprint(BacklogItemWSO[] itemsToMove, SprintWSO sprint) Moves a set of backlog items into a sprint.
ReleaseWSO	moveReleaseAfter(ReleaseWSO itemToMove, ReleaseWSO dudeBefore) Moves a release before another release so that it shows up second in the backlog planner.
ReleaseWSO	moveReleaseBefore(ReleaseWSO itemToMove, ReleaseWSO dudeAfter) Moves a release after another release so that it shows up first in the backlog planner.
TaskWSO	moveTaskAfter(TaskWSO itemToMove, TaskWSO dudeBefore) Moves a task after another task in the backlog.
TaskWSO	moveTaskIntoBacklogItem(TaskWSO itemToMove, BacklogItemWSO backlogItem)
TaskWSO[]	moveTasksAfter(TaskWSO[] itemsToMove, TaskWSO dudeBefore) Moves a set of tasks after another task in the backlog.
TaskWSO[]	moveTasksIntoBacklogItem(TaskWSO[] itemsToMove, BacklogItemWSO backlogItem) Moves a set of tasks into a backlog item.
void	removeBacklogItemsFromTheme(BacklogItemWSO[] backlogItems, ThemeWSO theme)
ThemeWSO	renameTheme(ThemeWSO theme, java.lang.String newName) Renames a theme.
BacklogItemWSO	updateBacklogItem(BacklogItemWSO backlogItem) Updates an existing backlog item.
ImpedimentWSO	updateImpediment(ImpedimentWSO impediment) Updates an existing impediment.
ReleaseWSO	updateRelease(ReleaseWSO release) Updates an existing release.
SprintWSO	updateSprint(SprintWSO sprint) Updates an existing sprint.
SprintWSO	updateSprintWithNonWorkingDays(SprintWSO sprint, java.lang.Long[] nonWorkingDays) Updates an existing sprint.
TaskWSO	updateTask(TaskWSO task) Updates an existing task.
TaskWSO	updateTaskEstimate(TaskWSO task, java.util.Date date, int estimate) Updates a task's estimate for the given day.
void	updateTaskHoursSpent(UserWSO user, TaskWSO task, java.util.Date date, double hoursSpent) Update the task hours spent for the given user on the given date.

Method Detail

getTest

java.lang.String getTest()
                         throws java.rmi.RemoteException

Dummy method for checking connectivity. Doesn't require authentication. Returns "Brilliant!"

Throws:

java.rmi.RemoteException

getAuthenticatedTest

java.lang.String getAuthenticatedTest()
                                      throws java.rmi.RemoteException

Dummy method for checking connectivity and authentication. Requires authentication. Returns "PaulaBean"

Throws:

java.rmi.RemoteException

getTimezone

java.lang.String getTimezone()
                             throws java.rmi.RemoteException

Returns the TimeZone the server is in. Useful for synchronizing dates on the client and server.

Throws:

java.rmi.RemoteException

getProducts

ProductWSO[] getProducts()
                         throws com.danube.scrumworks.exception.ServerException,
                                java.rmi.RemoteException

Returns a list of all products in ScrumWorks.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getTeamsForProduct

TeamWSO[] getTeamsForProduct(ProductWSO product)
                             throws com.danube.scrumworks.exception.ServerException,
                                    java.rmi.RemoteException

Returns the teams associated with the given product.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getBacklogItem

BacklogItemWSO getBacklogItem(java.lang.Long backlogItemId)
                              throws com.danube.scrumworks.exception.ServerException,
                                     java.rmi.RemoteException

Returns the backlog item with the given id.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getBacklogItemByKey

BacklogItemWSO getBacklogItemByKey(java.lang.String backlogItemKey)
                                   throws com.danube.scrumworks.exception.ServerException,
                                          java.rmi.RemoteException

Returns the backlog item with the given key.

Parameters:

backlogItemKey - BacklogItemWSO.getKey()

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getBacklogItems

BacklogItemWSO[] getBacklogItems(java.lang.Long[] backlogItemIds)
                                 throws com.danube.scrumworks.exception.ServerException,
                                        java.rmi.RemoteException

Returns the backlog items with the given ids.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getActiveBacklogItems

BacklogItemWSO[] getActiveBacklogItems(ProductWSO product)
                                       throws com.danube.scrumworks.exception.ServerException,
                                              java.rmi.RemoteException

Returns a list of all active backlog items for a given product. Active backlog items are ones that show up in the scheduler. Backlog items are marked inactive when they're deleted but you wish to retain the estimate history.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

http://danube.com/docs/scrumworks/latest/userguide.html#deletepbi

getInactiveBacklogItems

BacklogItemWSO[] getInactiveBacklogItems(ProductWSO product)
                                         throws com.danube.scrumworks.exception.ServerException,
                                                java.rmi.RemoteException

Returns a list of all inactive backlog items for a given product. Backlog items are marked inactive when they're deleted but you wish to retain the estimate history.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

http://danube.com/docs/scrumworks/latest/userguide.html#deletepbi

getActiveBacklogItemsForRelease

BacklogItemWSO[] getActiveBacklogItemsForRelease(ReleaseWSO release)
                                                 throws com.danube.scrumworks.exception.ServerException,
                                                        java.rmi.RemoteException

Returns a list of active backlog items for a given release, in the same order as they appear in the backlog scheduler.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

getActiveBacklogItems(ProductWSO)

getActiveBacklogItemsForSprint

BacklogItemWSO[] getActiveBacklogItemsForSprint(SprintWSO sprint)
                                                throws com.danube.scrumworks.exception.ServerException,
                                                       java.rmi.RemoteException

Returns a list of active backlog items for a given sprint, in the same order as they appear in the backlog scheduler.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

getActiveBacklogItems(ProductWSO)

getBacklogItemEstimates

BacklogItemEstimateWSO[] getBacklogItemEstimates(BacklogItemWSO backlogItem)
                                                 throws com.danube.scrumworks.exception.ServerException,
                                                        java.rmi.RemoteException

Gets the list of backlog item estimates for a given backlog item.

Returns:

a chronological list of backlog item estimates

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getImpediments

ImpedimentWSO[] getImpediments(ProductWSO product)
                               throws com.danube.scrumworks.exception.ServerException,
                                      java.rmi.RemoteException

Gets the impediments for a given product.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getReleases

ReleaseWSO[] getReleases(ProductWSO product)
                         throws com.danube.scrumworks.exception.ServerException,
                                java.rmi.RemoteException

Returns the releases associated with the given product.

Returns:

the releases in the order they appear in the backlog planner

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getSprints

SprintWSO[] getSprints(ProductWSO product)
                       throws com.danube.scrumworks.exception.ServerException,
                              java.rmi.RemoteException

Returns the list of sprints for the given product. Sprints that have been marked inactive (removed) are not included.

Returns:

active sprints sorted by date

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getSprintsForTeam

SprintWSO[] getSprintsForTeam(ProductWSO product,
                              TeamWSO team)
                              throws com.danube.scrumworks.exception.ServerException,
                                     java.rmi.RemoteException

Returns the list of sprints for the given product and team. Sprints that have been marked inactive (removed) are not included.

Returns:

active sprints sorted by date

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getUsers

UserWSO[] getUsers()
                   throws com.danube.scrumworks.exception.ServerException,
                          java.rmi.RemoteException

Returns the list of users in the system. Does not include the Administrator user.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getUsersForSprint

java.lang.String[] getUsersForSprint(SprintWSO sprint)
                                     throws com.danube.scrumworks.exception.ServerException,
                                            java.rmi.RemoteException

Returns the list of all user names with timesheet entries for all tasks within the given sprint. Plus all user names for the current team members of the given sprint. Timesheet entries for user names that have been removed from the system are included.

Parameters:

sprint - The sprint

Returns:

An array of user names which can be used to retrieve task hours spent.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

getTaskHoursSpentForTask(String, TaskWSO)

getTeams

TeamWSO[] getTeams()
                   throws com.danube.scrumworks.exception.ServerException,
                          java.rmi.RemoteException

Returns the list of teams in the system.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getTeam

TeamWSO getTeam(SprintWSO sprint)
                throws com.danube.scrumworks.exception.ServerException,
                       java.rmi.RemoteException

Returns the team for the given sprint.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getTeamMembers

UserWSO[] getTeamMembers(TeamWSO team)
                         throws com.danube.scrumworks.exception.ServerException,
                                java.rmi.RemoteException

Returns the list of team members for the given team.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getTasks

TaskWSO[] getTasks(BacklogItemWSO backlogItem)
                   throws com.danube.scrumworks.exception.ServerException,
                          java.rmi.RemoteException

Returns the tasks for the given backlog item.

Returns:

the sorted (as displayed in the desktop client) tasks

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getTasksForSprint

TaskWSO[] getTasksForSprint(SprintWSO sprint)
                            throws com.danube.scrumworks.exception.ServerException,
                                   java.rmi.RemoteException

Returns the list of tasks for the given sprint ordered by backlog item rank then task rank.

Parameters:

sprint - The sprint

Returns:

An array of tasks for the given sprint

Throws:

ServerException - if an error occurs

java.rmi.RemoteException

getTaskEstimates

TaskEstimateWSO[] getTaskEstimates(TaskWSO task)
                                   throws com.danube.scrumworks.exception.ServerException,
                                          java.rmi.RemoteException

Returns the task estimates for the given task in chronological order.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

updateTaskEstimate

TaskWSO updateTaskEstimate(TaskWSO task,
                           java.util.Date date,
                           int estimate)
                           throws com.danube.scrumworks.exception.ServerException,
                                  java.rmi.RemoteException

Updates a task's estimate for the given day.

Parameters:

date - The estimate date. The time part of the object is not used to set the estimate (there's at most one estimate for a task for a day).

estimate - A non-negative integer.

Returns:

The updated task.

Throws:

ServerException - If the estimate is invalid.

java.rmi.RemoteException

See Also:

deleteTaskEstimate(TaskWSO, Date)

deleteTaskEstimate

TaskWSO deleteTaskEstimate(TaskWSO task,
                           java.util.Date date)
                           throws com.danube.scrumworks.exception.ServerException,
                                  java.rmi.RemoteException

Removes a task's estimate for the given day.

Returns:

The updated task.

Throws:

ServerException - If the only estimate for the task is attempted to be deleted.

java.rmi.RemoteException

createBacklogItem

BacklogItemWSO createBacklogItem(BacklogItemWSO backlogItem)
                                 throws com.danube.scrumworks.exception.ServerException,
                                        java.rmi.RemoteException

Creates a backlog item. The newly created backlog item is placed on the top of it's release or sprint.

Returns:

The created backlog item. It is different from the object passed in as some of the fields are modified by the server.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

updateBacklogItem

BacklogItemWSO updateBacklogItem(BacklogItemWSO backlogItem)
                                 throws com.danube.scrumworks.exception.ServerException,
                                        java.rmi.RemoteException

Updates an existing backlog item. Note: to move the backlog item, it's recommended to use the moveBacklogItem* methods instead of updating its rank, sprintId or releaseId fields.

Returns:

The updated backlog item. It might be different from the object passed to the method.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

moveBacklogItemAfter(BacklogItemWSO, BacklogItemWSO), moveBacklogItemIntoRelease(BacklogItemWSO, ReleaseWSO), moveBacklogItemIntoSprint(BacklogItemWSO, SprintWSO)

updateTask

TaskWSO updateTask(TaskWSO task)
                   throws com.danube.scrumworks.exception.ServerException,
                          java.rmi.RemoteException

Updates an existing task. Note: to move the task it's recommended to use the moveTask* methods instead of updating its rank or backlogItemId fields.

Returns:

The updated task. It might be different from the object passed in.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

createTask

TaskWSO createTask(TaskWSO task)
                   throws com.danube.scrumworks.exception.ServerException,
                          java.rmi.RemoteException

Creates a task. The task will be the first task in it's backlog item.

Returns:

The task created on the server. It is different from the object passed to the method so clients should use the returned object.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveTaskAfter

TaskWSO moveTaskAfter(TaskWSO itemToMove,
                      TaskWSO dudeBefore)
                      throws com.danube.scrumworks.exception.ServerException,
                             java.rmi.RemoteException

Moves a task after another task in the backlog. The task to move can be in a different backlog item than the target task.

Returns:

The object which reflects the state of the moved task after the moving.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveTasksAfter

TaskWSO[] moveTasksAfter(TaskWSO[] itemsToMove,
                         TaskWSO dudeBefore)
                         throws com.danube.scrumworks.exception.ServerException,
                                java.rmi.RemoteException

Moves a set of tasks after another task in the backlog. After the moving the tasks will be in the same order in the backlog as they are in the array itemsToMove. The tasks to move aren't required to have the same parent.

Returns:

The objects which reflect the state of the moved tasks after the moving.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveTaskIntoBacklogItem

TaskWSO moveTaskIntoBacklogItem(TaskWSO itemToMove,
                                BacklogItemWSO backlogItem)
                                throws com.danube.scrumworks.exception.ServerException,
                                       java.rmi.RemoteException

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveTasksIntoBacklogItem

TaskWSO[] moveTasksIntoBacklogItem(TaskWSO[] itemsToMove,
                                   BacklogItemWSO backlogItem)
                                   throws com.danube.scrumworks.exception.ServerException,
                                          java.rmi.RemoteException

Moves a set of tasks into a backlog item. The tasks will be the topmost tasks in the backlog item. After the moving the tasks will be in the same order in the backlog as they are in the array itemsToMove. The tasks to move aren't required to have the same parent.

Returns:

The objects which reflect the state of the moved tasks after the moving.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

deleteTask

void deleteTask(TaskWSO task)
                throws com.danube.scrumworks.exception.ServerException,
                       java.rmi.RemoteException

Deletes a task from the backlog.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

deleteBacklogItem

void deleteBacklogItem(BacklogItemWSO backlogItem)
                       throws com.danube.scrumworks.exception.ServerException,
                              java.rmi.RemoteException

Deletes a backlog item from the backlog along with its estimates. The difference between this method and markBacklogItemInactive is that the latter will preserve the historical information (estimates) about the backlog item which will show up in various reports/charts.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

markBacklogItemInactive(BacklogItemWSO), http://danube.com/docs/scrumworks/latest/userguide.html#deletepbi

markBacklogItemInactive

void markBacklogItemInactive(BacklogItemWSO backlogItem)
                             throws com.danube.scrumworks.exception.ServerException,
                                    java.rmi.RemoteException

Marks a backlog item inactive.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

deleteBacklogItem(BacklogItemWSO), http://danube.com/docs/scrumworks/latest/userguide.html#deletepbi

moveBacklogItemAfter

BacklogItemWSO moveBacklogItemAfter(BacklogItemWSO itemToMove,
                                    BacklogItemWSO dudeBefore)
                                    throws com.danube.scrumworks.exception.ServerException,
                                           java.rmi.RemoteException

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveBacklogItemIntoSprint

BacklogItemWSO moveBacklogItemIntoSprint(BacklogItemWSO itemToMove,
                                         SprintWSO sprint)
                                         throws com.danube.scrumworks.exception.ServerException,
                                                java.rmi.RemoteException

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveBacklogItemIntoRelease

BacklogItemWSO moveBacklogItemIntoRelease(BacklogItemWSO itemToMove,
                                          ReleaseWSO release)
                                          throws com.danube.scrumworks.exception.ServerException,
                                                 java.rmi.RemoteException

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveBacklogItemsAfter

BacklogItemWSO[] moveBacklogItemsAfter(BacklogItemWSO[] itemsToMove,
                                       BacklogItemWSO dudeBefore)
                                       throws com.danube.scrumworks.exception.ServerException,
                                              java.rmi.RemoteException

Moves a set of backlog items after a backlog item. After the moving the backlog items will be in the same order in the backlog as they are in the array itemsToMove. The backlog items to move aren't required to have the same parent.

Returns:

The objects which reflect the state of the moved backlog items after the moving.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveBacklogItemsIntoSprint

BacklogItemWSO[] moveBacklogItemsIntoSprint(BacklogItemWSO[] itemsToMove,
                                            SprintWSO sprint)
                                            throws com.danube.scrumworks.exception.ServerException,
                                                   java.rmi.RemoteException

Moves a set of backlog items into a sprint. The backlog items will become the top priority backlog items in the sprint. After moving the backlog items, they will be in the same order in the backlog as they are in the array itemsToMove. The backlog items to move aren't required to have the same parent.

Returns:

The objects which reflect the state of the moved backlog items after the moving.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveBacklogItemsIntoRelease

BacklogItemWSO[] moveBacklogItemsIntoRelease(BacklogItemWSO[] itemsToMove,
                                             ReleaseWSO release)
                                             throws com.danube.scrumworks.exception.ServerException,
                                                    java.rmi.RemoteException

Moves a set of backlog items into a release. The backlog items will become the top priority backlog items in the release. After moving the backlog items, they will be in the same order in the backlog as they are in the array itemsToMove. The backlog items to move aren't required to have the same parent.

Returns:

The objects which reflect the state of the moved backlog items after moving.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveReleaseBefore

ReleaseWSO moveReleaseBefore(ReleaseWSO itemToMove,
                             ReleaseWSO dudeAfter)
                             throws com.danube.scrumworks.exception.ServerException,
                                    java.rmi.RemoteException

Moves a release after another release so that it shows up first in the backlog planner.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

moveReleaseAfter

ReleaseWSO moveReleaseAfter(ReleaseWSO itemToMove,
                            ReleaseWSO dudeBefore)
                            throws com.danube.scrumworks.exception.ServerException,
                                   java.rmi.RemoteException

Moves a release before another release so that it shows up second in the backlog planner.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

createRelease

ReleaseWSO createRelease(ReleaseWSO release,
                         ProductWSO product)
                         throws com.danube.scrumworks.exception.ServerException,
                                java.rmi.RemoteException

Creates a new release in the given product. The start date and the release date should be specified or left empty together. The rank supplied is ignored. New Releases are created before all other releases. Use moveReleaseAfter(ReleaseWSO, ReleaseWSO) and moveReleaseBefore(ReleaseWSO, ReleaseWSO) to rerank releases.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

updateRelease

ReleaseWSO updateRelease(ReleaseWSO release)
                         throws com.danube.scrumworks.exception.ServerException,
                                java.rmi.RemoteException

Updates an existing release. For reordering or moving releases, it's recommended to use the moveRelease* methods instead of modifiying the releases' rank field. The start date and the release date should be specified or left empty together.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

moveReleaseAfter(ReleaseWSO, ReleaseWSO), moveReleaseBefore(ReleaseWSO, ReleaseWSO)

deleteEmptyRelease

void deleteEmptyRelease(ReleaseWSO release)
                        throws com.danube.scrumworks.exception.ServerException,
                               java.rmi.RemoteException

Deletes an empty release. The last release can not be deleted.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

createSprint

SprintWSO createSprint(SprintWSO sprint)
                       throws com.danube.scrumworks.exception.ServerException,
                              java.rmi.RemoteException

Creates a sprint for the given team. The team must be an already existing team. The passed sprint must have it's releaseId field set.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

createSprintWithNonWorkingDays

SprintWSO createSprintWithNonWorkingDays(SprintWSO sprint,
                                         java.lang.Long[] nonWorkingDays)
                                         throws com.danube.scrumworks.exception.ServerException,
                                                java.rmi.RemoteException

Creates a new sprint with the given SprintWSO instance. A Team that is to be associated with this Sprint must already exist. A Product that is to be associated with this Sprint must already exist.

Parameters:

sprint - The sprint to be created.

nonWorkingDays - an array of nonWorkingDays to be removed from the Burndown chart, so that, for example, Weekends and Holidays do not create an inaccurate perception of Sprint progress. The value for nonWorkingDays is a timestamp, that is, the number of milliseconds since January 1, 1970, 00:00:00 GMT. It can be obtained by calling getTime() on a Date object.

Throws:

ServerException - if invalid input is given or the server encounters an error.

java.rmi.RemoteException

updateSprint

SprintWSO updateSprint(SprintWSO sprint)
                       throws com.danube.scrumworks.exception.ServerException,
                              java.rmi.RemoteException

Updates an existing sprint.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

updateSprintWithNonWorkingDays

SprintWSO updateSprintWithNonWorkingDays(SprintWSO sprint,
                                         java.lang.Long[] nonWorkingDays)
                                         throws com.danube.scrumworks.exception.ServerException,
                                                java.rmi.RemoteException

Updates an existing sprint.

Parameters:

sprint - the existing sprint to be updated.

nonWorkingDays - an array of nonWorkingDays to be removed from the Burndown chart, so that, for example, Weekends and Holidays do not create an inaccurate perception of Sprint progress. The value for nonWorkingDays is a timestamp, that is, the number of milliseconds since January 1, 1970, 00:00:00 GMT. It can be obtained by calling getTime() on a Date object.

Throws:

ServerException - if invalid input is given or the server encounters an error.

java.rmi.RemoteException

getSprintNonWorkingDays

java.lang.Long[] getSprintNonWorkingDays(java.lang.Long sprintId)
                                         throws com.danube.scrumworks.exception.ServerException,
                                                java.rmi.RemoteException

Obtain the non working days for the given sprint id.

Parameters:

sprintId - The identifier for the sprint in which the non-working days is to be returned.

Returns:

An array of timestamps representing non-working days. If there is no non-working days null is returned. The timestamp is the number of milliseconds since January 1, 1970, 00:00:00 GMT.

Throws:

ServerException

java.rmi.RemoteException

deleteEmptySprint

void deleteEmptySprint(SprintWSO sprint)
                       throws com.danube.scrumworks.exception.ServerException,
                              java.rmi.RemoteException

Deletes an empty sprint.

Throws:

ServerException - If the sprint didn't exist of if it wasn't empty. Note: if the sprint contains inactive backlog items, it isn't empty.

java.rmi.RemoteException

createImpediment

ImpedimentWSO createImpediment(ImpedimentWSO impediment,
                               ProductWSO product)
                               throws com.danube.scrumworks.exception.ServerException,
                                      java.rmi.RemoteException

Creates a new impediment. The following fields of the parameter impedimentsshould be empty: lastModDate, resolutionDate. These are set by the server.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

updateImpediment

ImpedimentWSO updateImpediment(ImpedimentWSO impediment)
                               throws com.danube.scrumworks.exception.ServerException,
                                      java.rmi.RemoteException

Updates an existing impediment. The following modifications are not allowed:
- Changing the last modification date of impediments, because it's set by the server automatically
- Reassigning an impediment to another team
- Changing the entry date or the summary

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

createTheme

ThemeWSO createTheme(ThemeWSO theme,
                     ProductWSO product)
                     throws com.danube.scrumworks.exception.ServerException,
                            java.rmi.RemoteException

Creates a new theme in the given product.

Parameters:

theme - The theme to create. Do not specify an ID in the WSO

product - The theme the product belongs to

Returns:

A new WSO with the ID field set

Throws:

ServerException - if invalid input is found or an error occurs

java.rmi.RemoteException

deleteTheme

void deleteTheme(ThemeWSO theme)
                 throws com.danube.scrumworks.exception.ServerException,
                        java.rmi.RemoteException

Deletes a theme. The backlog items associated with the theme are not deleted.

Parameters:

theme - The theme to delete. It must have an ID

Throws:

ServerException - if invalid input is given or an error occurs

java.rmi.RemoteException

renameTheme

ThemeWSO renameTheme(ThemeWSO theme,
                     java.lang.String newName)
                     throws com.danube.scrumworks.exception.ServerException,
                            java.rmi.RemoteException

Renames a theme.

Parameters:

theme - the existing theme you want to rename

newName - the new name of the theme

Returns:

A new WSO with the new name

Throws:

ServerException - if invalid input is given or an error occurs

java.rmi.RemoteException

mergeThemes

void mergeThemes(ThemeWSO themeToMerge,
                 ThemeWSO themeToMergeInto)
                 throws com.danube.scrumworks.exception.ServerException,
                        java.rmi.RemoteException

Merges a theme into another one. The backlog items which had the theme themeToMerge will have the theme themeToMergeInto added instead and themeToMerge is deleted.

Parameters:

themeToMerge - the existing theme you want to merge into another one

themeToMergeInto - the existing theme you want the other theme merge into

Throws:

ServerException - if invalid input is detected or an error occurs

java.rmi.RemoteException

getThemes

ThemeWSO[] getThemes(ProductWSO product)
                     throws com.danube.scrumworks.exception.ServerException,
                            java.rmi.RemoteException

Lists all themes for the given product

Parameters:

product - the product you want themes for

Returns:

the themes for the given product

Throws:

ServerException - if an error occurs

java.rmi.RemoteException

getBacklogItemsForTheme

BacklogItemWSO[] getBacklogItemsForTheme(ThemeWSO theme)
                                         throws com.danube.scrumworks.exception.ServerException,
                                                java.rmi.RemoteException

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

addBacklogItemsToTheme

void addBacklogItemsToTheme(BacklogItemWSO[] backlogItems,
                            ThemeWSO theme)
                            throws com.danube.scrumworks.exception.ServerException,
                                   java.rmi.RemoteException

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

removeBacklogItemsFromTheme

void removeBacklogItemsFromTheme(BacklogItemWSO[] backlogItems,
                                 ThemeWSO theme)
                                 throws com.danube.scrumworks.exception.ServerException,
                                        java.rmi.RemoteException

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getPermissions

PermissionWSO[] getPermissions()
                               throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getDashboardStatistics

DashboardReleaseStatisticsWSO[] getDashboardStatistics(ProductWSO product,
                                                       java.util.Date startDate,
                                                       java.util.Date endDate)
                                                       throws com.danube.scrumworks.exception.ServerException,
                                                              java.rmi.RemoteException

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getTaskHoursSpentForTask

TaskHoursSpentWSO[] getTaskHoursSpentForTask(java.lang.String displayName,
                                             TaskWSO task)
                                             throws com.danube.scrumworks.exception.ServerException,
                                                    java.rmi.RemoteException

Returns the hours spent by a user on a single task, ordered by date

Parameters:

displayName - The display name of the user, as returned by getUsersForSprint(SprintWSO) or UserWSO.getDisplayName()

task - The task

Returns:

An array of user names which can be used to retrieve task hours spent.

Throws:

ServerException - if an error occurs

java.rmi.RemoteException

See Also:

UserWSO.getDisplayName(), getUsersForSprint(SprintWSO), getTasksForSprint(SprintWSO)

getTotalTaskHoursSpentForTask

TaskHoursSpentWSO[] getTotalTaskHoursSpentForTask(TaskWSO task)
                                                  throws com.danube.scrumworks.exception.ServerException,
                                                         java.rmi.RemoteException

Returns the total hours spent by all users for the given task, ordered by date

Parameters:

task - The task

Returns:

the total hours spent on a single task for all users, ordered by date

Throws:

ServerException - if an error occurs

java.rmi.RemoteException

See Also:

getTasksForSprint(SprintWSO)

updateTaskHoursSpent

void updateTaskHoursSpent(UserWSO user,
                          TaskWSO task,
                          java.util.Date date,
                          double hoursSpent)
                          throws com.danube.scrumworks.exception.ServerException,
                                 java.rmi.RemoteException

Update the task hours spent for the given user on the given date.

Parameters:

user - The user that spent the hours.

task - The task for which the hours were spent.

hoursSpent - A non-negative decimal value representing the hours spent.

date - The date on which the hours were spent.

Throws:

ServerException - if an error occurs

java.rmi.RemoteException