Product Class Reference

Collaboration diagram for Product:

Collaboration graph
[legend]

List of all members.


Detailed Description

Encapsulation of a product in Bugzilla.

Currently there are no public constructors. You should get a Product object from Server.GetProduct or Server.GetProducts.

Definition at line 45 of file Product.cs.


Public Member Functions

string[] GetLegalFieldValues (string fieldName)
 Get list of legal values for a bug field.
string[] GetComponents ()
 Get a list of the components of this product.
Bug CreateBug (string alias, string component, string version, string operatingSystem, string platform, string summary, string description, string priority, string severity, string status, string targetMilestone, string assignedTo, string[] cc, string qaContact)
 Create a new bug on this product.
Bug CreateBug (string component, string version, string operatingSystem, string platform, string summary, string description, string priority, string severity)
 Create a new bug on this product.
Bug CreateBug (string alias, string component, string version, string operatingSystem, string platform, string summary, string description, string priority, string severity)
 Create a new bug on this product.
Bug CreateBug (string alias, string component, string version, string operatingSystem, string platform, string summary, string description, string priority, string severity, string status)
 Create a new bug on this product.
Bug CreateBug (string alias, string component, string version, string operatingSystem, string platform, string summary, string description, string priority, string severity, string status, string targetMilestone)
 Create a new bug on this product.
Bug CreateBug (string alias, string component, string version, string operatingSystem, string platform, string summary, string description, string priority, string severity, string status, string targetMilestone, string assignedTo)
 Create a new bug on this product.
Bug CreateBug (string alias, string component, string version, string operatingSystem, string platform, string summary, string description, string priority, string severity, string status, string targetMilestone, string assignedTo, string[] cc)
 Create a new bug on this product.

Properties

int Id [get]
 Get the ID of the product.
string Name [get]
 Get the name of the product.
string Description [get]
 Get the description of the product.

Member Function Documentation

string [] GetLegalFieldValues ( string  fieldName  )  [inline]

Get list of legal values for a bug field.

Parameters:
fieldName The name of a field.
This can be used to retrieve a list of legal values for both product specific fields, as well as non-product specific fields of a bug, such as status, severity, component, and so on. When applicable, you should prefer using one of Server.OperatingSystem, Server.AssignedTo, Server.QaContact or Server.TargetMilestone. For other fields, including your own custom fields, you may use the Bugzilla original naming (such as op_sys).
Returns:
A list of legal values for the field

Definition at line 107 of file Product.cs.

References Server::GetLegalFieldValues(), and Product::Id.

Referenced by Product::GetComponents().

string [] GetComponents (  )  [inline]

Get a list of the components of this product.

This just calls GetLegalFieldValues(string) with "component" as parameter value.

Returns:
A list of the components of the product.

Definition at line 115 of file Product.cs.

References Product::GetLegalFieldValues().

Bug CreateBug ( string  alias,
string  component,
string  version,
string  operatingSystem,
string  platform,
string  summary,
string  description,
string  priority,
string  severity,
string  status,
string  targetMilestone,
string  assignedTo,
string[]  cc,
string  qaContact 
) [inline]

Create a new bug on this product.

The parameters for this call can be marked "optional" or "defaulted". Optional parameters can be left out in all Bugzilla installations (i.e. receive null), and a default value from the server will be substituted. Defaulted parameters can be left out of some installations, while other installations may require these parameters to be present. This is decided in the Bugzilla preferences. If you wish to make sure that the call works with all Bugzilla installations, you should supply values for all "defaulted" parameters. Use GetLegalFieldValues to get a list of the legal values for a given field. Parameters not marked optional or defaulted are required.

It is recommended that you use GetLegalFieldValues to retrieve legal values for parameters such as component , version , operatingSystem, and other parameters that have pre-configured values on the server.

Parameters:
alias (Optional) If aliases are enabled for the Bugzilla server, you can supply an unique identifier (no spaces or weird characters) to identify the bug with, in addition to the id.
component The name of the component that the bug will be created under.
version The version of the product, that the bug was found in.
operatingSystem (Defaulted) The operating system the bug was discovered on.
platform (Defaulted) What type of hardware the bug was experienced on.
summary Summary of the bug.
description (Defaulted) Description of the bug.
priority (Defaulted) What order the bug will be fixed in by the developer, compared to the developer's other bugs.
severity (Defaulted) How severe the bug is.
status (Optional) The status that this bug should start out as. Note that only certain statuses can be set on bug creation.
targetMilestone (Optional) A valid target milestone for this product.
assignedTo (Optional) A user to assign this bug to, if you don't want it to be assigned to the component owner.
cc (Optional) An array of usernames to CC on this bug.
qaContact (Optional) If this installation has QA Contacts enabled, you can set the QA Contact here if you don't want to use the components default QA Contact.
Returns:
The newly created bug.

Definition at line 176 of file Product.cs.

