org.osid.provisioning

Interface RequestTransactionLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface RequestTransactionLookupSession
extends OsidSession

This session provides methods for retrieving RequestTransactions.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated distributor view: All request transaction methods in this session operate, retrieve and pertain to request transactions defined explicitly in the current distributor. Using an isolated view is useful for managing RequestTransactions with the RequesTransactionAdminSession.
• federated distributor view: All request transaction methods in this session operate, retrieve and pertain to all request transaction defined in this distributor and any other request transaction implicitly available in this distributor through distributor inheritence.
• effective request view: All request transaction lookup methods return request transactions where the current date falls in between the effective dates inclusive.
• any effective request view: Request transactions of any effective date are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupRequestTransactions() Tests if this user can perform RequestTransaction lookups.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
RequestTransaction	getRequestTransaction(Id requestTransactionId) Gets the RequestTransaction specified by its Id.
RequestTransactionList	getRequestTransactions() Gets all RequestTransactions.
RequestTransactionList	getRequestTransactionsByGenusType(Type requestTransactionGenusType) Gets a RequestTransactionList corresponding to the given request transaction genus Type which does not include of genus types derived from the specified Type.
RequestTransactionList	getRequestTransactionsByIds(IdList requestTransactionIds) Gets a RequestTransactionList corresponding to the given IdList.
RequestTransactionList	getRequestTransactionsByParentGenusType(Type requestTransactionGenusType) Gets a RequestTransactionList corresponding to the given request transaction genus Type and include any additional request transaction with genus types derived from the specified Type.
RequestTransactionList	getRequestTransactionsByRecordType(Type requestTransactionRecordType) Gets a RequestTransactionList containing the given request transaction record Type.
RequestTransactionList	getRequestTransactionsByRequest(Id requestId) Gets a list of request transactions by request.
RequestTransactionList	getRequestTransactionsForBroker(Id brokerId) Gets a list of request transactions for a bropker.
RequestTransactionList	getRequestTransactionsForBrokerOnDate(Id brokerId, DateTime from, DateTime to) Gets a list of request transactions for a broker and effective beginning in the date range.
RequestTransactionList	getRequestTransactionsForSubmitter(Id resourceId) Gets a list of request transactions for a submitter in the request transaction.
RequestTransactionList	getRequestTransactionsForSubmitterAndBroker(Id resourceId, Id brokerId) Gets a list of request transactions for a submitter and broker.
RequestTransactionList	getRequestTransactionsForSubmitterAndBrokerOnDate(Id resourceId, Id brokerId, DateTime from, DateTime to) Gets a list of request transactions for a submitter and broker and effective beginning in the date range.
RequestTransactionList	getRequestTransactionsForSubmitterOnDate(Id resourceId, DateTime from, DateTime to) Gets a list of request transactions for a submitter and effective beginning in the date range.
RequestTransactionList	getRequestTransactionsOnDate(DateTime from, DateTime to) Gets a list of request transactions effective beginning in the date range.
void	useAnyEffectiveRequestTransactionView() All request transactions of any effective dates are returned by methods in this session.
void	useComparativeRequestTransactionView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useEffectiveRequestTransactionView() Only request transactions whose effective dates are current are returned by methods in this session.
void	useFederatedDistributorView() Federates the view for methods in this session.
void	useIsolatedDistributorView() Isolates the view for methods in this session.
void	usePlenaryRequestTransactionView() A complete view of the RequestTransaction returns is desired.

Methods inherited from interface org.osid.OsidSession

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

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

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.

canLookupRequestTransactions

boolean canLookupRequestTransactions()

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

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRequestTransactionView

void useComparativeRequestTransactionView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRequestTransactionView

void usePlenaryRequestTransactionView()

A complete view of the RequestTransaction returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedDistributorView

void useFederatedDistributorView()

Federates the view for methods in this session. A federated view will include request transactions in distributors which are children of this distributor in the distributor hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedDistributorView

void useIsolatedDistributorView()

Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.

Compliance:

mandatory - This method is must be implemented.

useEffectiveRequestTransactionView

void useEffectiveRequestTransactionView()

Only request transactions whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveRequestTransactionView

void useAnyEffectiveRequestTransactionView()

All request transactions of any effective dates are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getRequestTransaction

