lp.bugs.interfaces.webservice.IBugTrackerSet : API documentation

A set of IBugTracker's.

Each BugTracker is a distinct instance of a bug tracking tool. For example, bugzilla.mozilla.org is distinct from bugzilla.gnome.org.

Attribute	title	Title
Attribute	count	The number of registered bug trackers.
Attribute	names	The names of all registered bug trackers.
Method	get	Get a BugTracker by its id.
Method	getByName	Get a BugTracker by its name.
Method	__getitem__	Get a BugTracker by its name in the database.
Method	__iter__	Iterate through BugTrackers.
Method	queryByBaseURL	Return one or None BugTracker's by baseurl
Method	ensureBugTracker	Make sure that there is a bugtracker for the given base url.
Method	search	Search all the IBugTrackers in the system.
Method	getMostActiveBugTrackers	Return the top IBugTrackers.
Method	getPillarsForBugtrackers	Return dict mapping bugtrackers to lists of pillars.
Method	getAllTrackers	Return a ResultSet of bugtrackers.

def get(bugtracker_id, default=None):

Get a BugTracker by its id.

If no tracker with the given id exists, return default.

@operation_parameters(TextLine(u'The bug tracker name', True))
@operation_returns_entry(IBugTracker)
@export_read_operation()
def getByName(name, default=None):

Get a BugTracker by its name.

If no tracker with the given name exists, return default.

def __getitem__(name):

Get a BugTracker by its name in the database.

Note: We do not want to expose the BugTracker.id to the world so we use its name.

@rename_parameters_as('base_url')
@operation_parameters(TextLine(u'The base URL of the bug tracker', True))
@operation_returns_entry(IBugTracker)
@export_read_operation()
def queryByBaseURL(baseurl):

Return one or None BugTracker's by baseurl

@call_with(REQUEST_USER)
@rename_parameters_as('base_url', 'bug_tracker_type', 'contact_details')
@export_factory_operation(IBugTracker, 'baseurl''bugtrackertype''title''summary''contactdetails''name')
def ensureBugTracker(baseurl, owner, bugtrackertype, title=None, summary=None, contactdetails=None, name=None):

Make sure that there is a bugtracker for the given base url.

If not, create one using the given attributes.

def getMostActiveBugTrackers(limit=None):

Return the top IBugTrackers.

Returns a list of IBugTracker objects, ordered by the number of bugwatches for each tracker, from highest to lowest.

def getAllTrackers(active=None):

Return a ResultSet of bugtrackers.

Parameters active If True, only active trackers are returned, if False only inactive trackers are returned. All trackers are returned by default.

l.b.i.w.IBugTrackerSet(Interface) : interface documentation