Studio:Reporter - Revision history

Timd: Reporter moved to Studio:Reporter

2009-08-18T21:26:53Z

← Older revision	Revision as of 21:26, 18 August 2009
(No difference)

Timd: /* Notes */

2009-06-02T16:51:35Z

Notes

← Older revision		Revision as of 16:51, 2 June 2009
Line 420:		Line 420:
	<references />		<references />

	[[Category: ~~Reference~~]]		[[Category: Studio]]

Mikee: /*
reporter.Suites.Item.Annotations.Item
*/

2008-09-09T22:36:37Z

<br>reporter.Suites.Item.Annotations.Item<br>

← Older revision		Revision as of 22:36, 9 September 2008
Line 257:		Line 257:
	*FATAL		*FATAL
	*ERROR		*ERROR
	*~~WARNING~~		*WARN
	*INFO		*INFO
	*DEBUG		*DEBUG

Stevel at 01:17, 9 July 2008

2008-07-09T01:17:31Z

← Older revision		Revision as of 01:17, 9 July 2008
Line 419:		Line 419:

	<references />		<references />

			[[Category: Reference]]

Mikee at 21:37, 7 July 2008

2008-07-07T21:37:27Z

← Older revision		Revision as of 21:37, 7 July 2008
Line 118:		Line 118:
	\| width="150" valign="top" align="left" \| '''Description '''		\| width="150" valign="top" align="left" \| '''Description '''
	\| valign="top" align="left" \| Property,<br>string		\| valign="top" align="left" \| Property,<br>string
	\| valign="top" align="left" \| Gets/sets the description for the suite. Supports URL markdown <ref name="markdown">These properties support MediaWiki markdown format for urls. Specifically, text of the form [~~PROTO~~://URI] (where proto can be http, https, mailto, or ftp) will be munged so that a link is displayed when viewing in a browser.</ref>.<br>		\| valign="top" align="left" \| Gets/sets the description for the suite. Supports URL markdown <ref name="markdown">These properties support MediaWiki markdown format for urls. Specifically, text of the form <tt>[proto://URI]</tt> (where proto can be http, https, mailto, or ftp) will be munged so that a link is displayed when viewing in a browser.</ref>.<br>
	\|-		\|-
	\| width="150" valign="top" align="left" \| string '''Save '''(<br>    string file [optional]<br>)		\| width="150" valign="top" align="left" \| string '''Save '''(<br>    string file [optional]<br>)

Mikee at 16:39, 2 July 2008

2008-07-02T16:39:55Z

← Older revision		Revision as of 16:39, 2 July 2008
Line 399:		Line 399:
	== <br>reporter.Suites.Item.Tests.Item.Comments.Item<br> ==		== <br>reporter.Suites.Item.Tests.Item.Comments.Item<br> ==

	{\| ~~width="100%"~~ cellspacing="0" cellpadding="10" border="1"		The interface for comment objects.  Comments are simple child objects of tests that provide a means for adding additional information to the test case.  Comments are displayed as child rows for each test case.

			{\| cellspacing="0" cellpadding="10" border="1" width="100%"
	\|-		\|-
	\| ~~width~~="~~150~~" ~~valign~~="~~top~~" ~~bgcolor~~="~~#66ff99~~" ~~align~~="~~left~~" \| '''Member '''		\| bgcolor="#66ff99" align="left" width="150" valign="top" \| '''Member '''
	\| bgcolor="#66ff99" \| '''Type '''		\| bgcolor="#66ff99" \| '''Type '''
	\| bgcolor="#66ff99" \| '''Description '''		\| bgcolor="#66ff99" \| '''Description '''
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Label'''		\| align="left" width="150" valign="top" \| '''Label'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the label for the comment.<br>		\| align="left" valign="top" \| Gets/sets the label for the comment.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Comment'''		\| align="left" width="150" valign="top" \| '''Comment'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the comment text for the comment object. Supports URL markdown<ref name="markdown"/>.<br>		\| align="left" valign="top" \| Gets/sets the comment text for the comment object. Supports URL markdown<ref name="markdown" />.<br>
	\|}		\|}

Mikee at 16:38, 2 July 2008

2008-07-02T16:38:30Z

← Older revision		Revision as of 16:38, 2 July 2008
Line 368:		Line 368:
	== <br>reporter.Suites.Item.Tests.Item.Comments<br> ==		== <br>reporter.Suites.Item.Tests.Item.Comments<br> ==

	{\| ~~width="100%"~~ cellspacing="0" cellpadding="10" border="1"		The interface for a collection of comments. This collection does NOT require uniquely labeled items (multiple items can have the same label). Because of this, items in the collection can only be accessed by numerical index.<br>

			{\| cellspacing="0" cellpadding="10" border="1" width="100%"
	\|-		\|-
	\| ~~width~~="~~150~~" ~~valign~~="~~top~~" ~~bgcolor~~="~~#66ff99~~" ~~align~~="~~left~~" \| '''Member '''		\| bgcolor="#66ff99" align="left" width="150" valign="top" \| '''Member '''
	\| bgcolor="#66ff99" \| '''Type '''		\| bgcolor="#66ff99" \| '''Type '''
	\| bgcolor="#66ff99" \| '''Description '''		\| bgcolor="#66ff99" \| '''Description '''
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Item '''(<br>    integer index<br>)<br>		\| align="left" width="150" valign="top" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Item '''(<br>    integer index<br>)<br>
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Returns the specified comment object. Since this collection does not enforce name uniqueness, the index can be integer only. An exception will be thrown if the requested index is out of range.		\| align="left" valign="top" \| Returns the specified comment object. Since this collection does not enforce name uniqueness, the index can be integer only. An exception will be thrown if the requested index is out of range.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Count'''		\| align="left" width="150" valign="top" \| '''Count'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Read only property that returns the number of comments in the collection.		\| align="left" valign="top" \| Read only property that returns the number of comments in the collection.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Add '''(<br>    string label<br>)<br>		\| align="left" width="150" valign="top" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Add '''(<br>    string label<br>)<br>
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Creates a new comment in the collection. A label may be provided, but will default to Comment_# where # is chosen as 1 greater than the current Count of the collection. Returns the new object.		\| align="left" valign="top" \| Creates a new comment in the collection. A label may be provided, but will default to Comment_# where # is chosen as 1 greater than the current Count of the collection. Returns the new object.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Remove '''(<br>    integer index<br>)<br>		\| align="left" width="150" valign="top" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Remove '''(<br>    integer index<br>)<br>
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Removes a comment from the collection and returns a reference to the removed obejct. The index can be integer only. If a provided integer index is out of range, an exception is thrown.		\| align="left" valign="top" \| Removes a comment from the collection and returns a reference to the removed obejct. The index can be integer only. If a provided integer index is out of range, an exception is thrown.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''RemoveAll '''()<br>		\| align="left" width="150" valign="top" \| '''RemoveAll '''()<br>
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Empties the collection		\| align="left" valign="top" \| Empties the collection
	\|}		\|}

Mikee at 16:36, 2 July 2008

2008-07-02T16:36:42Z

← Older revision		Revision as of 16:36, 2 July 2008
Line 317:		Line 317:
	== <br>reporter.Suites.Item.Tests.Item<br> ==		== <br>reporter.Suites.Item.Tests.Item<br> ==

	The interface for test objects.  Tests comprise a name, a description, a duration, and a status.		The interface for test objects.  Tests comprise a name, a description, a duration, and a status. Tests can also have an optional metric value associated with them (and corresponding label) as well as one or more [[#reporter.Suites.Item.Tests.Item.Comments\|comments]].<br>

	{\| cellspacing="0" cellpadding="10" border="1" width="100%"		{\| cellspacing="0" cellpadding="10" border="1" width="100%"

Mikee at 16:35, 2 July 2008

2008-07-02T16:35:05Z

← Older revision		Revision as of 16:35, 2 July 2008
Line 6:		Line 6:

	*A [[#reporter.Suites.Item\|suite]] is a collection of [[#reporter.Suites.Item.Tests.Item\|tests]] and other suites. A suite has a name, a description and children suites and tests. Suites can also be populated with additional information in the form of [[#reporter.Suites.Item.Annotations\|annotations]] and can have additional summary fields added via [[#reporter.Suites.Item.CustomData\|custom data]].		*A [[#reporter.Suites.Item\|suite]] is a collection of [[#reporter.Suites.Item.Tests.Item\|tests]] and other suites. A suite has a name, a description and children suites and tests. Suites can also be populated with additional information in the form of [[#reporter.Suites.Item.Annotations\|annotations]] and can have additional summary fields added via [[#reporter.Suites.Item.CustomData\|custom data]].
	*A [[#reporter.Suites.Item.Tests.Item\|test]] represents a single pass/fail item and it consists of a name, a description, a duration~~, any test data that is added during the lifetime of the test~~, and a status. Tests can be populated with additional details using [[#reporter.Suites.Item.Tests.Item.Comments\|comments]].		*A [[#reporter.Suites.Item.Tests.Item\|test]] represents a single pass/fail item and it consists of a name, a description, a duration, and a status. Tests can be populated with additional details using [[#reporter.Suites.Item.Tests.Item.Comments\|comments]].

	= Automation API<br> =		= Automation API<br> =

Mikee at 16:34, 2 July 2008

2008-07-02T16:34:04Z

← Older revision		Revision as of 16:34, 2 July 2008
Line 317:		Line 317:
	== <br>reporter.Suites.Item.Tests.Item<br> ==		== <br>reporter.Suites.Item.Tests.Item<br> ==

	{\| ~~width="100%"~~ cellspacing="0" cellpadding="10" border="1"		The interface for test objects.  Tests comprise a name, a description, a duration, and a status.

			{\| cellspacing="0" cellpadding="10" border="1" width="100%"
	\|-		\|-
	\| ~~width~~="~~150~~" ~~valign~~="~~top~~" ~~bgcolor~~="~~#66ff99~~" ~~align~~="~~left~~" \| '''Member '''		\| bgcolor="#66ff99" align="left" width="150" valign="top" \| '''Member '''
	\| bgcolor="#66ff99" \| '''Type '''		\| bgcolor="#66ff99" \| '''Type '''
	\| bgcolor="#66ff99" \| '''Description '''		\| bgcolor="#66ff99" \| '''Description '''
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| [[#reporter.Suites.Item.Tests.Item.Comments\|Comments]]		\| align="left" width="150" valign="top" \| [[#reporter.Suites.Item.Tests.Item.Comments\|Comments]]
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Object		\| align="left" valign="top" \| Object
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Collection of comments for this test.<br>		\| align="left" valign="top" \| Collection of comments for this test.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Name'''		\| align="left" width="150" valign="top" \| '''Name'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the name of the test. When setting the name, if another item already exists in the collection with the same name, an exception will be thrown.<br>		\| align="left" valign="top" \| Gets/sets the name of the test. When setting the name, if another item already exists in the collection with the same name, an exception will be thrown.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Description'''		\| align="left" width="150" valign="top" \| '''Description'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the test's description. Supports URL markdown<ref name="markdown" />.		\| align="left" valign="top" \| Gets/sets the test's description. Supports URL markdown<ref name="markdown" />.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Status'''		\| align="left" width="150" valign="top" \| '''Status'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the status of the annotation. This property can assigned one of the following:		\| align="left" valign="top" \| Gets/sets the status of the annotation. This property can assigned one of the following:
	*the string values (case insensitive) "PASS"<ref>"TRUE" is supported as a synonym for "PASS"</ref>, "FAIL"<ref>"FALSE" is supported as a synonym for "FAIL"</ref>, "IN PROGRESS", or "N/A"<ref>"NOT APPLICABLE" and "NOT IN USE" are also supported as synonyms for "N/A"</ref>		*the string values (case insensitive) "PASS"<ref>"TRUE" is supported as a synonym for "PASS"</ref>, "FAIL"<ref>"FALSE" is supported as a synonym for "FAIL"</ref>, "IN PROGRESS", or "N/A"<ref>"NOT APPLICABLE" and "NOT IN USE" are also supported as synonyms for "N/A"</ref>
	*a boolean value of true or false		*a boolean value of true or false
Line 343:		Line 345:

	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Parent'''		\| align="left" width="150" valign="top" \| '''Parent'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Object		\| align="left" valign="top" \| Object
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Returns the parent suite object for this test.<br>		\| align="left" valign="top" \| Returns the parent suite object for this test.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Path'''		\| align="left" width="150" valign="top" \| '''Path'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string,<br>read-only		\| align="left" valign="top" \| Property,<br>string,<br>read-only
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Read-only property that returns the full path of the test, with each ancestor suite separated by a forward slash (/).		\| align="left" valign="top" \| Read-only property that returns the full path of the test, with each ancestor suite separated by a forward slash (/).
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Duration'''		\| align="left" width="150" valign="top" \| '''Duration'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>double		\| align="left" valign="top" \| Property,<br>double
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the duration of the test in milliseconds.  If this value is not explicitly set by the user, it will default to the elapsed time from creation to the last time the Status value was updated.<br>		\| align="left" valign="top" \| Gets/sets the duration of the test in milliseconds.  If this value is not explicitly set by the user, it will default to the elapsed time from creation to the last time the Status value was updated.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Metric'''		\| align="left" width="150" valign="top" \| '''Metric'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>double		\| align="left" valign="top" \| Property,<br>double
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the secondary metric value for the test.  This value is a generic floating point value that can be associated with the test, but it has no inherent units.  An implied units label can be set using the MetricUnits property.<br>		\| align="left" valign="top" \| Gets/sets the secondary metric value for the test.  This value is a generic floating point value that can be associated with the test, but it has no inherent units.  An implied units label can be set using the MetricUnits property.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''MetricUnits'''		\| align="left" width="150" valign="top" \| '''MetricUnits'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the secondary metric value label.  This value is for report display only and does not affect the actual values stored in Metric, if any.<br>		\| align="left" valign="top" \| Gets/sets the secondary metric value label.  This value is for report display only and does not affect the actual values stored in Metric, if any.<br>
	\|}		\|}

← Older revision		Revision as of 21:37, 7 July 2008
Line 118:		Line 118:
	\| width="150" valign="top" align="left" \| '''Description '''		\| width="150" valign="top" align="left" \| '''Description '''
	\| valign="top" align="left" \| Property,<br>string		\| valign="top" align="left" \| Property,<br>string
	\| valign="top" align="left" \| Gets/sets the description for the suite. Supports URL markdown <ref name="markdown">These properties support MediaWiki markdown format for urls. Specifically, text of the form [~~PROTO~~://URI] (where proto can be http, https, mailto, or ftp) will be munged so that a link is displayed when viewing in a browser.</ref>.<br>		\| valign="top" align="left" \| Gets/sets the description for the suite. Supports URL markdown <ref name="markdown">These properties support MediaWiki markdown format for urls. Specifically, text of the form <tt>[proto://URI]</tt> (where proto can be http, https, mailto, or ftp) will be munged so that a link is displayed when viewing in a browser.</ref>.<br>
	\|-		\|-
	\| width="150" valign="top" align="left" \| string '''Save '''(<br>    string file [optional]<br>)		\| width="150" valign="top" align="left" \| string '''Save '''(<br>    string file [optional]<br>)

← Older revision		Revision as of 16:39, 2 July 2008
Line 399:		Line 399:
	== <br>reporter.Suites.Item.Tests.Item.Comments.Item<br> ==		== <br>reporter.Suites.Item.Tests.Item.Comments.Item<br> ==

	{\| ~~width="100%"~~ cellspacing="0" cellpadding="10" border="1"		The interface for comment objects.  Comments are simple child objects of tests that provide a means for adding additional information to the test case.  Comments are displayed as child rows for each test case.

			{\| cellspacing="0" cellpadding="10" border="1" width="100%"
	\|-		\|-
	\| ~~width~~="~~150~~" ~~valign~~="~~top~~" ~~bgcolor~~="~~#66ff99~~" ~~align~~="~~left~~" \| '''Member '''		\| bgcolor="#66ff99" align="left" width="150" valign="top" \| '''Member '''
	\| bgcolor="#66ff99" \| '''Type '''		\| bgcolor="#66ff99" \| '''Type '''
	\| bgcolor="#66ff99" \| '''Description '''		\| bgcolor="#66ff99" \| '''Description '''
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Label'''		\| align="left" width="150" valign="top" \| '''Label'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the label for the comment.<br>		\| align="left" valign="top" \| Gets/sets the label for the comment.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Comment'''		\| align="left" width="150" valign="top" \| '''Comment'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the comment text for the comment object. Supports URL markdown<ref name="markdown"/>.<br>		\| align="left" valign="top" \| Gets/sets the comment text for the comment object. Supports URL markdown<ref name="markdown" />.<br>
	\|}		\|}

← Older revision		Revision as of 16:38, 2 July 2008
Line 368:		Line 368:
	== <br>reporter.Suites.Item.Tests.Item.Comments<br> ==		== <br>reporter.Suites.Item.Tests.Item.Comments<br> ==

	{\| ~~width="100%"~~ cellspacing="0" cellpadding="10" border="1"		The interface for a collection of comments. This collection does NOT require uniquely labeled items (multiple items can have the same label). Because of this, items in the collection can only be accessed by numerical index.<br>

			{\| cellspacing="0" cellpadding="10" border="1" width="100%"
	\|-		\|-
	\| ~~width~~="~~150~~" ~~valign~~="~~top~~" ~~bgcolor~~="~~#66ff99~~" ~~align~~="~~left~~" \| '''Member '''		\| bgcolor="#66ff99" align="left" width="150" valign="top" \| '''Member '''
	\| bgcolor="#66ff99" \| '''Type '''		\| bgcolor="#66ff99" \| '''Type '''
	\| bgcolor="#66ff99" \| '''Description '''		\| bgcolor="#66ff99" \| '''Description '''
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Item '''(<br>    integer index<br>)<br>		\| align="left" width="150" valign="top" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Item '''(<br>    integer index<br>)<br>
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Returns the specified comment object. Since this collection does not enforce name uniqueness, the index can be integer only. An exception will be thrown if the requested index is out of range.		\| align="left" valign="top" \| Returns the specified comment object. Since this collection does not enforce name uniqueness, the index can be integer only. An exception will be thrown if the requested index is out of range.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Count'''		\| align="left" width="150" valign="top" \| '''Count'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Read only property that returns the number of comments in the collection.		\| align="left" valign="top" \| Read only property that returns the number of comments in the collection.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Add '''(<br>    string label<br>)<br>		\| align="left" width="150" valign="top" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Add '''(<br>    string label<br>)<br>
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Creates a new comment in the collection. A label may be provided, but will default to Comment_# where # is chosen as 1 greater than the current Count of the collection. Returns the new object.		\| align="left" valign="top" \| Creates a new comment in the collection. A label may be provided, but will default to Comment_# where # is chosen as 1 greater than the current Count of the collection. Returns the new object.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Remove '''(<br>    integer index<br>)<br>		\| align="left" width="150" valign="top" \| [[#reporter.Suites.Item.Tests.Item.Comments.Item\|object]] '''Remove '''(<br>    integer index<br>)<br>
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Removes a comment from the collection and returns a reference to the removed obejct. The index can be integer only. If a provided integer index is out of range, an exception is thrown.		\| align="left" valign="top" \| Removes a comment from the collection and returns a reference to the removed obejct. The index can be integer only. If a provided integer index is out of range, an exception is thrown.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''RemoveAll '''()<br>		\| align="left" width="150" valign="top" \| '''RemoveAll '''()<br>
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Method		\| align="left" valign="top" \| Method
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Empties the collection		\| align="left" valign="top" \| Empties the collection
	\|}		\|}

← Older revision		Revision as of 16:34, 2 July 2008
Line 317:		Line 317:
	== <br>reporter.Suites.Item.Tests.Item<br> ==		== <br>reporter.Suites.Item.Tests.Item<br> ==

	{\| ~~width="100%"~~ cellspacing="0" cellpadding="10" border="1"		The interface for test objects.  Tests comprise a name, a description, a duration, and a status.

			{\| cellspacing="0" cellpadding="10" border="1" width="100%"
	\|-		\|-
	\| ~~width~~="~~150~~" ~~valign~~="~~top~~" ~~bgcolor~~="~~#66ff99~~" ~~align~~="~~left~~" \| '''Member '''		\| bgcolor="#66ff99" align="left" width="150" valign="top" \| '''Member '''
	\| bgcolor="#66ff99" \| '''Type '''		\| bgcolor="#66ff99" \| '''Type '''
	\| bgcolor="#66ff99" \| '''Description '''		\| bgcolor="#66ff99" \| '''Description '''
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| [[#reporter.Suites.Item.Tests.Item.Comments\|Comments]]		\| align="left" width="150" valign="top" \| [[#reporter.Suites.Item.Tests.Item.Comments\|Comments]]
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Object		\| align="left" valign="top" \| Object
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Collection of comments for this test.<br>		\| align="left" valign="top" \| Collection of comments for this test.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Name'''		\| align="left" width="150" valign="top" \| '''Name'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the name of the test. When setting the name, if another item already exists in the collection with the same name, an exception will be thrown.<br>		\| align="left" valign="top" \| Gets/sets the name of the test. When setting the name, if another item already exists in the collection with the same name, an exception will be thrown.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Description'''		\| align="left" width="150" valign="top" \| '''Description'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the test's description. Supports URL markdown<ref name="markdown" />.		\| align="left" valign="top" \| Gets/sets the test's description. Supports URL markdown<ref name="markdown" />.
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Status'''		\| align="left" width="150" valign="top" \| '''Status'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the status of the annotation. This property can assigned one of the following:		\| align="left" valign="top" \| Gets/sets the status of the annotation. This property can assigned one of the following:
	*the string values (case insensitive) "PASS"<ref>"TRUE" is supported as a synonym for "PASS"</ref>, "FAIL"<ref>"FALSE" is supported as a synonym for "FAIL"</ref>, "IN PROGRESS", or "N/A"<ref>"NOT APPLICABLE" and "NOT IN USE" are also supported as synonyms for "N/A"</ref>		*the string values (case insensitive) "PASS"<ref>"TRUE" is supported as a synonym for "PASS"</ref>, "FAIL"<ref>"FALSE" is supported as a synonym for "FAIL"</ref>, "IN PROGRESS", or "N/A"<ref>"NOT APPLICABLE" and "NOT IN USE" are also supported as synonyms for "N/A"</ref>
	*a boolean value of true or false		*a boolean value of true or false
Line 343:		Line 345:

	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Parent'''		\| align="left" width="150" valign="top" \| '''Parent'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Object		\| align="left" valign="top" \| Object
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Returns the parent suite object for this test.<br>		\| align="left" valign="top" \| Returns the parent suite object for this test.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Path'''		\| align="left" width="150" valign="top" \| '''Path'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string,<br>read-only		\| align="left" valign="top" \| Property,<br>string,<br>read-only
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Read-only property that returns the full path of the test, with each ancestor suite separated by a forward slash (/).		\| align="left" valign="top" \| Read-only property that returns the full path of the test, with each ancestor suite separated by a forward slash (/).
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Duration'''		\| align="left" width="150" valign="top" \| '''Duration'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>double		\| align="left" valign="top" \| Property,<br>double
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the duration of the test in milliseconds.  If this value is not explicitly set by the user, it will default to the elapsed time from creation to the last time the Status value was updated.<br>		\| align="left" valign="top" \| Gets/sets the duration of the test in milliseconds.  If this value is not explicitly set by the user, it will default to the elapsed time from creation to the last time the Status value was updated.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''Metric'''		\| align="left" width="150" valign="top" \| '''Metric'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>double		\| align="left" valign="top" \| Property,<br>double
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the secondary metric value for the test.  This value is a generic floating point value that can be associated with the test, but it has no inherent units.  An implied units label can be set using the MetricUnits property.<br>		\| align="left" valign="top" \| Gets/sets the secondary metric value for the test.  This value is a generic floating point value that can be associated with the test, but it has no inherent units.  An implied units label can be set using the MetricUnits property.<br>
	\|-		\|-
	\| width="150" valign="top~~" align="left~~" \| '''MetricUnits'''		\| align="left" width="150" valign="top" \| '''MetricUnits'''
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Property,<br>string		\| align="left" valign="top" \| Property,<br>string
	\| ~~valign~~="~~top~~" ~~align~~="~~left~~" \| Gets/sets the secondary metric value label.  This value is for report display only and does not affect the actual values stored in Metric, if any.<br>		\| align="left" valign="top" \| Gets/sets the secondary metric value label.  This value is for report display only and does not affect the actual values stored in Metric, if any.<br>
	\|}		\|}