com.telelogic.cs.api
Class TaskDetails

java.lang.Object
  extended by com.telelogic.cs.api.TaskDetails

public class TaskDetails
extends java.lang.Object

Bundles a list of associated tasks with more detailed status and error information. In central server mode the extra information can be used to determine which tasks are missing--this can happen if tasks from some development databases were available, but other databases were offline.


Method Summary
 java.lang.String[] getOfflineDatabases()
          The list of the user's databases that were offline when the associated tasks were looked up.
 java.lang.String[] getOfflineTaskIds()
          A best guess of the tasks that were not returned, but probably should have been.
 Task[] getTasks()
          Gets the found associated tasks.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getTasks

public Task[] getTasks()
Gets the found associated tasks. Tasks can be from multiple databases in central server mode.

Returns:
the associated tasks.

getOfflineTaskIds

public java.lang.String[] getOfflineTaskIds()
A best guess of the tasks that were not returned, but probably should have been. This happens when some databases are offline in central server mode. This is only a heuristic; it is not always accurate. It's possible this may return too many, even deleted, tasks. It should never return too few though.

Returns:
the task IDs that are likely missing from the associated tasks.

getOfflineDatabases

public java.lang.String[] getOfflineDatabases()
The list of the user's databases that were offline when the associated tasks were looked up. There's no way to know which offline tasks come from which offline databases.

Triggers can use the admin token when looking up tasks to ensure all task databases are checked, though this will bypass ACL security--the results should not be shown to normal users.

Returns:
paths to all offline databases when the tasks were looked up. Only the database the user can access.


© Copyright IBM Corporation 2000, 2009
US Government Users Restricted Rights--Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
Notices