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.
CommentWSO	createCommentForBacklogItem(BacklogItemWSO backlogItem, java.lang.String comment) Creates a comment for the given backlog item.
CommentWSO	createCommentForTask(TaskWSO task, java.lang.String comment) Creates a comment for the given task.
ImpedimentWSO	createImpediment(ImpedimentWSO impedimentWSO, ProductWSO productWSO) Creates a new impediment.
ReleaseWSO	createRelease(ReleaseWSO release) Creates a new release.
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) Creates a new theme.
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[]	getActiveBacklogItemsForReleaseInProduct(ReleaseWSO release, ProductWSO product) Returns a list of active backlog items for a given release in a product, 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.
BacklogItemWSO[]	getActiveBacklogItemsForTheme(ThemeWSO theme) Gets the active backlog items tagged with the indicated theme.
BacklogItemWSO[]	getActiveBacklogItemsForThemeInProduct(ThemeWSO theme, ProductWSO product) Gets the active backlog items for a specified theme and product.
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.
CommentWSO[]	getCommentsForBacklogItem(BacklogItemWSO backlogItem) Lists comments for a particular backlog item.
CommentWSO[]	getCommentsForTask(TaskWSO task) Lists comments for a particular task.
DashboardReleaseStatisticsWSO[]	getDashboardStatistics(ProductWSO product, java.util.Date startDate, java.util.Date endDate) Gets statistics about the releases within the given date range for a product.
EpicWSO[]	getEpicsForRelease(ReleaseWSO release) Lists Product Epics for the given Product Release, or list Program Epics for the given Program Release.
EpicWSO[]	getEpicsForReleaseInProduct(ReleaseWSO release, ProductWSO product) Lists Epics for the given Product or Program Release within the given Product.
ImpedimentWSO	getImpedimentById(java.lang.Long impedimentId) Finds an impediment by id.
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	getProductByName(java.lang.String productName) Finds a product by name.
EpicWSO[]	getProductEpicsForEpic(EpicWSO epic) When provided with a Program Epic, returns all the Product Epics using that Program Epic.
ProductWSO[]	getProducts() Returns a list of all products in ScrumWorks.
ProgramWSO	getProgramById(java.lang.Long programId) Returns the program with the given id.
ProgramWSO[]	getPrograms() Returns all the programs in ScrumWorks.
ReleaseWSO[]	getReleases(ProductWSO product) Deprecated. Replaced by getReleasesForProduct(ProductWSO)
ReleaseWSO[]	getReleasesForProduct(ProductWSO product) Returns the releases associated with the given product.
ReleaseWSO[]	getReleasesForProgram(ProgramWSO program) Lists the Program's releases in the order they appear in the Program Release Planner.
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.
TaskWSO	getTaskById(java.lang.Long taskId) Returns the task with the given id.
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.
java.lang.String[]	getTaskStatuses() Returns the available task status names.
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) Deprecated. Replaced by getThemesForProduct(ProductWSO)
ThemeWSO[]	getThemesForProduct(ProductWSO product) Lists all product and program themes for the given product.
ThemeWSO[]	getThemesForProgram(ProgramWSO program) Finds the themes for a program.
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
UncategorizedBudgetWSO	getUncategorizedBudgetForReleaseInProduct(ReleaseWSO release, ProductWSO product) Gets the uncategorized budget for the given Release within the given Product.
UncategorizedBudgetWSO[]	getUncategorizedBudgetsForRelease(ReleaseWSO release) Lists all uncategorized budgets for the given Program Release, or list the single uncategorized budget for a Product Release.
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.
java.lang.String	getVersion() Returns the Version number of this server.
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 itemAbove)
BacklogItemWSO	moveBacklogItemIntoRelease(BacklogItemWSO itemToMove, ReleaseWSO release)
BacklogItemWSO	moveBacklogItemIntoSprint(BacklogItemWSO itemToMove, SprintWSO sprint)
BacklogItemWSO[]	moveBacklogItemsAfter(BacklogItemWSO[] itemsToMove, BacklogItemWSO itemBefore) Moves a set of backlog items after a backlog item.
BacklogItemWSO[]	moveBacklogItemsIntoProductRelease(BacklogItemWSO[] itemsToMove, ReleaseWSO release) Moves a set of backlog items into a product release.
BacklogItemWSO[]	moveBacklogItemsIntoRelease(BacklogItemWSO[] itemsToMove, ReleaseWSO release, ProductWSO product) Moves a set of backlog items into a program or product release in a product.
BacklogItemWSO[]	moveBacklogItemsIntoSprint(BacklogItemWSO[] itemsToMove, SprintWSO sprint) Moves a set of backlog items into a sprint.
ReleaseWSO	moveReleaseAfter(ReleaseWSO releaseToMove, ReleaseWSO releaseAbove) Moves a product release after another product release in the release planner.
void	moveReleaseAfterInProduct(ReleaseWSO releaseToMove, ReleaseWSO releaseAbove, ProductWSO product) Moves a product or program release after another product or program release within the given the product.
ReleaseWSO	moveReleaseBefore(ReleaseWSO releaseToMove, ReleaseWSO releaseBelow) Moves a product release before another product release in the release planner.
void	moveReleaseBeforeInProduct(ReleaseWSO releaseToMove, ReleaseWSO releaseBelow, ProductWSO product) Moves a product or program release before another product or program release within the given product.
TaskWSO	moveTaskAfter(TaskWSO itemToMove, TaskWSO taskAbove) Moves a task after another task in the backlog.
TaskWSO	moveTaskIntoBacklogItem(TaskWSO itemToMove, BacklogItemWSO backlogItem)
TaskWSO[]	moveTasksAfter(TaskWSO[] itemsToMove, TaskWSO taskAbove) Moves 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

