Interface ExchangeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ExchangeSession
extends OsidSession

This session exchanges an existing provision for a request for another provision via the queue. The data for create and update is provided via the RequestForm .

Method Summary

Modifier and Type	Method	Description
boolean	canCreateRequestsInExchange(Id provisionId)	Tests if this user can create Requests .
boolean	canCreateRequestWithRecordTypesInExchange(Id provisionId, Type[] requestRecordTypes)	Tests if this user can create a single Request using the desired record types.
Request	createRequestInExchange(RequestForm requestForm)	Creates a new Request .
Queue	getQueue()	Gets the Queue associated with this session.
Id	getQueueId()	Gets the Queue Id associated with this session.
RequestForm	getRequestFormForCreate(Id provisionId, Type[] requestRecordTypes)	Gets the request form for creating new requests for the exchange.

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

getQueueId

Id getQueueId()

Gets the Queue Id associated with this session.

Returns:

the Queue Id associated with this session

Compliance:

mandatory - This method must be implemented.

getQueue

Queue getQueue()
        throws OperationFailedException,
PermissionDeniedException

Gets the Queue associated with this session.

Returns:

the queue

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateRequestsInExchange

boolean canCreateRequestsInExchange(Id provisionId)

Tests if this user can create Requests . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Request will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Parameters:

provisionId - the Id of the provision to exchange

Returns:

false if Request creation is not authorized, true otherwise

Throws:

NullArgumentException - provisionId is null

Compliance:

mandatory - This method must be implemented.

canCreateRequestWithRecordTypesInExchange

boolean canCreateRequestWithRecordTypesInExchange(Id provisionId,
 Type[] requestRecordTypes)

Tests if this user can create a single Request using the desired record types. While ProvisioningManager.getRequestRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Request . Providing an empty array tests if a Request can be created with no records.

Parameters:

provisionId - the Id of the provision to exchange

requestRecordTypes - array of request record types

Returns:

true if Request creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - provisionId or requestRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getRequestFormForCreate

RequestForm getRequestFormForCreate(Id provisionId,
 Type[] requestRecordTypes)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the request form for creating new requests for the exchange. A new form should be requested for each create transaction.

Parameters:

provisionId - the Id of the provision to exchange

requestRecordTypes - array of request record types

Returns:

the request form

Throws:

NotFoundException - provisionId is not found

NullArgumentException - provisionId or requestRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createRequestInExchange

Request createRequestInExchange(RequestForm requestForm)
                         throws OperationFailedException,
PermissionDeniedException

Creates a new Request .

Parameters:

requestForm - the form for this Request

Returns:

the new Request

Throws:

IllegalStateException - requestForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - requestForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - requestForm did not originate from getRequestFormForCreate()

Compliance:

mandatory - This method must be implemented.