Interface AllocationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

AllocationLookupSession

public interface AllocationSession
extends OsidSession

This session defines methods for accessing space allocation and quotas.

Method Summary

Modifier and Type	Method	Description
boolean	canAccessFilingAllocations()	Tests if this user can perform functions in this session.
Directory	getDirectory()	Gets the directory associated with this session.
Allocation	getDirectoryAllocation()	Gets the allocation of the data store across all users.
AllocationList	getDirectoryAllocations()	Gets the allocation of the data store across all users and include any allocations for sub-stores.
String	getDirectoryPath()	Gets the absolute path of this directory.
Allocation	getUserAllocation()	Gets the user quota allocation of the data store for the current user.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

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

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getDirectoryPath

String getDirectoryPath()

Gets the absolute path of this directory.

Returns:

the absolute path of this directory

Compliance:

mandatory - This method must be implemented.

getDirectory

Directory getDirectory()
                throws OperationFailedException,
PermissionDeniedException

Gets the directory associated with this session.

Returns:

the directory associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAccessFilingAllocations

boolean canAccessFilingAllocations()

Tests if this user can perform functions in this session. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if filing allocation methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getDirectoryAllocation

Allocation getDirectoryAllocation()
                           throws OperationFailedException,
PermissionDeniedException

Gets the allocation of the data store across all users. The directory available by the allocation may indicate a higher level directory than the one associated with this session. If no specific aclloation exists, the returned Allocation may indicate the limits of the file system.

Returns:

the allocation

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDirectoryAllocations

AllocationList getDirectoryAllocations()
                                throws OperationFailedException,
PermissionDeniedException

Gets the allocation of the data store across all users and include any allocations for sub-stores.

Returns:

the allocation list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getUserAllocation

Allocation getUserAllocation()
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the user quota allocation of the data store for the current user. The directory available by the allocation may indicate a higher level directory than the one requested if the one requested is a sub-directory inside the qoutad data store.

Returns:

the allocation

Throws:

NotFoundException - agentId is not found

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.