getVersion

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

Returns the Version number of this server.

Returns:

the ScrumWorks Pro Server version number.

Throws:

java.rmi.RemoteException

getPrograms

ProgramWSO[] getPrograms()
                         throws com.danube.scrumworks.exception.ServerException,
                                java.rmi.RemoteException

Returns all the programs in ScrumWorks.

Returns:

all the programs.

Throws:

ServerException - if there is an error retrieving a program.

java.rmi.RemoteException

getProgramById

ProgramWSO getProgramById(java.lang.Long programId)
                          throws com.danube.scrumworks.exception.ServerException,
                                 java.rmi.RemoteException

Returns the program with the given id.

Throws:

ServerException - if the argument is not a valid program id.

java.rmi.RemoteException

getReleases

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

Deprecated. Replaced by getReleasesForProduct(ProductWSO)

Returns the releases associated with the given product.

Parameters:

product - the product

Returns:

the releases in the order they appear in the backlog planner

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getReleasesForProduct

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

Returns the releases associated with the given product.

Parameters:

product - the product

Returns:

the releases for the product in the order they appear in the backlog planner

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

getReleasesForProgram

ReleaseWSO[] getReleasesForProgram(ProgramWSO program)
                                   throws com.danube.scrumworks.exception.ServerException,
                                          java.rmi.RemoteException

Lists the Program's releases in the order they appear in the Program Release Planner.

Parameters:

program - the program

Throws:

ServerException - if the argument is not an existing program.

java.rmi.RemoteException

getEpicsForRelease

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

Lists Product Epics for the given Product Release, or list Program Epics for the given Program Release.

Parameters:

release - The Product or Program Release to get the Epics for.

Returns:

The Product or Program Epics for the given release, or null if none exist, ordered by rank.

Throws:

ServerException - if there is an error loading the Epics.

java.lang.IllegalArgumentException - if the release is invalid or null.

java.rmi.RemoteException

getEpicsForReleaseInProduct

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

Lists Epics for the given Product or Program Release within the given Product. If a Product Release is given this method acts the same as calling getEpicsForRelease(ReleaseWSO).

Parameters:

release - The Product or Program Release to get the Epics for.

product - The Product containing the given Release.

Returns:

The Epics for the given release, or null if none exist, ordered by rank.

Throws:

ServerException - if there is an error loading the Epics.

java.lang.IllegalArgumentException - the release is invalid or inconsistent with the product or if an argument is null

java.rmi.RemoteException

getProductEpicsForEpic

EpicWSO[] getProductEpicsForEpic(EpicWSO epic)
                                 throws com.danube.scrumworks.exception.ServerException,
                                        java.rmi.RemoteException

