com.segue.tm.published.api.requirements.javaplugin

Interface RMDataProvider

public interface RMDataProvider

The RMDataProvider interface provides information and usage methods of the external Requirement Management System. It provides name and version of the external RMS and access to projects and requirements.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionURL(java.lang.String nodeURI, RMAction action) Returns the URL for an action on a specific node.
java.util.List<RMAction>	getAllActions() Returns all different actions possible on any node.
java.util.List<RMNode>	getChangedNodes(java.lang.String projectId, long timestamp, int index, int limit) Returns all changed nodes since a specific time stamp.
java.util.Map<java.lang.String,java.util.List<RMNode>>	getChildren(java.lang.String projectId, java.util.List<java.lang.String> parentIds) Returns all children of a node.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getChildrenIds(java.lang.String projectId, java.util.List<java.lang.String> parentIds) Returns all ids of the children for a list of nodes.
java.lang.String	getDefaultOpenURL(java.lang.String nodeURI) Returns the URL for the default open action on a node.
java.util.List<java.lang.String>	getDeletedNodeIds(java.lang.String projectId, long timestamp) Returns all ids of deleted nodes since provided time stamp.
long	getLastChangedTimestamp(java.lang.String projectId) Returns the time stamp of the last change for a specific project.
RMNode	getNodeById(java.lang.String projectId, java.lang.String id) Returns a node specific node.
RMNodeType	getNodeType(java.lang.String typeId) Returns the RMNodeType object for a provided node type id.
RMProject	getProject(java.lang.String id) Returns a specific project.
java.util.List<RMProject>	getProjects() Returns all projects available for integration with SCTM.
java.lang.String	getRMSystemName() Returns the name of the Requirements Management System this plug-in is for.
java.lang.String	getRMSystemVersion() Returns the version of the Requirements Management System this plug-in is for.
RMSnapshot	getSnapshot(java.lang.String projectId, java.lang.String nodeId) Returns the snapshot for a node.
java.util.List<RMAction>	getSupportedActions(RMNodeType nodeType) Returns all supported actions for a specific node type.
boolean	isSnapshotSupported(RMNodeType nodeType) Tells if a snapshot image is supported for a specific node type.

Method Detail

getRMSystemName

java.lang.String getRMSystemName()
                          throws RMPluginException

Returns the name of the Requirements Management System this plug-in is for. This name is displayed in SCTM once a project is configured for this plug-in and is logged in the synchronization log too.

Returns:

the name of RMS.

Throws:

RMPluginException

getRMSystemVersion

java.lang.String getRMSystemVersion()
                             throws RMPluginException

Returns the version of the Requirements Management System this plug-in is for. This version is displayed in SCTM once a project is configured for this plug-in and is logged in the synchronization log too.

Returns:

the version of RMS.

Throws:

RMPluginException

getProjects

java.util.List<RMProject> getProjects()
                               throws RMPluginException

Returns all projects available for integration with SCTM.

Returns:

a list of all projects available for integration with SCTM.

Throws:

RMPluginException

getProject

RMProject getProject(java.lang.String id)
              throws RMPluginException

Returns a specific project.

Parameters:

id - the id of the project to get.

Returns:

the project for the provided id.

Throws:

RMPluginException

getChildrenIds

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getChildrenIds(java.lang.String projectId,
                                                                                java.util.List<java.lang.String> parentIds)
                                                                         throws RMPluginException

Returns all ids of the children for a list of nodes.

Parameters:

projectId - the id of the project.

parentIds - the ids of the nodes of which all children will be returned. If list is empty, then all top level children are returned with empty string as key.

Returns:

the map of node ids and a list of all children ids for these nodes.

Throws:

RMPluginException

getChildren

java.util.Map<java.lang.String,java.util.List<RMNode>> getChildren(java.lang.String projectId,
                                                                   java.util.List<java.lang.String> parentIds)
                                                            throws RMPluginException

Returns all children of a node.

Parameters:

projectId - the id of the project.

parentIds - the ids of the node of which all children will be returned. If list is empty, then all top level children are returned with empty string as key.

Returns:

the map of node ids and a list of all children for these nodes.

Throws:

RMPluginException

