Package twisted :: Package news :: Module database :: Class INewsStorage

[frames | no frames]

## Class INewsStorage

    Interface --+
                |
               INewsStorage

An interface for storing and requesting news articles

Method Summary
| ``articleExistsRequest`(self, id)` Returns a deferred whose callback will be passed with a true value if a message with the specified Message-ID exists in the database and with a false value otherwise.
| ``articleRequest`(self, group, index, id)` Returns a deferred whose callback will be passed a file-like object containing the full article text (headers and body) for the article of the specified index in the specified group, and whose errback will be invoked if the article or group does not exist.
| ``bodyRequest`(self, group, index)` Returns a deferred whose callback will be passed the body for the article of the specified index in the specified group, and whose errback will be invoked if the article or group does not exist.
| ``groupRequest`(self, group)` Returns a deferred whose callback will be passed a five-tuple of (group name, article count, highest index, lowest index, group flags)
| ``headRequest`(self, group, index)` Returns a deferred whose callback will be passed the header for the article of the specified index in the specified group, and whose errback will be invoked if the article or group does not exist.
| ``listGroupRequest`(self, group)` Returns a deferred whose callback will be passed a two-tuple of (group name, [article indices])
| ``listRequest`(self)` Returns a deferred whose callback will be passed a list of 4-tuples containing (name, max index, min index, flags) for each news group
| ``overviewRequest`(self)` Returns a deferred whose callback will be passed the a list of headers describing this server's overview format.
| ``postRequest`(self, message)` Returns a deferred whose callback will be invoked if 'message' is successfully posted to one or more specified groups and whose errback will be invoked otherwise.
| ``subscriptionRequest`(self)` Returns a deferred whose callback will be passed the list of recommended subscription groups for new server users
| ``xhdrRequest`(self, group, low, high, header)` Returns a deferred whose callback will be passed a list of XHDR data for the given group over the given range.
| ``xoverRequest`(self, group, low, high)` Returns a deferred whose callback will be passed a list of xover headers for the given group over the given range.

Method Details

### articleExistsRequest(self, id)

Returns a deferred whose callback will be passed with a true value if a message with the specified Message-ID exists in the database and with a false value otherwise.

### articleRequest(self, group, index, id=None)

Returns a deferred whose callback will be passed a file-like object containing the full article text (headers and body) for the article of the specified index in the specified group, and whose errback will be invoked if the article or group does not exist. If id is not None, index is ignored and the article with the given Message-ID will be returned instead, along with its index in the specified group.

### bodyRequest(self, group, index)

Returns a deferred whose callback will be passed the body for the article of the specified index in the specified group, and whose errback will be invoked if the article or group does not exist.

### groupRequest(self, group)

Returns a deferred whose callback will be passed a five-tuple of (group name, article count, highest index, lowest index, group flags)

### headRequest(self, group, index)

Returns a deferred whose callback will be passed the header for the article of the specified index in the specified group, and whose errback will be invoked if the article or group does not exist.

### listGroupRequest(self, group)

Returns a deferred whose callback will be passed a two-tuple of (group name, [article indices])

### listRequest(self)

Returns a deferred whose callback will be passed a list of 4-tuples containing (name, max index, min index, flags) for each news group

### overviewRequest(self)

Returns a deferred whose callback will be passed the a list of headers describing this server's overview format.

### postRequest(self, message)

Returns a deferred whose callback will be invoked if 'message' is successfully posted to one or more specified groups and whose errback will be invoked otherwise.

### subscriptionRequest(self)

Returns a deferred whose callback will be passed the list of recommended subscription groups for new server users

### xhdrRequest(self, group, low, high, header)

Returns a deferred whose callback will be passed a list of XHDR data for the given group over the given range. If low is None, the range starts at the first article. If high is None, the range ends at the last article.

### xoverRequest(self, group, low, high)

Returns a deferred whose callback will be passed a list of xover headers for the given group over the given range. If low is None, the range starts at the first article. If high is None, the range ends at the last article.

Generated by Epydoc 2.0 on Sat May 15 20:08:24 2004 | http://epydoc.sf.net