Interface FilingAllocationProxyManager

All Superinterfaces:

AutoCloseable, Closeable, FilingAllocationProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface FilingAllocationProxyManager
extends OsidProxyManager, FilingAllocationProfile

The filing allocation manager provides access sessions to allocations. Methods in this manager support the passing of a Proxy to pass information from server environments. 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

Modifier and Type	Method	Description
AllocationAdminSession	getAllocationAdminSession(Proxy proxy)	Gets the session for assigning quotas.
AllocationAdminSession	getAllocationAdminSessionForDirectory(String directoryPath, Proxy proxy)	Gets the session for assigning quotas for the given directory.
AllocationLookupSession	getAllocationLookupSession(Proxy proxy)	Gets the session for accessing usage and quotas.
AllocationLookupSession	getAllocationLookupSessionForDirectory(String directoryPath, Proxy proxy)	Gets the session for accessing usage and quotas for a given directory.
AllocationNotificationSession	getAllocationNotificationSession(AllocationReceiver allocationReceiver, Proxy proxy)	Gets the session for receiving messages about changes to directories.
AllocationNotificationSession	getAllocationNotificationSessionForDirectory(AllocationReceiver allocationReceiver, String directoryPath, Proxy proxy)	Gets the session for receiving messages about usage warnings and quota changes for the given directory.
AllocationSession	getAllocationSession(Proxy proxy)	Gets the session for accessing usage and quotas.
AllocationSession	getAllocationSessionForDirectory(String directoryPath, Proxy proxy)	Gets the session for accessing usage and quotas for a given directory.

Methods inherited from interface Closeable

close

Methods inherited from interface FilingAllocationProfile

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

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 OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

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

getAllocationSession

AllocationSession getAllocationSession(Proxy proxy)
                                throws OperationFailedException

Gets the session for accessing usage and quotas.

Parameters:

proxy - a proxy

Returns:

an AllocationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocation() is false

Compliance:

optional - This method must be implemented if {@code supportsAllocation()} is {@code true} .

getAllocationSessionForDirectory

AllocationSession getAllocationSessionForDirectory(String directoryPath,
 Proxy proxy)
                                            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

proxy - a proxy

Returns:

an AllocationSession

Throws:

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

NotFoundException - directoryPath is not found

NullArgumentException - directoryPath or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocation() is false

Compliance:

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

getAllocationLookupSession

AllocationLookupSession getAllocationLookupSession(Proxy proxy)
                                            throws OperationFailedException

Gets the session for accessing usage and quotas.

Parameters:

proxy - a proxy

Returns:

an AllocationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsAllocationLookup()} is {@code true} .

getAllocationLookupSessionForDirectory

AllocationLookupSession getAllocationLookupSessionForDirectory(String directoryPath,
 Proxy proxy)
                                                        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

proxy - a proxy

Returns:

an AllocationLookupSession

Throws:

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

NotFoundException - directoryPath is not found

NullArgumentException - directoryPath or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationLookup() is false

Compliance:

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

getAllocationAdminSession

AllocationAdminSession getAllocationAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the session for assigning quotas.

Parameters:

proxy - a proxy

Returns:

an AllocationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAllocationAdmin()} is {@code true} .

getAllocationAdminSessionForDirectory

AllocationAdminSession getAllocationAdminSessionForDirectory(String directoryPath,
 Proxy proxy)
                                                      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

proxy - a proxy

Returns:

an AllocationAdminSession

Throws:

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

NotFoundException - directoryPath is not found

NullArgumentException - directoryPath or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationAdmin() is false

Compliance:

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

getAllocationNotificationSession

AllocationNotificationSession getAllocationNotificationSession(AllocationReceiver allocationReceiver,
 Proxy proxy)
                                                        throws OperationFailedException

Gets the session for receiving messages about changes to directories.

Parameters:

allocationReceiver - the notification callback

proxy - a proxy

Returns:

an AllocationNotificationSession

Throws:

NullArgumentException - allocationReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDirectoryNotification()} is {@code true} .

getAllocationNotificationSessionForDirectory

AllocationNotificationSession getAllocationNotificationSessionForDirectory(AllocationReceiver allocationReceiver,
 String directoryPath,
 Proxy proxy)
                                                                    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

proxy - a proxy

Returns:

an AllocationNotificationSession

Throws:

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

NotFoundException - directoryPath is not found

NullArgumentException - allocationReceiver, directoryPath or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAllocationNotification() is false

Compliance:

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