pyams_sequence.interfaces package ⊞

interface pyams_sequence.interfaces.IInternalReference

Extends: zope.annotation.interfaces.IAttributeAnnotatable

Internal link interface

reference

Internal reference

Internal link target reference. You can search a reference using ‘+’ followed by internal number, of by entering text matching content title.

Implementation:pyams_sequence.schema.InternalReferenceField Read Only:False Required:True Default Value:None Allowed Type:str

target

Internal reference target

get_target(self, state=None, request=None)

Get target from internal reference

interface pyams_sequence.interfaces.IInternalReferencesList

Extends: zope.annotation.interfaces.IAttributeAnnotatable

Internal references list

references

Internal references

List of internal references

Implementation:pyams_sequence.schema.InternalReferencesListField Read Only:False Required:False Default Value:None Allowed Type:list

Value Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

get_targets(self, state=None)

Get iterator over targets from internal references

interface pyams_sequence.interfaces.ISequentialIdInfo

Sequential ID info interface

oid

Sequential ID

Implementation:zope.schema.Int Read Only:False Required:False Default Value:None Allowed Type:int

hex_oid

Unique ID

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

public_oid

Unique ID

Implementation:zope.schema.TextLine Read Only:True Required:True Default Value:None Allowed Type:str

get_full_oid(self)

Get full OID

get_short_oid(self)

Get short OID

get_base_oid(self)

Get base OID

interface pyams_sequence.interfaces.ISequentialIdTarget

Extends: zope.annotation.interfaces.IAttributeAnnotatable

Marker interface used to identify contents requiring sequential IDs

sequence_name

Sequence name

Name of registered sequence utility used to get unique IDs

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

sequence_prefix

Hexadecimal prefix

Prefix used to generate hexadecimal ID, placed after utility prefix. Generally defined at class level…

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

interface pyams_sequence.interfaces.ISequentialIntIds

Sequential IntIds utility interface

prefix

Hexadecimal prefix

Prefix used to generate hexadecimal ID

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

hex_oid_length

Hexadecimal ID length

Full length of hexadecimal ID, not including prefix

Implementation:zope.schema.Int Read Only:False Required:True Default Value:10 Allowed Type:int

last_oid

Last OID

Last used sequence

Implementation:zope.schema.Int Read Only:False Required:True Default Value:0 Allowed Type:int

query_hex_oid(self, obj)

Generate an hexadecimal ID for the given sequence

get_full_oid(self, oid, obj_prefix=None)

Get full ID based on partial OID

get_short_oid(self, oid, obj_prefix=None)

Get short ID based on given numeric object ID

get_base_oid(self, oid, obj_prefix=None)

Get base ID (without prefix) based on given numeric object ID

get_internal_id(self, oid)

Get internal ID matching given OID

query_object_from_oid(self, oid)

Query object with given OID