Interface MyProvisionSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface MyProvisionSession
extends OsidSession

This session defines methods for retrieving supplied provisions related to the queueing of the resource related to the authenticated agent.

This lookup session defines several views:

• effective provision view: All lookup methods return provisions and requests where the current date falls in between the effective dates inclusive.
• any effective provision view: Provisions and requests of any effective date are returned from methods.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupMyProvision()	Tests if this user can perform Provisions lookups.
Distributor	getDistributor()	Gets the Distributor associated with this session.
Id	getDistributorId()	Gets the Distributor Id associated with this session.
ProvisionList	getMyProvisions()	Gets the provisions for the resource related to this agent.
QueueList	getMyQueues()	Gets all the queues in which the resource related to the authenticated agent is on.
RequestList	getMyRequests()	Gets all the requests in which the resource related to the authenticated agent.
void	useAnyEffectiveProvisionView()	All provisionables requests and pools of any effective dates are returned by methods in this session.
void	useEffectiveProvisionView()	Only provisionables requests and pools whose effective dates are current are returned by methods in this session.

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

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                    throws OperationFailedException,
PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupMyProvision

boolean canLookupMyProvision()

Tests if this user can perform Provisions lookups. 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 not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useEffectiveProvisionView

void useEffectiveProvisionView()

Only provisionables requests and pools whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveProvisionView

void useAnyEffectiveProvisionView()

All provisionables requests and pools of any effective dates are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getMyProvisions

ProvisionList getMyProvisions()
                       throws OperationFailedException,
PermissionDeniedException

Gets the provisions for the resource related to this agent.

Returns:

the returned ProvisionList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyQueues

QueueList getMyQueues()
               throws OperationFailedException,
PermissionDeniedException

Gets all the queues in which the resource related to the authenticated agent is on.

Returns:

the returned Queue list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyRequests

RequestList getMyRequests()
                   throws OperationFailedException,
PermissionDeniedException

Gets all the requests in which the resource related to the authenticated agent.

Returns:

the returned Request list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.