public interface FilingAllocationManager extends OsidManager, FilingAllocationProfile
The filing allocation manager provides access sessions to retrieve and manage allocations. The sessions included in this manager are:
AllocationSession:
a session for accessing usage
information and quotas for the current user AllocationLookupSession:
a session for accessing
usage information and quotas AllocationAdminSession
a session for assigning
quotas AllocationNotificationSession:
a session for
subscribing to usage warnings and quota changes Modifier and Type | Method and Description |
---|---|
AllocationAdminSession |
getAllocationAdminSession()
Gets the session for assigning quotas.
|
AllocationAdminSession |
getAllocationAdminSessionForDirectory(java.lang.String directoryPath)
Gets the session for assigning quotas for the given directory.
|
AllocationLookupSession |
getAllocationLookupSession()
Gets the session for accessing usage and quotas.
|
AllocationLookupSession |
getAllocationLookupSessionForDirectory(java.lang.String directoryPath)
Gets the session for accessing usage and quotas for a given directory.
|
AllocationNotificationSession |
getAllocationNotificationSession(AllocationReceiver allocationReceiver)
Gets the session for receiving messages about changes to directories.
|
AllocationNotificationSession |
getAllocationNotificationSessionForDirectory(AllocationReceiver allocationReceiver,
java.lang.String directoryPath)
Gets the session for receiving messages about usage warnings and quota
changes for the given directory.
|
AllocationSession |
getAllocationSession()
Gets the session for accessing usage and quotas.
|
AllocationSession |
getAllocationSessionForDirectory(java.lang.String directoryPath)
Gets the session for accessing usage and quotas for a given directory.
|
changeBranch, initialize, rollbackService
close
getAllocationRecordTypes, supportsAllocation, supportsAllocationAdmin, supportsAllocationLookup, supportsAllocationNotification, supportsAllocationRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AllocationSession getAllocationSession() throws OperationFailedException
AllocationSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsAllocation()
is false
optional
- This method must be implemented if
supportsAllocation()
is true.
AllocationSession getAllocationSessionForDirectory(java.lang.String directoryPath) throws NotFoundException, OperationFailedException
directoryPath
- the pathname to the directory AllocationSession
InvalidArgumentException
- directoryPath
is not a directory or an alias to a directoryNotFoundException
- directoryPath
is not
foundNullArgumentException
- directoryPath
is
nullOperationFailedException
- unable to complete requestUnimplementedException
- supportsAllocation()
is false
optional
- This method must be implemented if
supportsAllocation()
and
supportsVisibleFederation()
are true.
AllocationLookupSession getAllocationLookupSession() throws OperationFailedException
AllocationLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationLookup()
is false
optional
- This method must be implemented if
supportsAllocationLookup()
is true.
AllocationLookupSession getAllocationLookupSessionForDirectory(java.lang.String directoryPath) throws NotFoundException, OperationFailedException
directoryPath
- the pathname to the directory AllocationLookupSession
InvalidArgumentException
- directoryPath
is not a directory or an alias to a directoryNotFoundException
- directoryPath
is not
foundNullArgumentException
- directoryPath
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationLookup()
is false
optional
- This method must be implemented if
supportsAllocationLookup()
and
supportsVisibleFederation()
are true.
AllocationAdminSession getAllocationAdminSession() throws OperationFailedException
AllocationAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationAdmin()
is false
optional
- This method must be implemented if
supportsAllocationAdmin()
is true.
AllocationAdminSession getAllocationAdminSessionForDirectory(java.lang.String directoryPath) throws NotFoundException, OperationFailedException
directoryPath
- the pathname to the directory AllocationAdminSession
InvalidArgumentException
- directoryPath
is not a directory or an alias to a directoryNotFoundException
- directoryPath
is not
foundNullArgumentException
- directoryPath
is
nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationAdmin()
is false
optional
- This method must be implemented if
supportsAllocationAdmin()
and
supportsVisibleFederation()
are true.
AllocationNotificationSession getAllocationNotificationSession(AllocationReceiver allocationReceiver) throws OperationFailedException
allocationReceiver
- the notification callback AllocationNotificationSession
NullArgumentException
- allocationReceiver
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationNotification()
is false
optional
- This method must be implemented if
supportsDirectoryNotification()
is true.
AllocationNotificationSession getAllocationNotificationSessionForDirectory(AllocationReceiver allocationReceiver, java.lang.String directoryPath) throws NotFoundException, OperationFailedException
allocationReceiver
- the notification callbackdirectoryPath
- the pathname to the directory AllocationNotificationSession
InvalidArgumentException
- directoryPath
is not a directory or an alias to a directoryNotFoundException
- directoryPath
is not
foundNullArgumentException
- allocationReceiver
or directoryPath
is nullOperationFailedException
- unable to complete requestUnimplementedException
-
supportsAllocationNotification()
is false
optional
- This method must be implemented if
supportsAllocationNotification()
and
supportsVisibleFederation()
are true.