...
All of the above interfaces Extensibles. Each may have OsidRecords. Typically, it makes sense that same record Type is used to identify the various OsidRecords among these different interfaces. Using the color example above, the following OsidRecords would all be identified by the same colorResourceRecordType.
colorResourceRecord | |||
| Method | getColor | ||
|---|---|---|---|
| Description | Gets the color of this Resource. | ||
| Return | string | the color | |
| Compliance | mandatory | This method must be implemented. | |
colorResourceFormRecord | |||
| Method | getColorMetadata | ||
| Description | Gets the metadata for the color. | ||
| Return | osid.Metadata | the metadata | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setColor | ||
| Description | Sets the color. | ||
| Parameters | string | color | the color of this resource |
| Errors | INVALID_ARGUMENT | color is invalid | |
| NULL_ARGUMENT | color is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearColor | ||
| Description | Clears the color. | ||
| Compliance | mandatory | This method must be implemented. | |
colorResourceQueryRecord | |||
| Method | matchColor | ||
| Description | Matches resources of the given color. | ||
| Parameters | string | color | the color to match |
| osid.type.Type | stringMatchType | the string match type | |
| boolean | match | true for a positive match, false for a negative match | |
| Errors | NULL_ARGUMENT | color or stringMatchType is null | |
| UNSUPPORTED | supportsStringMatchType(stringMatchType) is false | ||
| Compliance | mandatory | This method must be implemented. | |
colorResourceQueryInspectorRecord | |||
| Method | getColorTerms | ||
| Description | Gets the color query terms. | ||
| Return | osid.search.terms.StringTerm[] | the string query terms | |
| Compliance | mandatory | This method must be implemented. | |
colorResourceSearchOrderRecord | |||
| Method | orderByColor | ||
| Description | Orders the results by color. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
...