User property sheets

interface Products.PluggableAuthService.interfaces.propertysheets.IPropertySheet[source]

Interface for queryable property sheets.

o Objects implementing this interface can play in read-only fashion
in OFS.PropertySheets’ framework.
getId()

Identify the sheet within a collection.

hasProperty(id)

Does the sheet have a property corresponding to ‘id’?

getProperty(id, default=None)

Return the value of the property corresponding to ‘id’.

o If no such property exists within the sheet, return ‘default’.

getPropertyType(id)

Return the string identifying the type of property, ‘id’.

o If no such property exists within the sheet, return None.

propertyInfo(id)

Return a mapping describing property, ‘id’.

o Keys must include:

‘id’ – the unique identifier of the property.

‘type’ – the string identifying the property type.

‘meta’ – a mapping containing additional info about the property.

propertyMap()

Return a tuple of ‘propertyInfo’ mappings, one per property.

propertyIds()

Return a sequence of the IDs of the sheet’s properties.

propertyValues()

Return a sequence of the values of the sheet’s properties.

propertyItems()

Return a sequence of (id, value) tuples, one per property.