org.osid.filing.allocation

Interface FilingAllocationProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

FilingAllocationManager, FilingAllocationProxyManager

public interface FilingAllocationProfile
extends OsidProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getAllocationRecordTypes() Gets the supported allocation record types.
boolean	supportsAllocation() Tests if filing allocation is supported.
boolean	supportsAllocationAdmin() Tests if quota administration is supported.
boolean	supportsAllocationLookup() Tests if filing allocation lookup is supported.
boolean	supportsAllocationNotification() Tests if an allocation notification service is supported.
boolean	supportsAllocationRecordType(Type allocationRecordType) Tests if the given allocation record type is supported.
boolean	supportsVisibleFederation() Tests if any dictionary federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if federation is visible false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAllocation

boolean supportsAllocation()

Tests if filing allocation is supported.

Returns:

true if a AllocationSession is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAllocationLookup

boolean supportsAllocationLookup()

Tests if filing allocation lookup is supported.

Returns:

true if a AllocationLookupSession is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAllocationAdmin

boolean supportsAllocationAdmin()

Tests if quota administration is supported.

Returns:

true if a AllocationAdminSession is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsAllocationNotification

boolean supportsAllocationNotification()

Tests if an allocation notification service is supported.

Returns:

true if a AllocationNotificationSession is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAllocationRecordTypes

TypeList getAllocationRecordTypes()

Gets the supported allocation record types.

Returns:

a list containing the supported Allocation record types

Compliance:

mandatory - This method must be implemented.

supportsAllocationRecordType

boolean supportsAllocationRecordType(Type allocationRecordType)

Tests if the given allocation record type is supported.

Parameters:

allocationRecordType - a Type indicating an allocation record type

Returns:

true if the given record Type is supported, false otherwise

Throws:

NullArgumentException - allocationRecordType is null

Compliance:

mandatory - This method must be implemented.