When provided with a Program Epic, returns all the Product Epics using that Program Epic. When provided with a Product Epic, returns the original Epic.

Parameters:

epic - The Epic to search for.

Returns:

all Product Epics using the given Epic, or null if none exist.

Throws:

ServerException - if the argument is null or there is an error assembling the data.

java.rmi.RemoteException

getCommentsForBacklogItem

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

Lists comments for a particular backlog item.

Parameters:

backlogItem - the backlog item to list comments of

Returns:

the comments in chronological order (oldest first)

Throws:

ServerException - if the argument is null or there is an error finding the comments

java.rmi.RemoteException

getCommentsForTask

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

Lists comments for a particular task.

Parameters:

task - the task to list comments of.

Returns:

the comments in chronological order (oldest first)

Throws:

ServerException - if the argument is null or there is an error finding the comments

java.rmi.RemoteException

createCommentForBacklogItem

CommentWSO createCommentForBacklogItem(BacklogItemWSO backlogItem,
                                       java.lang.String comment)
                                       throws com.danube.scrumworks.exception.ServerException,
                                              java.rmi.RemoteException

Creates a comment for the given backlog item. The comment is attributed to the current user.

Parameters:

backlogItem - The backlog item the comment is for

comment - The text of the comment

Returns:

the comment that was created

Throws:

ServerException - if any argument is null or there is an error creating the comment

java.rmi.RemoteException

createCommentForTask

CommentWSO createCommentForTask(TaskWSO task,
                                java.lang.String comment)
                                throws com.danube.scrumworks.exception.ServerException,
                                       java.rmi.RemoteException

Creates a comment for the given task. The comment is attributed to the current user.

Parameters:

task - The task the comment is for

comment - The text of the comment

Returns:

the comment that was created

Throws:

ServerException - if any argument is null or there is an error creating the comment

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

getProductByName

ProductWSO getProductByName(java.lang.String productName)
                            throws com.danube.scrumworks.exception.ServerException,
                                   java.rmi.RemoteException

Finds a product by name.

Returns:

the product with the given name.

Throws:

ServerException - if the argument is null, there is no product with the name provided, or there is an error loading the product.

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/pro/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/pro/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. If the argument is a program release, this method will return all the backlog items for the program release from all the products the release is in.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

getActiveBacklogItems(ProductWSO), getActiveBacklogItemsForReleaseInProduct(ReleaseWSO, ProductWSO)

getActiveBacklogItemsForReleaseInProduct

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

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

Parameters:

release - the release

product - the product

Throws:

ServerException - if an arguments doesn't represent an existing object in ScrumWorks or if the release is not in the product.

java.rmi.RemoteException

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

getImpedimentById

ImpedimentWSO getImpedimentById(java.lang.Long impedimentId)
                                throws com.danube.scrumworks.exception.ServerException,
                                       java.rmi.RemoteException

Finds an impediment by id.

Parameters:

impedimentId - identifies an impediment.

Returns:

the requested impediment.

Throws:

ServerException - if the argument is not a valid impediment ID or there is an error loading the impediment.

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.

Parameters:

product - the product

team - the team

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

getTaskStatuses

java.lang.String[] getTaskStatuses()
                                   throws java.rmi.RemoteException

Returns the available task status names.

Returns:

the available task status names.

Throws:

java.rmi.RemoteException

getTaskById

TaskWSO getTaskById(java.lang.Long taskId)
                    throws com.danube.scrumworks.exception.ServerException,
                           java.rmi.RemoteException

Returns the task with the given id.

Parameters:

taskId - identifies a task.

Returns:

the requested task, or null if the task is not found.

Throws:

ServerException - if the argument is null or there is an error retrieving the requested task.

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:

task - the task to update

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 or an argument is null

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 at the bottom of it's release or sprint.

Parameters:

backlogItem - the backlog item to create.

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. A ServerException is thrown if the Global administrator or Product Administrator or Edit Product Backlog Item permission is not present.

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.

Parameters:

task - the task

Returns:

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

Throws:

ServerException - if there is an error updating the task

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 its backlog item.

Parameters:

task - the task to create

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:

ServerException - the server exception

java.rmi.RemoteException

moveTaskAfter

