org.osid.filing.allocation

Interface FilingAllocationManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, FilingAllocationProfile, OsidManager, OsidProfile, Sourceable

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

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.filing.allocation.FilingAllocationProfile

getAllocationRecordTypes, supportsAllocation, supportsAllocationAdmin, supportsAllocationLookup, supportsAllocationNotification, supportsAllocationRecordType, supportsVisibleFederation

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

getAllocationSession

AllocationSession getAllocationSession()
                                       throws OperationFailedException

Gets the session for accessing usage and quotas.

Returns:

an AllocationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocation() is false

Compliance:

optional - This method must be implemented if supportsAllocation() is true.

getAllocationSessionForDirectory

AllocationSession getAllocationSessionForDirectory(java.lang.String directoryPath)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the session for accessing usage and quotas for a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

directoryPath - the pathname to the directory

Returns:

an AllocationSession

Throws:

InvalidArgumentException - directoryPath is not a directory or an alias to a directory

NotFoundException - directoryPath is not found

NullArgumentException - directoryPath is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocation() is false

Compliance:

optional - This method must be implemented if supportsAllocation() and supportsVisibleFederation() are true.

getAllocationLookupSession

AllocationLookupSession getAllocationLookupSession()
                                                   throws OperationFailedException

Gets the session for accessing usage and quotas.

Returns:

an AllocationLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationLookup() is false

Compliance:

optional - This method must be implemented if supportsAllocationLookup() is true.

getAllocationLookupSessionForDirectory

AllocationLookupSession getAllocationLookupSessionForDirectory(java.lang.String directoryPath)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the session for accessing usage and quotas for a given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

directoryPath - the pathname to the directory

Returns:

an AllocationLookupSession

Throws:

InvalidArgumentException - directoryPath is not a directory or an alias to a directory

NotFoundException - directoryPath is not found

NullArgumentException - directoryPath is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationLookup() is false

Compliance:

optional - This method must be implemented if supportsAllocationLookup() and supportsVisibleFederation() are true.

getAllocationAdminSession

AllocationAdminSession getAllocationAdminSession()
                                                 throws OperationFailedException

Gets the session for assigning quotas.

Returns:

an AllocationAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationAdmin() is false

Compliance:

optional - This method must be implemented if supportsAllocationAdmin() is true.

getAllocationAdminSessionForDirectory

AllocationAdminSession getAllocationAdminSessionForDirectory(java.lang.String directoryPath)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the session for assigning quotas for the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

directoryPath - the pathname to the directory

Returns:

an AllocationAdminSession

Throws:

InvalidArgumentException - directoryPath is not a directory or an alias to a directory

NotFoundException - directoryPath is not found

NullArgumentException - directoryPath is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationAdmin() is false

Compliance:

optional - This method must be implemented if supportsAllocationAdmin() and supportsVisibleFederation() are true.

getAllocationNotificationSession

AllocationNotificationSession getAllocationNotificationSession(AllocationReceiver allocationReceiver)
                                                               throws OperationFailedException

Gets the session for receiving messages about changes to directories.

Parameters:

allocationReceiver - the notification callback

Returns:

an AllocationNotificationSession

Throws:

NullArgumentException - allocationReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationNotification() is false

Compliance:

optional - This method must be implemented if supportsDirectoryNotification() is true.

getAllocationNotificationSessionForDirectory

AllocationNotificationSession getAllocationNotificationSessionForDirectory(AllocationReceiver allocationReceiver,
                                                                         java.lang.String directoryPath)
                                                                           throws NotFoundException,
                                                                                  OperationFailedException

Gets the session for receiving messages about usage warnings and quota changes for the given directory. If the path is an alias, the target directory is used. The path indicates the file alias and the real path indicates the target directory.

Parameters:

allocationReceiver - the notification callback

directoryPath - the pathname to the directory

Returns:

an AllocationNotificationSession

Throws:

InvalidArgumentException - directoryPath is not a directory or an alias to a directory

NotFoundException - directoryPath is not found

NullArgumentException - allocationReceiver or directoryPath is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationNotification() is false

Compliance:

optional - This method must be implemented if supportsAllocationNotification() and supportsVisibleFederation() are true.