lp.code.interfaces.hasbranches.IHasBranches : API documentation

Some things have related branches.

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

@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.

Parameters	status	A list of statuses to filter with.
	visible_by_user	Normally the user who is asking.
	modified_since	If set, filters the branches being returned to those that have been modified since the specified date/time.
	eager_load	If True load related objects for the whole collection.
Returns	A list of `IBranch`.

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