OSID Logo
OSID Specifications
filing allocation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.allocation.FilingAllocationProfile
Implementsosid.OsidProfile
Description

The filing allocation profile describes the interoperability among filing allocation services.

MethodsupportsVisibleFederation
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.

Returnboolean true if federation is visible false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAllocation
Description

Tests if filing allocation is supported.

Returnboolean true if a AllocationSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAllocationLookup
Description

Tests if filing allocation lookup is supported.

Returnboolean true if a AllocationLookupSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAllocationAdmin
Description

Tests if quota administration is supported.

Returnboolean true if a AllocationAdminSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsAllocationNotification
Description

Tests if an allocation notification service is supported.

Returnboolean true if a AllocationNotificationSession is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAllocationRecordTypes
Description

Gets the supported allocation record types.

Returnosid.type.TypeLista list containing the supported Allocation record types
CompliancemandatoryThis method must be implemented.
MethodsupportsAllocationRecordType
Description

Tests if the given allocation record type is supported.

Parametersosid.type.TypeallocationRecordTypea Type indicating an allocation record type
Returnboolean true if the given record Type is supported, false otherwise
ErrorsNULL_ARGUMENT allocationRecordType is null
CompliancemandatoryThis method must be implemented.