l.h.b.h.HWDBUploadView(LaunchpadFormView) : class documentation

Part of lp.hardwaredb.browser.hwdb View In Hierarchy

View class for hardware database submissions.
Method upload_action Create a record in the HWSubmission table.
Method render See ILaunchpadFormView.
Method setHeadersForHWDBClient Add headers that help the HWDB client detect a successful upload.
Method addErrorHeader Adds a header informing an error to automated clients.
Method addCustomHeader Adds a custom header to HWDB clients.

Inherited from LaunchpadFormView:

Method __init__ Undocumented
Method initialize Undocumented
Method extendFields Allow subclasses to extend the form fields.
Method setUpFields Undocumented
Method setUpWidgets Set up the widgets using the view's form fields and the context.
Method help_links Dictionary mapping field names to help links.
Method adapters Provide custom adapters for use when setting up the widgets.
Method action_url Set the default action URL for the form.
Method has_available_actions Does the view have any available actions that will render?
Method initial_values Override this in your subclass if you want any widgets to have
Method addError Add a form wide error.
Method getFieldError Get the error associated with a particular field.
Method setFieldError Set the error associated with a particular field.
Static Method validate_none Do not do any validation.
Method validate_widgets Validate the named form widgets.
Method error_count Undocumented
Method ajax_failure_handler Called by the form if validate() finds any errors.
Method validate Validate the form.
Method validate_cancel Noop validation in case we cancel.
Method focusedElementScript Helper function to construct the script element content.
Method isSingleLineLayout Undocumented
Method isMultiLineLayout Undocumented
Method isCheckBoxLayout Undocumented
Method showOptionalMarker Should the (Optional) marker be shown?
Method _processNotifications Add any notification messages to the response headers.
Method _abort Abort the form edit.
Method _validate Check all widgets and perform any custom validation.
@action(u'Upload', 'upload')
def upload_action(self, action, data):
Create a record in the HWSubmission table.
def render(self):
See ILaunchpadFormView.
def setHeadersForHWDBClient(self):
Add headers that help the HWDB client detect a successful upload.

An upload is normally not made by a regular web browser, but by the HWDB client. In order to allow the client to easily detect a successful as well as an failed request, add some HTTP headers to the response.

def addErrorHeader(self, field_name, error):
Adds a header informing an error to automated clients.
def addCustomHeader(self, value):
Adds a custom header to HWDB clients.
API Documentation for Launchpad, generated by pydoctor at 2019-11-13 00:00:10.