lp.blueprints.browser.specificationtarget.HasSpecificationsView : API documentation

Base class for several context-specific views that involve lists of specifications.

This base class knows how to handle and represent lists of specifications, produced by a method view.specs(). The individual class view objects each implement that method in a way that is appropriate for them, because they each want to filter the list of specs in different ways. For example, in the case of PersonSpecsView, you want to filter based on the relationship the person has to the specs. In the case of a ProductSpecsView you want to filter primarily based on the completeness of the spec.

Method	template	Undocumented
Method	render	Undocumented
Method	initialize	Undocumented
Method	can_configure_blueprints	Can the user configure blueprints for the `ISpecificationTarget`.
Method	label	Undocumented
Method	has_any_specifications	Undocumented
Method	all_specifications	Undocumented
Method	searchrequested	Undocumented
Method	searchtext	Undocumented
Method	spec_filter	The list of specs that are going to be displayed in this view.
Method	specs	Undocumented
Method	specs_batched	Undocumented
Method	spec_count	Undocumented
Method	documentation	Undocumented
Method	categories	This organises the specifications related to this target by
Method	getLatestSpecifications	Return <quantity> latest specs created for this target.

@property
def template(self):

Undocumented

def render(self):

Undocumented

def initialize(self):

overridden in lp.blueprints.browser.specificationgoal.GoalDecideView, lp.blueprints.browser.sprint.SprintTopicSetView, lp.blueprints.browser.sprint.SprintView

Undocumented

@property
def can_configure_blueprints(self):

Can the user configure blueprints for the ISpecificationTarget.

@property
def label(self):

overridden in lp.blueprints.browser.specificationtarget.SpecificationAssignmentsView, lp.blueprints.browser.specificationtarget.SpecificationDocumentationView, lp.blueprints.browser.sprint.SprintTopicSetView

Undocumented

@cachedproperty
def has_any_specifications(self):

Undocumented

@cachedproperty
def all_specifications(self):

Undocumented

@cachedproperty
def searchrequested(self):

Undocumented

@cachedproperty
def searchtext(self):

Undocumented

@cachedproperty
def spec_filter(self):

overridden in lp.blueprints.browser.specificationgoal.GoalDecideView, lp.blueprints.browser.sprint.SprintTopicSetView

The list of specs that are going to be displayed in this view.

This method determines the appropriate filtering to be passed to context.specifications(). See IHasSpecifications.specifications for further details.

The method can review the URL and decide what will be included, and what will not.

The typical URL is of the form:

".../name1/+specs?show=complete&informational&acceptance=accepted"

This method will interpret the show= part based on the kind of object that is the context of this request.

@property
def specs(self):

Undocumented

@cachedproperty
def specs_batched(self):

Undocumented

@cachedproperty
def spec_count(self):

Undocumented

@cachedproperty
def documentation(self):

Undocumented

@cachedproperty
def categories(self):

This organises the specifications related to this target by "category", where a category corresponds to a particular spec status. It also determines the order of those categories, and the order of the specs inside each category.

It is also used in IPerson, which is not an ISpecificationTarget but which does have a IPerson.specifications. In this case, it will also detect which set of specifications you want to see. The options are:

all specs (self.context.specifications())

created by this person

assigned to this person

for review by this person

specs this person must approve

drafted by this person

subscribed by this person

def getLatestSpecifications(self, quantity=5):

Return <quantity> latest specs created for this target.

Only ACCEPTED specifications are returned. This list is used by the +portlet-latestspecs view.

l.b.b.s.HasSpecificationsView(LaunchpadView) : class documentation