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

Interface RMPluginProfile

public interface RMPluginProfile

The RMPluginProfile interface is the tagging interface for a requirement plug-in for Silk Central. Plug-ins, which implement this interface, are used for integration with external RMS and this interface provides the methods for a proper configuration and access to the external RMS.

Method Summary

Modifier and Type	Method and Description
RMDataProvider	getDataProvider() Returns a RMDataProvider instance.
RMIconProvider	getIconProvider() Returns a RMIconProvider instance.
PropertyProvider	getPropertyProvider() Returns a property provider, which returns all required properties the plug-in requires to log on to the external RMS.
java.lang.String	getRMSName() Returns the name for this Requirement Management System plug-in.
StringResolver	getStringResolver() Returns a StringResolver to get the localized labels that should be shown for the properties.
RMTestProvider	getTestProvider() Returns a RMTestProvider instance.
void	setProperty(java.lang.String name, java.lang.String value) Sets the values to the profile implementation for the properties, which are provided by the PropertyProvider returned by getPropertyProvider(), so that the profile can successfully call validate() and provide proper RMDataProvider, RMIconProvider and RMTestProvider instances.
void	validate() Tests if the values provided so far to the profile for the properties are enough and correct for a successful login to the external RMS.

Method Detail

getRMSName

java.lang.String getRMSName()

Returns the name for this Requirement Management System plug-in. This name will be displayed in Silk Central for integration with this plug-in

Returns:

the name of the Requirement Management System this integration supports.

getPropertyProvider

PropertyProvider getPropertyProvider()

Returns a property provider, which returns all required properties the plug-in requires to log on to the external RMS.

Returns:

a property provider, which provides the required configuration properties..

getStringResolver

StringResolver getStringResolver()

Returns a StringResolver to get the localized labels that should be shown for the properties.

Returns:

a string resolver, which resolves the property names

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)

Sets the values to the profile implementation for the properties, which are provided by the PropertyProvider returned by getPropertyProvider(), so that the profile can successfully call validate() and provide proper RMDataProvider, RMIconProvider and RMTestProvider instances.

Parameters:

name - the name of a property

value - the corresponding value for the property name

validate

void validate()
       throws RMPluginException

Tests if the values provided so far to the profile for the properties are enough and correct for a successful login to the external RMS.

Throws:

RMPluginException

getDataProvider

RMDataProvider getDataProvider()
                        throws RMPluginException

Returns a RMDataProvider instance. A valid instance will only be returned if enough and correct values for the login properties have be provided before to the profile.

Returns:

a RMDataProvider instance.

Throws:

RMPluginException

getIconProvider

RMIconProvider getIconProvider()
                        throws RMPluginException

Returns a RMIconProvider instance. If the plug-in implementation does not support the RMIconProvider interface, then null has to be return for this call. A valid instance will only be returned if enough and correct values for the login properties have been provided before to the profile.

Returns:

a RMIconProvider instance.

Throws:

RMPluginException

getTestProvider

RMTestProvider getTestProvider()
                        throws RMPluginException

Returns a RMTestProvider instance. If the plug-in implementation does not support the RMTestProvider interface, then null has to be return for this call. A valid instance will only be returned if enough and correct values for the login properties have been provided before to the profile.

Returns:

a RMTestProvider instance.

Throws:

RMPluginException