References CreateBugParam::alias, CreateBugParam::assignedTo, CreateBugParam::cc, CreateBugParam::component, IProxy::CreateBug(), CreateBugParam::description, Server::GetBug(), CreateBugResult::id, ProductInfo::name, CreateBugParam::operatingSystem, CreateBugParam::platform, CreateBugParam::priority, CreateBugParam::product, Server::Proxy, CreateBugParam::qaContact, CreateBugParam::severity, CreateBugParam::status, CreateBugParam::summary, CreateBugParam::targetMilestone, and CreateBugParam::version.

Referenced by Product::CreateBug().

Bug CreateBug ( string  component,
string  version,
string  operatingSystem,
string  platform,
string  summary,
string  description,
string  priority,
string  severity 
) [inline]

Create a new bug on this product.

Parameters:
component The name of the component that the bug will be created under.
version The version of the product, that the bug was found in.
operatingSystem (Defaulted) The operating system the bug was discovered on.
platform (Defaulted) What type of hardware the bug was experienced on.
summary Summary of the bug.
description (Defaulted) Description of the bug.
priority (Defaulted) What order the bug will be fixed in by the developer, compared to the developer's other bugs.
severity (Defaulted) How severe the bug is.
Returns:
The newly created bug.

Parameters marked as Defaulted can be left out in some installations, while other installations may require these parameters to be present. This is decided in the Bugzilla preferences. If you wish to make sure that the call works with all Bugzilla installations, you should supply values for all "defaulted" parameters.

It is recommended that you use GetLegalFieldValues to retrieve legal values for parameters such as component , version , operatingSystem, and other parameters that have pre-configured values on the server.

Definition at line 234 of file Product.cs.

References Product::CreateBug().

Bug CreateBug ( string  alias,
string  component,
string  version,
string  operatingSystem,
string  platform,
string  summary,
string  description,
string  priority,
string  severity 
) [inline]

Create a new bug on this product.

Parameters:
alias If aliases are enabled for the Bugzilla server, you can supply an unique identifier (no spaces or weird characters) to identify the bug with, in addition to the id.
component The name of the component that the bug will be created under.
version The version of the product, that the bug was found in.
operatingSystem (Defaulted) The operating system the bug was discovered on.
platform (Defaulted) What type of hardware the bug was experienced on.
summary Summary of the bug.
description (Defaulted) Description of the bug.
priority (Defaulted) What order the bug will be fixed in by the developer, compared to the developer's other bugs.
severity (Defaulted) How severe the bug is.
Returns:
The newly created bug.

Parameters marked as Defaulted can be left out in some installations, while other installations may require these parameters to be present. This is decided in the Bugzilla preferences. If you wish to make sure that the call works with all Bugzilla installations, you should supply values for all "defaulted" parameters.

It is recommended that you use GetLegalFieldValues to retrieve legal values for parameters such as component , version , operatingSystem, and other parameters that have pre-configured values on the server.

Definition at line 279 of file Product.cs.

References Product::CreateBug().

Bug CreateBug ( string  alias,
string  component,
string  version,
string  operatingSystem,
string  platform,
string  summary,
string  description,
string  priority,
string  severity,
string  status 
) [inline]

Create a new bug on this product.

Parameters:
alias (Optional) If aliases are enabled for the Bugzilla server, you can supply an unique identifier (no spaces or weird characters) to identify the bug with, in addition to the id.
component The name of the component that the bug will be created under.
version The version of the product, that the bug was found in.
operatingSystem (Defaulted) The operating system the bug was discovered on.
platform (Defaulted) What type of hardware the bug was experienced on.
summary Summary of the bug.
description (Defaulted) Description of the bug.
priority (Defaulted) What order the bug will be fixed in by the developer, compared to the developer's other bugs.
severity (Defaulted) How severe the bug is.
status (Optional) The status that this bug should start out as. Note that only certain statuses can be set on bug creation.
Returns:
The newly created bug.

The parameters for this call can be marked "optional" or "defaulted". Optional parameters can be left out in all Bugzilla installations (i.e. receive null), and a default value from the server will be substituted. Parameters marked as Defaulted can be left out in some installations, while other installations may require these parameters to be present. This is decided in the Bugzilla preferences. If you wish to make sure that the call works with all Bugzilla installations, you should supply values for all "defaulted" parameters.

It is recommended that you use GetLegalFieldValues to retrieve legal values for parameters such as component , version , operatingSystem, and other parameters that have pre-configured values on the server.

Definition at line 332 of file Product.cs.

References Product::CreateBug().

Bug CreateBug ( string  alias,
string  component,
string  version,
string  operatingSystem,
string  platform,
string  summary,
string  description,
string  priority,
string  severity,
string  status,
string  targetMilestone 
) [inline]

Create a new bug on this product.

Parameters:
alias (Optional) If aliases are enabled for the Bugzilla server, you can supply an unique identifier (no spaces or weird characters) to identify the bug with, in addition to the id.
component The name of the component that the bug will be created under.
version The version of the product, that the bug was found in.
operatingSystem (Defaulted) The operating system the bug was discovered on.
platform (Defaulted) What type of hardware the bug was experienced on.
summary Summary of the bug.
description (Defaulted) Description of the bug.
priority (Defaulted) What order the bug will be fixed in by the developer, compared to the developer's other bugs.
severity (Defaulted) How severe the bug is.
status (Optional) The status that this bug should start out as. Note that only certain statuses can be set on bug creation.
targetMilestone (Optional) A valid target milestone for this product.
Returns:
The newly created bug.

