Interface | osid.filing.allocation.FilingAllocationProfile | ||
---|---|---|---|
Implements | osid.OsidProfile | ||
Description |
The filing allocation profile describes the interoperability among filing allocation services. | ||
Method | supportsVisibleFederation | ||
Description |
Tests if any dictionary federation is exposed. Federation is exposed when a specific dictionary may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of dictionaries appears as a single dictionary. | ||
Return | boolean | true if federation is visible false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAllocation | ||
Description |
Tests if filing allocation is supported. | ||
Return | boolean | true if a AllocationSession is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAllocationLookup | ||
Description |
Tests if filing allocation lookup is supported. | ||
Return | boolean | true if a AllocationLookupSession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAllocationAdmin | ||
Description |
Tests if quota administration is supported. | ||
Return | boolean | true if a AllocationAdminSession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAllocationNotification | ||
Description |
Tests if an allocation | ||
Return | boolean | true if a AllocationNotificationSession is
available, false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAllocationRecordTypes | ||
Description |
Gets the supported allocation record types. | ||
Return | osid.type.TypeList | a list containing the supported Allocation record types | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsAllocationRecordType | ||
Description |
Tests if the given allocation record type is supported. | ||
Parameters | osid.type.Type | allocationRecordType | a Type indicating an allocation record type |
Return | boolean | true if the given record Type is supported,
false otherwise | |
Errors | NULL_ARGUMENT | allocationRecordType is null | |
Compliance | mandatory | This method must be implemented. |