IbisAttributeScheme

Class in module ibisclient.dto

class IbisAttributeScheme(attrs={})

Bases: ibisclient.dto.IbisDto

Class representing an attribute scheme. This may apply to attributes of people or institutions.

Code author: Dean Rasheed (dev-group@ucs.cam.ac.uk)

dataType
str

The attribute scheme’s datatype.

displayName
str

The display name for labelling attributes in this scheme.

ldapName
str

The name of the attribute scheme in LDAP, if it is exported to LDAP. Note that many attributes are not exported to LDAP, in which case this name is typically just equal to the scheme’s ID.

multiLined
bool

Flag for textual attributes schemes indicating whether they are multi-lined.

multiValued
bool

Flag indicating whether attributes in this scheme can be multi-valued.

precedence
int

The attribute scheme’s precedence. Methods that return or display attributes sort the results primarily in order of increasing values of attribute scheme precedence.

regexp
str

For textual attributes, an optional regular expression that all attributes in this scheme match.

schemeid
str

The unique identifier of the attribute scheme.

searchable
bool

Flag indicating whether attributes of this scheme are searched by the default search functionality.