getNodeById

RMNode getNodeById(java.lang.String projectId,
                   java.lang.String id)
            throws RMPluginException

Returns a node specific node.

Parameters:

projectId - the id of the project.

id - the id of the node to get.

Returns:

the node for provided id.

Throws:

RMPluginException

getChangedNodes

java.util.List<RMNode> getChangedNodes(java.lang.String projectId,
                                       long timestamp,
                                       int index,
                                       int limit)
                                throws RMPluginException

Returns all changed nodes since a specific time stamp. As such a call could return a lot of nodes at once a starting index and a limit of nodes returned by the call are used to get all such changed nodes with successive calls and increasing the index by limit with each call.

Parameters:

projectId - the id of the project.

timestamp - the time stamp (milliseconds) since when changed nodes should be returned.

index - the starting position (zero based) for returning nodes in the list of all changed nodes.

limit - the maximal number of nodes to return.

Returns:

the array of nodes that have changed since provided time stamp.

Throws:

RMPluginException

getDeletedNodeIds

java.util.List<java.lang.String> getDeletedNodeIds(java.lang.String projectId,
                                                   long timestamp)
                                            throws RMPluginException

Returns all ids of deleted nodes since provided time stamp.

Parameters:

projectId - the id of the project.

timestamp - the time stamp (milliseconds) since when ids of deleted nodes should be returned.

Returns:

the list of ids that have been deleted since provided time stamp.

Throws:

RMPluginException

getLastChangedTimestamp

long getLastChangedTimestamp(java.lang.String projectId)
                      throws RMPluginException

Returns the time stamp of the last change for a specific project.

Parameters:

projectId - the id of the project.

Returns:

the time stamp, when the last change has happened within the provided project.

Throws:

RMPluginException

getSupportedActions

java.util.List<RMAction> getSupportedActions(RMNodeType nodeType)
                                      throws RMPluginException

Returns all supported actions for a specific node type. For every action a context menu entry will be created in SCTM on such a node and the getActionURL() will be called to get the URL, which will be open on executing the action.

Parameters:

nodeType - the node type for which supported actions are returned.

Returns:

the list of supported actions.

Throws:

RMPluginException

getAllActions

java.util.List<RMAction> getAllActions()
                                throws RMPluginException

Returns all different actions possible on any node.

Returns:

the list of all possible actions.

Throws:

RMPluginException

getActionURL

java.lang.String getActionURL(java.lang.String nodeURI,
                              RMAction action)
                       throws RMPluginException

Returns the URL for an action on a specific node. This URL will be opened for provided action on a specific node via context menu in SCTM.

Parameters:

nodeURI - the URI of a node (RMNode).

action - the action which should be performed for the provided node

Returns:

URL the URL, which opens the external tool in the context of the node and action is performed on it

Throws:

RMPluginException

getDefaultOpenURL

java.lang.String getDefaultOpenURL(java.lang.String nodeURI)
                            throws RMPluginException

Returns the URL for the default open action on a node. This URL will be opened on clicking the corresponding button on the properties page of a node in SCTM.

Parameters:

nodeURI - the URI of a node (RMNode).

Returns:

URL the URL, which opens the external tool in the context of the node.

Throws:

RMPluginException

getNodeType

RMNodeType getNodeType(java.lang.String typeId)
                throws java.lang.IllegalArgumentException

Returns the RMNodeType object for a provided node type id. If the id is invalid an IllegalArgumentException has to be thrown.

Parameters:

typeId - the id of the node type.

Returns:

RMNodeType the node type for the provided node type id.

Throws:

java.lang.IllegalArgumentException

isSnapshotSupported

boolean isSnapshotSupported(RMNodeType nodeType)

Tells if a snapshot image is supported for a specific node type.

Parameters:

nodeType - the node type.

Returns:

true if a snapshot is supported for the provided node type; false otherwise.

getSnapshot

RMSnapshot getSnapshot(java.lang.String projectId,
                       java.lang.String nodeId)
                throws RMPluginException

Returns the snapshot for a node.

Parameters:

projectId - the id of a project

nodeId - the id of a node

Returns:

RMSnapshot the snapshot for this node.

Throws:

RMPluginException