l.r.i.e.IEntitlement(Interface) : interface documentation

Part of lp.registry.interfaces.entitlement View In Hierarchy

Known implementations: lp.registry.model.entitlement.Entitlement

An entitlement the right to use a specific feature in Launchpad.

Entitlements can be granted in an unlimited quantity or with a given quota. They have a start date and optionally an expiration date. An entitlement is invalid if it is not active, the quota is exceeded, or if it is expired.

Int id Undocumented
Choice person Person or team to whom the entitlements is assigned.
Datetime date_created The date on which this entitlement was created.
Datetime date_starts The date on which this entitlement starts.
Datetime date_expires The date on which this entitlement expires.
Choice entitlement_type Type of feature for this entitlement.
Int quota A quota is the number of a feature allowed by this entitlement, for instance 50 private bugs.
Int amount_used The amount used is the number of instances of a feature the person has used so far.
Choice registrant Person who registered the entitlement. May be None if created automatically.
Choice approved_by Person who approved the entitlement. May be None if created automatically.
Choice state Current state of the entitlement.
Whiteboard whiteboard Notes on the current status of the entitlement.
Bool is_dirty Is the entitlement 'dirty', i.e. has been written since the most recent update to an external system?
Attribute is_valid Is this entitlement valid?
Attribute exceeded_quota If the quota is not unlimited, is it exceeded?
Attribute in_date_range Has the start date passed but not the expiration date?
Method incrementAmountUsed Add one to the amount used.
id =
Undocumented
person =
Person or team to whom the entitlements is assigned.
date_created =
The date on which this entitlement was created.
date_starts =
The date on which this entitlement starts.
date_expires =
The date on which this entitlement expires.
entitlement_type =
Type of feature for this entitlement.
quota =
A quota is the number of a feature allowed by this entitlement, for instance 50 private bugs.
amount_used =
The amount used is the number of instances of a feature the person has used so far.
registrant =
Person who registered the entitlement. May be None if created automatically.
approved_by =
Person who approved the entitlement. May be None if created automatically.
state =
Current state of the entitlement.
whiteboard =
Notes on the current status of the entitlement.
is_dirty =
Is the entitlement 'dirty', i.e. has been written since the most recent update to an external system?
is_valid =
Is this entitlement valid?
exceeded_quota =
If the quota is not unlimited, is it exceeded?
in_date_range =
Has the start date passed but not the expiration date?
def incrementAmountUsed():
Add one to the amount used.
API Documentation for Launchpad, generated by pydoctor at 2010-09-27 00:00:11.