lp.soyuz.interfaces.packageset.IPackagesetViewOnly : API documentation

Method	sourcesIncluded	Get all source names associated with this package set.
Method	setsIncludedBy	Get all package sets that include this one.
Method	setsIncluded	Get all package sets that are included by this one.
Method	sourcesSharedBy	Get source package names also included by another package set.
Method	sourcesNotSharedBy	Get source package names not included by another package set.
Method	getSourcesIncluded	Get all source names associated with this package set.
Method	isSourceIncluded	Is this source package name included in this package set?
Method	getSourcesSharedBy	Get source package names also included by another package set.
Method	getSourcesNotSharedBy	Get source package names not included by another package set.
Method	relatedSets	Get all other package sets in this set's `PackagesetGroup`.

Inherited from IHasOwner:

Attribute

owner

The object's owner, which is an IPerson.

def sourcesIncluded(direct_inclusion=False):

Get all source names associated with this package set.

This method returns the source package names that are directly or indirectly associated with the package set at hand. Indirect associations may be defined through package set successors.

Parameters	direct_inclusion	if this flag is set to True only sources directly included by this package set will be considered.
Returns	A (potentially empty) sequence of `ISourcePackageName` instances.

@operation_parameters(Bool(False))
@operation_returns_collection_of(Interface)
@export_read_operation()
def setsIncludedBy(direct_inclusion=False):

Get all package sets that include this one.

Return all package sets that directly or indirectly include this one.

Parameters	direct_inclusion	if this flag is set to True only sets directly including this one will be considered.
Returns	A (potentially empty) sequence of `IPackageset` instances.

@operation_parameters(Bool(False))
@operation_returns_collection_of(Interface)
@export_read_operation()
def setsIncluded(direct_inclusion=False):

Get all package sets that are included by this one.

Return all package sets that are directly or indirectly included by this one.

Parameters	direct_inclusion	if this flag is set to True only sets directly included by this one will be considered.
Returns	A (potentially empty) sequence of `IPackageset` instances.

def sourcesSharedBy(other_package_set, direct_inclusion=False):

Get source package names also included by another package set.

What source package names does this package set have in common with the other_package_set?

Parameters	other_package_set	the other package set
	direct_inclusion	if this flag is set to True only directly included sources will be considered.
Returns	A (potentially empty) sequence of `ISourcePackageName` instances.

def sourcesNotSharedBy(other_package_set, direct_inclusion=False):

Get source package names not included by another package set.

Which source package names included by this package are not included by the other_package_set?

Parameters	other_package_set	the other package set
	direct_inclusion	if this flag is set to True only directly included sources will be considered.
Returns	A (potentially empty) sequence of `ISourcePackageName` instances.

@operation_parameters(Bool(False))
@export_read_operation()
def getSourcesIncluded(direct_inclusion=False):

Get all source names associated with this package set.

This method returns the source package names that are directly or indirectly associated with the package set at hand. Indirect associations may be defined through package set successors.

Please note: this method was mainly introduced in order to facilitate the listing of source package names via the LP web services API. It returns string names as opposed to ISourcePackageName instances.

Parameters	direct_inclusion	if this flag is set to True only sources directly included by this package set will be considered.
Returns	A (potentially empty) sequence of string source package names.

def isSourceIncluded(sourcepackagename, direct_inclusion=False):

Is this source package name included in this package set?

Parameters	sourcepackagename	an `ISourcePackageName`.
	direct_inclusion	if this flag is set to True only sources directly included by this package set will be considered.
Returns	True if the source is included in this package set, otherwise False.

@operation_parameters(Reference(Interface, _('The package set we are comparing to.'), True), Bool(False))
@export_read_operation()
def getSourcesSharedBy(other_package_set, direct_inclusion=False):

Get source package names also included by another package set.

What source package names does this package set have in common with the other_package_set?

Parameters	other_package_set	the other package set
	direct_inclusion	if this flag is set to True only directly included sources will be considered.
Returns	A (potentially empty) sequence of string source package names.

@operation_parameters(Reference(Interface, _('The package set we are comparing to.'), True), Bool(False))
@export_read_operation()
def getSourcesNotSharedBy(other_package_set, direct_inclusion=False):

Get source package names not included by another package set.

Which source package names included by this package are not included by the other_package_set?

Parameters	other_package_set	the other package set
	direct_inclusion	if this flag is set to True only directly included sources will be considered.
Returns	A (potentially empty) sequence of string source package names.

@operation_returns_collection_of(Interface)
@export_read_operation()
def relatedSets():

Get all other package sets in this set's PackagesetGroup.

Returns all package sets that are related to this one, but not this one itself.

Returns A (potentially empty) sequence of IPackageset instances.

l.s.i.p.IPackagesetViewOnly(IHasOwner) : interface documentation