lp.code.interfaces.branchnamespace.IBranchNamespacePolicy : API documentation

Method	canCreateBranches	Is the user allowed to create branches for this namespace?
Method	getAllowedInformationTypes	Get the information types that a branch in this namespace can have.
Method	getDefaultInformationType	Get the default information type for branches in this namespace.
Method	validateRegistrant	Check that the registrant can create a branch on this namespace.
Method	validateBranchName	Check the branch `name`.
Method	validateMove	Check that 'mover' can move 'branch' into this namespace.

def canCreateBranches(user):

Is the user allowed to create branches for this namespace?

Parameters	user	An `IPerson`.
Returns	A Boolean value.

def getAllowedInformationTypes(who):

Get the information types that a branch in this namespace can have.

:param who: The user making the request.
:return: A sequence of `InformationType`s.

def getDefaultInformationType(who):

Get the default information type for branches in this namespace.

Parameters	who	The user for whom to return the information type.
Returns	An `InformationType`.

def validateRegistrant(registrant, branch=None):

Check that the registrant can create a branch on this namespace.

Parameters	registrant	An `IPerson`.
	branch	An optional `IBranch` to also check when working with imported branches.
Raises	BranchCreatorNotMemberOfOwnerTeam	if the namespace owner is a team, and the registrant is not in that team.
	BranchCreatorNotOwner	if the namespace owner is an individual and the registrant is not the owner.
	BranchCreationForbidden	if the registrant is not allowed to create a branch in this namespace due to privacy rules.

def validateBranchName(name):

Check the branch name.

Parameters	name	A branch name, either string or unicode.
Raises	BranchExists	if a branch with the `name` exists already in the namespace.
	LaunchpadValidationError	if the name doesn't match the validation constraints on IBranch.name.

def validateMove(branch, mover, name=None):

Check that 'mover' can move 'branch' into this namespace.

Parameters	branch	An `IBranch` that might be moved.
	mover	The `IPerson` who would move it.
	name	A new name for the branch. If None, the branch name is used.
Raises	BranchCreatorNotMemberOfOwnerTeam	if the namespace owner is a team, and 'mover' is not in that team.
	BranchCreatorNotOwner	if the namespace owner is an individual and 'mover' is not the owner.
	BranchCreationForbidden	if 'mover' is not allowed to create a branch in this namespace due to privacy rules.
	BranchExists	if a branch with the 'name' exists already in the namespace.

l.c.i.b.IBranchNamespacePolicy(Interface) : interface documentation