NAME

Bugzilla::Testopia::Webservice::Product


EXTENDS

Bugzilla::Webservice


DESCRIPTION

Provides methods for automated scripts to expose Testopia Product data.


METHODS

check_category($name, $product)
 Description: Looks up and returns a category by name.
 Params:      $name - String: name of the category.
              $product - Integer/String/Object
                 Integer: product_id of the product in the Database
                 String: Product name
                 Object: Blessed Bugzilla::Product object
 Returns:     Hash: Matching Category object hash or error if not found.
check_component($name, $product)
 Description: Looks up and returns a component by name.
 Params:      $name - String: name of the category.
              $product - Integer/String/Object
                 Integer: product_id of the product in the Database
                 String: Product name
                 Object: Blessed Bugzilla::Product object
 Returns:     Hash: Matching component object hash or error if not found.
check_product($name, $product)
 Description: Looks up and returns a validated product.
 Params:      $name - String: name of the product.
              $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object
 Returns:     Hash: Matching Product object hash or error if not found.
get($id)
 Description: Used to load an existing product from the database.
 Params:      $id - An integer representing the ID in the database
 Returns:     A blessed Bugzilla::Testopia::Product object hash
get_builds($product, $active)
 Description: Get the list of builds associated with this product.
 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object
              $active  - Boolean: True to only include builds where isactive is true.
 Returns:     Array: Returns an array of Build objects.
get_cases($product)
 Description: Get the list of cases associated with this product.
 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object
 Returns:     Array: Returns an array of TestCase objects.
get_categories($product)
 Description: Get the list of categories associated with this product.
 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object

 Returns:     Array: Returns an array of Case Category objects.

get_category($id)
 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($id)
 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($product)
 Description: Get the list of components associated with this product.

 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object

 Returns:     Array: Returns an array of Component objects.

get_environments($product)
 Description: Get the list of environments associated with this product.

 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object

 Returns:     Array: Returns an array of Environment objects.

get_milestones($product)
 Description: Get the list of milestones associated with this product.

 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object

 Returns:     Array: Returns an array of Milestone objects.

get_plans($product)
 Description: Get the list of plans associated with this product.

 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object

 Returns:     Array: Returns an array of Test Plan objects.

get_runs($product)
 Description: Get the list of runs associated with this product.

 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object

 Returns:     Array: Returns an array of Test Run objects.

get_tags($product)
 Description: Get the list of tags associated with this product.

 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object

 Returns:     Array: Returns an array of Tags objects.

get_versions($product)
 Description: Get the list of versions associated with this product.

 Params:      $product - Integer/String/Object
                         Integer: product_id of the product in the Database
                         String: Product name
                         Object: Blessed Bugzilla::Product object

 Returns:     Array: Returns an array of Version objects.

lookup_name_by_id DEPRECATED Use Product::get instead
lookup_id_by_name DEPRECATED - CONSIDERED HARMFUL Use Product::check_product instead


SEE ALSO

the Bugzilla::Testopia::Product manpage the Bugzilla::Webservice manpage


AUTHOR

Greg Hendricks <ghendricks@novell.com>