Testopia::Webservice::Product

NAME

Testopia::Webservice::Product

EXTENDS

Bugzilla::Webservice

DESCRIPTION

Provides methods for automated scripts to expose Testopia Product data.

NOTE: In most cases where and id is required, a name attribute can be used instead provided it is unique. For example, Build.get({id => integer}) can substitute Build.get({name => string})

METHODS

check_category
 Description: Looks up and returns a category by name.

 Params:      $name - String: name of the category.
              $product - Integer/String
                 Integer: product_id of the product in the Database
                 String: Product name

 Returns:     Hash: Matching Category object hash or error if not found.
check_component
 Description: Looks up and returns a component by name.

 Params:      $name - String: name of the category.
              $product - Integer/String
                 Integer: product_id of the product in the Database
                 String: Product name

 Returns:     Hash: Matching component object hash or error if not found.
check_product
 Description: Looks up and returns a validated product.

 Params:      $name - String: name of the product.

 Returns:     Hash: Matching Product object hash or error if not found.
get
 Description: Used to load an existing product from the database.

 Params:      $id - An integer representing the ID in the database

 Returns:     A blessed Bugzilla::Extension::Testopia::Product object hash
create_category($values)
 Description: Creates a new build object and stores it in the database

 Params:      $values - Hash: A reference to a hash with keys and values  
              matching the fields of the build to be created. 
  +-------------+----------------+-----------+------------------------------------+
  | Field       | Type           | Null      | Description                        |
  +-------------+----------------+-----------+------------------------------------+
  | product     | Integer/String | Required  | ID or Name of product              |
  | name        | String         | Required  |                                    |
  | description | String         | Optional  |                                    |
  +-------------+----------------+-----------+------------------------------------+

 Returns:     The newly created object hash.
get_builds
 Description: Get the list of builds associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name
              $active  - Boolean: True to only include builds where isactive is true. 

 Returns:     Array: Returns an array of Build objects.
get_cases
 Description: Get the list of cases associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of TestCase objects.
get_categories
 Description: Get the list of categories associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of Case Category objects.
get_category
 Description: Get the category matching the given id.

 Params:      $id - Integer: ID of the category in the database.

 Returns:     Hash: Category object hash.
get_component
 Description: Get the component matching the given id.

 Params:      $id - Integer: ID of the component in the database.

 Returns:     Hash: Component object hash.
get_components
 Description: Get the list of components associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of Component objects.
get_environments
 Description: Get the list of environments associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of Environment objects.
get_milestones
 Description: Get the list of milestones associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of Milestone objects.
get_plans
 Description: Get the list of plans associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of Test Plan objects.
get_runs
 Description: Get the list of runs associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of Test Run objects.
get_tags
 Description: Get the list of tags associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of Tags objects.
get_versions
 Description: Get the list of versions associated with this product.

 Params:      $product - Integer/String
                         Integer: product_id of the product in the Database
                         String: Product name

 Returns:     Array: Returns an array of Version objects.

SEE ALSO

Bugzilla::Webservice

AUTHOR

Greg Hendricks <ghendricks@novell.com>