RequestTransaction getRequestTransaction(Id requestTransactionId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the RequestTransaction specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned RequestTransaction may have a different Id than requested, such as the case where a duplicate Id was assigned to a RequestTransaction and retained for compatibility. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

requestTransactionId - Id of RequestTransaction

Returns:

the request transaction

Throws:

NotFoundException - requestTransactionId not found

NullArgumentException - requestTransactionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRequestTransactionsByIds

RequestTransactionList getRequestTransactionsByIds(IdList requestTransactionIds)
                                                   throws NotFoundException,
                                                          OperationFailedException,
                                                          PermissionDeniedException

Gets a RequestTransactionList corresponding to the given IdList. In plenary mode, the returned list contains all of the request transaction specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible RequestTransactions may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

requestTransactionIds - the list of Ids to retrieve

Returns:

the returned RequestTransaction list

Throws:

NotFoundException - an Id was not found

NullArgumentException - requestTransactionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsByGenusType

RequestTransactionList getRequestTransactionsByGenusType(Type requestTransactionGenusType)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets a RequestTransactionList corresponding to the given request transaction genus Type which does not include of genus types derived from the specified Type. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

requestTransactionGenusType - a request transaction genus type

Returns:

the returned RequestTransaction list

Throws:

NullArgumentException - requestTransactionGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsByParentGenusType

RequestTransactionList getRequestTransactionsByParentGenusType(Type requestTransactionGenusType)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets a RequestTransactionList corresponding to the given request transaction genus Type and include any additional request transaction with genus types derived from the specified Type. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

requestTransactionGenusType - a request transaction genus type

Returns:

the returned RequestTransaction list

Throws:

NullArgumentException - requestTransactionGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsByRecordType

RequestTransactionList getRequestTransactionsByRecordType(Type requestTransactionRecordType)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets a RequestTransactionList containing the given request transaction record Type. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

requestTransactionRecordType - a request transaction record type

Returns:

the returned RequestTransaction list

Throws:

NullArgumentException - requestTransactionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsByRequest

RequestTransactionList getRequestTransactionsByRequest(Id requestId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets a list of request transactions by request. In plenary mode, the returned list contains all known request transaction or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

requestId - a request Id

Returns:

the returned RequestTransaction list

Throws:

NullArgumentException - requestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsOnDate

RequestTransactionList getRequestTransactionsOnDate(DateTime from,
                                                  DateTime to)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a list of request transactions effective beginning in the date range. Request transaction are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known request transaction or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned RequestTransaction list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsForSubmitter

RequestTransactionList getRequestTransactionsForSubmitter(Id resourceId)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets a list of request transactions for a submitter in the request transaction. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

resourceId - a resource Id

Returns:

the returned RequestTransaction list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsForSubmitterOnDate

RequestTransactionList getRequestTransactionsForSubmitterOnDate(Id resourceId,
                                                              DateTime from,
                                                              DateTime to)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets a list of request transactions for a submitter and effective beginning in the date range. Request transactions are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

resourceId - a resource Id

from - start of date range

to - end of date range

Returns:

the returned RequestTransaction list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsForBroker

RequestTransactionList getRequestTransactionsForBroker(Id brokerId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets a list of request transactions for a bropker. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

brokerId - a broker Id

Returns:

the returned RequestTransaction list

Throws:

NullArgumentException - brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsForBrokerOnDate

RequestTransactionList getRequestTransactionsForBrokerOnDate(Id brokerId,
                                                           DateTime from,
                                                           DateTime to)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

Gets a list of request transactions for a broker and effective beginning in the date range. Request transactions are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

brokerId - a broker Id

from - start of date range

to - end of date range

Returns:

the returned RequestTransaction list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - brokerId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsForSubmitterAndBroker

RequestTransactionList getRequestTransactionsForSubmitterAndBroker(Id resourceId,
                                                                 Id brokerId)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

Gets a list of request transactions for a submitter and broker. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

resourceId - a resource Id

brokerId - a broker Id

Returns:

the returned RequestTransaction list

Throws:

NullArgumentException - resourceId or brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionsForSubmitterAndBrokerOnDate

RequestTransactionList getRequestTransactionsForSubmitterAndBrokerOnDate(Id resourceId,
                                                                       Id brokerId,
                                                                       DateTime from,
                                                                       DateTime to)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

Gets a list of request transactions for a submitter and broker and effective beginning in the date range. Request transaction are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective request transactions and those currently expired are returned.

Parameters:

resourceId - a resource Id

brokerId - a broker Id

from - start of date range

to - end of date range

Returns:

the returned RequestTransaction list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, brokerId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactions

RequestTransactionList getRequestTransactions()
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets all RequestTransactions. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.

Returns:

a list of RequestTransaction

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.