TaskWSO moveTaskAfter(TaskWSO itemToMove,
                      TaskWSO taskAbove)
                      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 taskAbove)
                         throws com.danube.scrumworks.exception.ServerException,
                                java.rmi.RemoteException

Moves 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. A ServerException is thrown if the Global administrator or Product Administrator or Delete Product Backlog Item permission is not present.

Throws:

com.danube.scrumworks.exception.ServerException

java.rmi.RemoteException

See Also:

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

markBacklogItemInactive

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

Marks a backlog item inactive.

Parameters:

backlogItem - the backlog item

Throws:

ServerException - if the argument is not a valid backlog item or there's an error marking it inactive.

java.rmi.RemoteException

See Also:

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

moveBacklogItemAfter

BacklogItemWSO moveBacklogItemAfter(BacklogItemWSO itemToMove,
                                    BacklogItemWSO itemAbove)
                                    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

moveBacklogItemsAfter

BacklogItemWSO[] moveBacklogItemsAfter(BacklogItemWSO[] itemsToMove,
                                       BacklogItemWSO itemBefore)
                                       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.

Parameters:

itemsToMove - the items to move

itemBefore - the item to move the backlog items below

Returns:

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

Throws:

ServerException - if any of the arguments are invalid or a server error occurs when moving the backlog items

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

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

moveBacklogItemsIntoProductRelease

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

Moves a set of backlog items into a product 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

moveBacklogItemsIntoRelease

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

Moves a set of backlog items into a program or product release in a product. 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.

Parameters:

itemsToMove - the backlog items to move.

release - the release to move the backlog items into, must be a product release in the product or a program release which is included in the product.

product - the product the release is in.

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 releaseToMove,
                             ReleaseWSO releaseBelow)
                             throws com.danube.scrumworks.exception.ServerException,
                                    java.rmi.RemoteException

Moves a product release before another product release in the release planner.

Parameters:

releaseToMove - the release to move.

releaseBelow - the release that will appear after the moved release.

Returns:

the moved release.

Throws:

ServerException - if there is an error moving the release or if the releases are not product releases in the same product.

java.rmi.RemoteException

moveReleaseAfter

ReleaseWSO moveReleaseAfter(ReleaseWSO releaseToMove,
                            ReleaseWSO releaseAbove)
                            throws com.danube.scrumworks.exception.ServerException,
                                   java.rmi.RemoteException

Moves a product release after another product release in the release planner.

Parameters:

releaseToMove - the release to move.

releaseAbove - the release which should now be above this release in the release planner.

Returns:

the moved release.

Throws:

ServerException - if there is an error moving the release or if the releases are not product releases in the same product.

java.rmi.RemoteException

moveReleaseBeforeInProduct

void moveReleaseBeforeInProduct(ReleaseWSO releaseToMove,
                                ReleaseWSO releaseBelow,
                                ProductWSO product)
                                throws com.danube.scrumworks.exception.ServerException,
                                       java.rmi.RemoteException

Moves a product or program release before another product or program release within the given product.

Parameters:

releaseToMove - the release to move.

releaseBelow - the release that will appear after the moved release.

product - the product both releases belong to.

Throws:

ServerException - if there is an error moving the release, if the releases are in different products, or if a release's program does not have the given product association.

java.rmi.RemoteException

moveReleaseAfterInProduct

void moveReleaseAfterInProduct(ReleaseWSO releaseToMove,
                               ReleaseWSO releaseAbove,
                               ProductWSO product)
                               throws com.danube.scrumworks.exception.ServerException,
                                      java.rmi.RemoteException

Moves a product or program release after another product or program release within the given the product.

Parameters:

releaseToMove - the release to move.

releaseAbove - the release which should now be above this release.

product - the product both releases belong to.

Throws:

ServerException - if there is an error moving the release, if the releases are in different products, or if a release's program does not have the given product association.

java.rmi.RemoteException

createRelease

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

Creates a new release.

The start date and the release date should be specified or both left empty.

Either a product ID or a program ID (but not both) must be provided.

New release are ranked above all existing releases for that context (product or program). Use moveReleaseAfter(ReleaseWSO, ReleaseWSO) and moveReleaseBefore(ReleaseWSO, ReleaseWSO) to re-rank releases.

Parameters:

release - provides information about the release to create

Returns:

the new release

Throws:

