IbisAttribute

Class in module ibisclient.dto

class IbisAttribute(attrs={})

Bases: IbisDto

Class representing an attribute of a person or institution returned by the web service API. Note that for institution attributes, the instid, visibility and owningGroupid fields will be None.

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

attrid

int

The unique internal identifier of the attribute.

binaryData

bytes

The binary data held in the attribute (e.g., a JPEG photo).

comment

str

Any comment associated with the attribute.

effectiveFrom

date

For time-limited attributes, the date from which it takes effect.

effectiveTo

date

For time-limited attributes, the date after which it is no longer effective.

encoded_string()

Encode this attribute as an ASCII string suitable for passing as a parameter to a web service API method. This string is compatible with valueOf(java.lang.String) on the corresponding Java class, used on the server to decode the attribute parameter.

Note

This requires that the attribute's scheme field be set, and typically the value or binaryData should also be set.

Returns

str

The string encoding of this attribute.

instid

str

For a person attribute, the optional institution that the attribute is associated with. This will not be set for institution attributes.

owningGroupid

str

For a person attribute, the ID of the group that owns it (typically the user agent group that created it).

scheme

str

The attribute's scheme.

value

str

The attribute's value (except for binary attributes).

visibility

str

For a person attribute, it's visibility ("private", "institution", "university" or "world"). This will not be set for institution attributes.