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

Modifier and Type	Method	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 OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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.