ServerException - if any of:

• the argument is null
• the release ID in release is non-null
• exactly one of product ID or program ID is not specivied
• the "archived" flage is set in release.
• an error occurs creating the release

java.rmi.RemoteException

updateRelease

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

Updates an existing release. The start date and the release date should be specified or left empty together. Releases that have their archived flag set to true cannot be modified.

Parameters:

release - the new data for a release.

Returns:

the updated release

Throws:

ServerException - if there is an error updating the release, the release is archived, or the argument is null.

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.

Parameters:

sprint - the sprint to update

Returns:

the updated sprint

Throws:

ServerException - if the sprint's ID is not specified, or the sprint is invalid

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.

Parameters:

sprint - The sprint to delete

Throws:

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

java.rmi.RemoteException

createImpediment

ImpedimentWSO createImpediment(ImpedimentWSO impedimentWSO,
                               ProductWSO productWSO)
                               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)
                     throws com.danube.scrumworks.exception.ServerException,
                            java.rmi.RemoteException

Creates a new theme.

Parameters:

theme - the theme to create.

Returns:

a new WSO with the ID field set.

Throws:

ServerException - if the theme's ID is already set, the theme doesn't have exactly one of product/program ID set, the argument is null, or there is an error creating the new theme.

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.

Throws:

ServerException - if the theme is null, doesn't have an ID, or doesn't have exactly one parent (product/program ID). Also if there is any error deleting the theme.

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

getActiveBacklogItemsForTheme

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

Gets the active backlog items tagged with the indicated theme.

Parameters:

theme - the theme to list the backlog items for

Returns:

the active backlog items in the given theme

Throws:

ServerException - if an error occurs finding the items, the theme doesn't exist or is inconsistent.

java.rmi.RemoteException

getActiveBacklogItemsForThemeInProduct

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

Gets the active backlog items for a specified theme and product. For product themes, this method will return the same results as getActiveBacklogItemsForTheme(ThemeWSO), as long as the product matches the theme's product. For program themes, the results are restricted to one of the products in the program.

Parameters:

theme - the theme to list the backlog items for

product - the product whose items should be returned.

Returns:

the backlog items in the given theme in the given product.

Throws:

ServerException - if there is an error finding the item or the theme is a product theme but the product doesn't match the product provided.

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

getThemesForProgram

ThemeWSO[] getThemesForProgram(ProgramWSO program)
                               throws com.danube.scrumworks.exception.ServerException,
                                      java.rmi.RemoteException

Finds the themes for a program.

Parameters:

program - the program whose theme's are to found.

Returns:

the program themes defined for the program.

Throws:

ServerException - if the program is null or has a null ID, or there is an error loading the program's themes.

java.rmi.RemoteException

getThemes

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

Deprecated. Replaced by getThemesForProduct(ProductWSO)

Lists all product and program 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

getThemesForProduct

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

Lists all product and program 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

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

Gets statistics about the releases within the given date range for a product.

Parameters:

product - the product

startDate - the beginning date of the date range

endDate - the ending date of the date range

Returns:

The dashboard statistics for the product.

Throws:

ServerException - if an error occurs

java.lang.IllegalArgumentException - if an argument is null.

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

getUncategorizedBudgetsForRelease

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

Lists all uncategorized budgets for the given Program Release, or list the single uncategorized budget for a Product Release. Given a Program Release, this method returns all Uncategorized Budgets for each Product with that Release. Given a Product Release, this method returns the single Uncategorized Budget for that Release.

Parameters:

release - The Product or Program Release to get the budget(s) for.

Returns:

The uncategorized budget(s) for the given release.

Throws:

ServerException - if there is an error loading the budget(s) or if the Release is invalid or null.

java.rmi.RemoteException

getUncategorizedBudgetForReleaseInProduct

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

Gets the uncategorized budget for the given Release within the given Product. If a Product Release is given this method acts the same as calling getUncategorizedBudgetsForRelease(ReleaseWSO).

Parameters:

release - The Product or Program Release to get the budget(s) for.

product - The Product containing the given Product or Program Release.

Returns:

The uncategorized budget for the given release.

Throws:

ServerException - if there is an error loading the budget(s), if the release and product are inconsisteyt, or if an argument is null.

java.rmi.RemoteException