OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.Browsable
Description

A marker interface for objects that offer property inspection.

MethodgetProperties
Description

Gets a list of properties. Properties provide a means for applications to display a representation of the contents of a record without understanding its Type specification. Applications needing to examine a specific property should use the extension interface defined by its Type.

Returnosid.PropertyLista list of properties
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDan authorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetPropertiesByRecordType
Description

Gets a list of properties corresponding to the specified record type. Properties provide a means for applications to display a representation of the contents of a record without understanding its record interface specification. Applications needing to examine a specific propertyshould use the methods defined by the record Type. The resulting set includes properties specified by parents of the record type in the case a record's interface extends another.

Parametersosid.type.TyperecordTypethe record type corresponding to the properties set to retrieve
Returnosid.PropertyLista list of properties
ErrorsNULL_ARGUMENT recordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDan authorization failure occurred
UNSUPPORTED hasRecordType(recordType) is false
CompliancemandatoryThis method must be implemented.