The parameters for this call can be marked "optional" or "defaulted". Optional parameters can be left out in all Bugzilla installations (i.e. receive null), and a default value from the server will be substituted. Parameters marked as Defaulted can be left out in some installations, while other installations may require these parameters to be present. This is decided in the Bugzilla preferences. If you wish to make sure that the call works with all Bugzilla installations, you should supply values for all "defaulted" parameters.

It is recommended that you use GetLegalFieldValues to retrieve legal values for parameters such as component , version , operatingSystem, and other parameters that have pre-configured values on the server.

Definition at line 387 of file Product.cs.

References Product::CreateBug().

Bug CreateBug ( string  alias,
string  component,
string  version,
string  operatingSystem,
string  platform,
string  summary,
string  description,
string  priority,
string  severity,
string  status,
string  targetMilestone,
string  assignedTo 
) [inline]

Create a new bug on this product.

Parameters:
alias (Optional) If aliases are enabled for the Bugzilla server, you can supply an unique identifier (no spaces or weird characters) to identify the bug with, in addition to the id.
component The name of the component that the bug will be created under.
version The version of the product, that the bug was found in.
operatingSystem (Defaulted) The operating system the bug was discovered on.
platform (Defaulted) What type of hardware the bug was experienced on.
summary Summary of the bug.
description (Defaulted) Description of the bug.
priority (Defaulted) What order the bug will be fixed in by the developer, compared to the developer's other bugs.
severity (Defaulted) How severe the bug is.
status (Optional) The status that this bug should start out as. Note that only certain statuses can be set on bug creation.
targetMilestone (Optional) A valid target milestone for this product.
assignedTo (Optional) A user to assign this bug to, if you don't want it to be assigned to the component owner.
Returns:
The newly created bug.

The parameters for this call can be marked "optional" or "defaulted". Optional parameters can be left out in all Bugzilla installations (i.e. receive null), and a default value from the server will be substituted. Parameters marked as Defaulted can be left out in some installations, while other installations may require these parameters to be present. This is decided in the Bugzilla preferences. If you wish to make sure that the call works with all Bugzilla installations, you should supply values for all "defaulted" parameters.

It is recommended that you use GetLegalFieldValues to retrieve legal values for parameters such as component , version , operatingSystem, and other parameters that have pre-configured values on the server.

Definition at line 446 of file Product.cs.

References Product::CreateBug().

Bug CreateBug ( string  alias,
string  component,
string  version,
string  operatingSystem,
string  platform,
string  summary,
string  description,
string  priority,
string  severity,
string  status,
string  targetMilestone,
string  assignedTo,
string[]  cc 
) [inline]

Create a new bug on this product.

Parameters:
alias (Optional) If aliases are enabled for the Bugzilla server, you can supply an unique identifier (no spaces or weird characters) to identify the bug with, in addition to the id.
component The name of the component that the bug will be created under.
version The version of the product, that the bug was found in.
operatingSystem (Defaulted) The operating system the bug was discovered on.
platform (Defaulted) What type of hardware the bug was experienced on.
summary Summary of the bug.
description (Defaulted) Description of the bug.
priority (Defaulted) What order the bug will be fixed in by the developer, compared to the developer's other bugs.
severity (Defaulted) How severe the bug is.
status (Optional) The status that this bug should start out as. Note that only certain statuses can be set on bug creation.
targetMilestone (Optional) A valid target milestone for this product.
assignedTo (Optional) A user to assign this bug to, if you don't want it to be assigned to the component owner.
cc (Optional) An array of usernames to CC on this bug.
Returns:
The newly created bug.

The parameters for this call can be marked "optional" or "defaulted". Optional parameters can be left out in all Bugzilla installations (i.e. receive null), and a default value from the server will be substituted. Parameters marked as Defaulted can be left out in some installations, while other installations may require these parameters to be present. This is decided in the Bugzilla preferences. If you wish to make sure that the call works with all Bugzilla installations, you should supply values for all "defaulted" parameters.

It is recommended that you use GetLegalFieldValues to retrieve legal values for parameters such as component , version , operatingSystem, and other parameters that have pre-configured values on the server.

Definition at line 508 of file Product.cs.

References Product::CreateBug().


Property Documentation

int Id [get]

Get the ID of the product.

The numeric ID of the product

Definition at line 74 of file Product.cs.

Referenced by Product::GetLegalFieldValues().

string Name [get]

Get the name of the product.

The name of the product

Definition at line 82 of file Product.cs.

string Description [get]

Get the description of the product.

The description of the product

Definition at line 90 of file Product.cs.


The documentation for this class was generated from the following file:
Generated on Thu Jan 17 07:31:46 2008 for BugzillaProxy by  doxygen 1.5.4