l.c.i.h.IHasBranches(Interface) : interface documentation

Part of lp.code.interfaces.hasbranches View In Hierarchy

Known subclasses: lp.registry.interfaces.person.IPersonViewRestricted, lp.registry.interfaces.personproduct.IPersonProduct, lp.registry.interfaces.product.IProductView, lp.registry.interfaces.projectgroup.IProjectGroupPublic, lp.registry.interfaces.sourcepackage.ISourcePackagePublic, lp.registry.interfaces.webservice.IDistributionSourcePackage

Some things have related branches.

This interface defines the common methods for getting branches for the objects that implement this interface.

Method getBranches Returns all branches with the given lifecycle status.
@operation_parameters(List(_('A list of branch lifecycle statuses to filter by.'), Choice(BranchLifecycleStatus)), Datetime(_('Limit the branches to those modified since this date.'), False))
@call_with(REQUEST_USER)
@operation_returns_collection_of(Interface)
@export_read_operation()
@operation_for_version('beta')
def getBranches(status=None, visible_by_user=None, modified_since=None, eager_load=False):
Returns all branches with the given lifecycle status.
ParametersstatusA list of statuses to filter with.
visible_by_userNormally the user who is asking.
modified_sinceIf set, filters the branches being returned to those that have been modified since the specified date/time.
eager_loadIf True load related objects for the whole collection.
ReturnsA list of IBranch.
API Documentation for Launchpad, generated by pydoctor at 2019-10-17 00:00:09.