| | |
- ZSI.TCcompound.Array(ZSI.TC.TypeCode)
-
- RDSArray
- AuthToken
- AuthTokenResponse
- ExplainRequest
- ExplainResponse
- Record
- ResultSet
- ScanRequest
- ScanResponse
- ScanTerm
- SearchRetrieveRequest
- SearchRetrieveResponse
- ZSI.TC.String(ZSI.TC.TypeCode)
-
- XMLorString
class AuthToken |
| |
Object to represent an Authentication Token
|
| |
Methods defined here:
- __init__(self, name, **kw)
Data and non-method functions defined here:
- __doc__ = 'Object to represent an Authentication Token'
- __module__ = 'SRWTypes'
- name = ''
- time = 0
- ttl = 0
- value = ''
|
class AuthTokenResponse |
| |
Object to represent an AuthToken Reponse
|
| |
Methods defined here:
- __init__(self, name, **kw)
Data and non-method functions defined here:
- __doc__ = 'Object to represent an AuthToken Reponse'
- __module__ = 'SRWTypes'
- name = ''
- token = None
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
|
class ExplainRequest |
| |
|
| |
Methods defined here:
- __init__(self, n, config=None, opts={}, protocol='SRW')
Data and non-method functions defined here:
- __doc__ = None
- __module__ = 'SRWTypes'
- extraRequestData = None
- name = ''
- recordPacking = 'string'
- responseName = 'explainResponse'
- responseType = <class SRWTypes.ExplainResponse>
- stylesheet = None
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
- version = '1.1'
|
class ExplainResponse |
| |
|
| |
Methods defined here:
- __init__(self, n, **kw)
Data and non-method functions defined here:
- __doc__ = None
- __module__ = 'SRWTypes'
- diagnostics = []
- extraResponseData = None
- name = ''
- record = None
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
- version = '1.1'
|
class RDSArray(ZSI.TCcompound.Array) |
| |
Array like type for Records, Diagnostics and SortKeys
|
| |
- Method resolution order:
- RDSArray
- ZSI.TCcompound.Array
- ZSI.TC.TypeCode
Methods defined here:
- serialize(self, sw, pyobj, name=None, attrtext='', childnames=None, **kw)
- Serialise without arrayType, etc.
Data and non-method functions defined here:
- __doc__ = 'Array like type for Records, Diagnostics and SortKeys'
- __module__ = 'SRWTypes'
Methods inherited from ZSI.TCcompound.Array:
- __init__(self, atype, ofwhat, pname=None, dimensions=1, fill=None, sparse=0, mutable=0, size=None, nooffset=0, undeclared=0, childnames=None, **kw)
- parse(self, elt, ps)
- parse_offset(self, elt, ps)
- parse_position(self, elt, ps)
Methods inherited from ZSI.TC.TypeCode:
- SimpleHREF(self, elt, ps, tag)
- Simple HREF for non-string and non-struct and non-array.
- checkname(self, elt, ps)
- See if the name and type of the "elt" element is what we're
looking for. Return the element's type.
- checktype(self, elt, ps)
- See if the type of the "elt" element is what we're looking for.
Return the element's type.
- get_parse_and_errorlist(self)
- Get the parselist and human-readable version (errorlist, because
it's used in error messages).
- name_match(self, elt)
- Simple boolean test to see if we match the element name.
- nilled(self, elt, ps)
- Is the element NIL, and is that okay?
- simple_value(self, elt, ps)
- Get the value of the simple content of this element.
Data and non-method functions inherited from ZSI.TC.TypeCode:
- typechecks = 1
|
class Record |
| |
Object to represent an SRW Record
|
| |
Methods defined here:
- __init__(self, n, **kw)
Data and non-method functions defined here:
- __doc__ = 'Object to represent an SRW Record'
- __module__ = 'SRWTypes'
- inline = 1
- name = ''
- recordData = ''
- recordPosition = 0
- recordSchema = ''
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
|
class ResultSet |
| |
Object to represent a resultSet
|
| |
Methods defined here:
- __init__(self, name, **kw)
Data and non-method functions defined here:
- __doc__ = 'Object to represent a resultSet'
- __module__ = 'SRWTypes'
- name = ''
- resultSetId = ''
- time = 0
- ttl = 0
|
class ScanRequest |
| |
|
| |
Methods defined here:
- __init__(self, name, config=None, opts={}, protocol='SRW')
Data and non-method functions defined here:
- __doc__ = None
- __module__ = 'SRWTypes'
- extraRequestData = None
- integerParams = ['maximumTerms', 'responsePosition']
- maximumTerms = 0
- name = 'scanRequest'
- responseName = 'scanResponse'
- responsePosition = 1
- responseType = <class SRWTypes.ScanResponse>
- scanClause = ''
- stylesheet = ''
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
- version = '1.1'
- xScanClause = None
|
class ScanResponse |
| |
|
| |
Methods defined here:
- __init__(self, name, **kw)
Data and non-method functions defined here:
- __doc__ = None
- __module__ = 'SRWTypes'
- diagnostics = []
- extraResponseData = None
- name = 'scanResponse'
- terms = []
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
- version = '1.1'
|
class ScanTerm |
| |
|
| |
Methods defined here:
- __init__(self, name, **kw)
Data and non-method functions defined here:
- __doc__ = None
- __module__ = 'SRWTypes'
- displayTerm = ''
- extraTermData = None
- name = 'term'
- numberOfRecords = 0
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
- value = ''
|
class SearchRetrieveRequest |
| |
Object to represent a request
|
| |
Methods defined here:
- __init__(self, name, config=None, opts={}, protocol='SRW')
Data and non-method functions defined here:
- __doc__ = 'Object to represent a request'
- __module__ = 'SRWTypes'
- extraRequestData = []
- integerParams = ['resultSetTTL', 'startRecord', 'maximumRecords']
- maximumRecords = 0
- name = ''
- query = ''
- queryStructure = None
- recordPacking = 'string'
- recordSchema = ''
- recordXPath = ''
- responseName = 'searchRetrieveResponse'
- responseType = <class SRWTypes.SearchRetrieveResponse>
- Object to represent a response
- resultSetTTL = 0
- sortKeys = ''
- startRecord = 1
- stylesheet = ''
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
- version = '1.1'
- xQuery = None
- xSortKeys = []
|
class SearchRetrieveResponse |
| |
Object to represent a response
|
| |
Methods defined here:
- __init__(self, n, **kw)
Data and non-method functions defined here:
- __doc__ = ' Object to represent a response '
- __module__ = 'SRWTypes'
- echoedRequest = None
- name = ''
- nextRecordPosition = 0
- numberOfRecords = 0
- records = []
- resultSetId = ''
- resultSetIdleTime = 0
- typecode = <ZSI.TCcompound.Struct instance>
- A structure.
- version = '1.1'
|
class XMLorString(ZSI.TC.String) |
| |
XML/String 'choice' for recordData
|
| |
- Method resolution order:
- XMLorString
- ZSI.TC.String
- ZSI.TC.TypeCode
Methods defined here:
- parse(self, elt, ps)
- serialize(self, sw, pyobj, name=None, attrtext='', **kw)
Data and non-method functions defined here:
- __doc__ = "XML/String 'choice' for recordData"
- __module__ = 'SRWTypes'
Methods inherited from ZSI.TC.String:
- __init__(self, pname=None, strip=1, textprotect=1, **kw)
Data and non-method functions inherited from ZSI.TC.String:
- parselist = [(None, 'string')]
- seriallist = [<type 'str'>, <type 'unicode'>]
- tag = 'string'
Methods inherited from ZSI.TC.TypeCode:
- SimpleHREF(self, elt, ps, tag)
- Simple HREF for non-string and non-struct and non-array.
- checkname(self, elt, ps)
- See if the name and type of the "elt" element is what we're
looking for. Return the element's type.
- checktype(self, elt, ps)
- See if the type of the "elt" element is what we're looking for.
Return the element's type.
- get_parse_and_errorlist(self)
- Get the parselist and human-readable version (errorlist, because
it's used in error messages).
- name_match(self, elt)
- Simple boolean test to see if we match the element name.
- nilled(self, elt, ps)
- Is the element NIL, and is that okay?
- simple_value(self, elt, ps)
- Get the value of the simple content of this element.
Data and non-method functions inherited from ZSI.TC.TypeCode:
- typechecks = 1
| |