org.osid.provisioning

Interface RequestLookupSession

All Superinterfaces:

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

public interface RequestLookupSession
extends OsidSession

This session provides methods for retrieving Request relationships.

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 methods in this session operate, retrieve and pertain to requests defined explicitly in the current distributor. Using an isolated view is useful for managing Requests with the RequestAdminSession.
• federated distributor view: All request methods in this session operate, retrieve and pertain to all requests defined in this distributor and any other requests implicitly available in this distributor through distributor inheritence.
• effective request view: All request lookup methods return requests where the current date falls in between the effective dates inclusive.
• any effective request view: Requests 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	canLookupRequests() Tests if this user can perform Request lookups.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
Request	getRequest(Id requestId) Gets the Request specified by its Id.
RequestList	getRequests() Gets all Requests.
RequestList	getRequestsByGenusType(Type requestGenusType) Gets a RequestList corresponding to the given request genus Type which does not include requests of genus types derived from the specified Type.
RequestList	getRequestsByIds(IdList requestIds) Gets a RequestList corresponding to the given IdList.
RequestList	getRequestsByParentGenusType(Type requestGenusType) Gets a RequestList corresponding to the given request genus Type and include any additional requests with genus types derived from the specified Type.
RequestList	getRequestsByRecordType(Type requestRecordType) Gets a RequestList containing the given request record Type.
RequestList	getRequestsForQueue(Id queueId) Gets a list of requests for a queue.
RequestList	getRequestsForQueueOnDate(Id queueId, DateTime from, DateTime to) Gets a list of requests for a queue and effective during the entire given date range inclusive but not confined to the date range.
RequestList	getRequestsForRequester(Id resourceId) Gets a list of requests for a requester.
RequestList	getRequestsForRequesterAndQueue(Id resourceId, Id queueId) Gets a list of requests for a requester and queue.
RequestList	getRequestsForRequesterAndQueueOnDate(Id resourceId, Id queueId, DateTime from, DateTime to) Gets a list of requests for a requester and queue and effective during the entire given date range inclusive but not confined to the date range.
RequestList	getRequestsForRequesterOnDate(Id resourceId, DateTime from, DateTime to) Gets a list of requests for a requester and effective during the entire given date range inclusive but not confined to the date range.
RequestList	getRequestsOnDate(DateTime from, DateTime to) Gets a list of requests effective during the entire given date range inclusive but not confined to the date range.
void	useAnyEffectiveRequestView() All requests of any effective dates are returned by methods in this session.
void	useComparativeRequestView() 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	useEffectiveRequestView() Only requests 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	usePlenaryRequestView() A complete view of the Request 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.

canLookupRequests

boolean canLookupRequests()

Tests if this user can perform Request 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.

useComparativeRequestView

void useComparativeRequestView()

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.

usePlenaryRequestView

void usePlenaryRequestView()

A complete view of the Request 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 requests 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.

useEffectiveRequestView

void useEffectiveRequestView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveRequestView

void useAnyEffectiveRequestView()

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

Compliance:

mandatory - This method is must be implemented.

getRequest

Request getRequest(Id requestId)
                   throws NotFoundException,
                          OperationFailedException,
                          PermissionDeniedException

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

Parameters:

requestId - Id of the Request

Returns:

the request

Throws:

NotFoundException - requestId not found

NullArgumentException - requestId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRequestsByIds

RequestList getRequestsByIds(IdList requestIds)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets a RequestList corresponding to the given IdList. In plenary mode, the returned list contains all of the requests 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 Requests may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.

Parameters:

requestIds - the list of Ids to retrieve

Returns:

the returned Request list

Throws:

NotFoundException - an Id was not found

NullArgumentException - requestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsByGenusType

RequestList getRequestsByGenusType(Type requestGenusType)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

requestGenusType - a request genus type

Returns:

the returned Request list

Throws:

NullArgumentException - requestGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsByParentGenusType

RequestList getRequestsByParentGenusType(Type requestGenusType)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

requestGenusType - a request genus type

Returns:

the returned Request list

Throws:

NullArgumentException - requestGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsByRecordType

RequestList getRequestsByRecordType(Type requestRecordType)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

requestRecordType - a request record type

Returns:

the returned Request list

Throws:

NullArgumentException - requestRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsOnDate

RequestList getRequestsOnDate(DateTime from,
                            DateTime to)
                              throws OperationFailedException,
                                     PermissionDeniedException

Gets a list of requests effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective requests and those currently expired are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned Request 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.

getRequestsForRequester

RequestList getRequestsForRequester(Id resourceId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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

Parameters:

resourceId - a resource Id

Returns:

the returned Request list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsForRequesterOnDate

RequestList getRequestsForRequesterOnDate(Id resourceId,
                                        DateTime from,
                                        DateTime to)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets a list of requests for a requester and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective requests and those currently expired are returned.

Parameters:

resourceId - a resource Id

from - start of date range

to - end of date range

Returns:

the returned Request 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.

getRequestsForQueue

RequestList getRequestsForQueue(Id queueId)
                                throws OperationFailedException,
                                       PermissionDeniedException

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

Parameters:

queueId - a queue Id

Returns:

the returned Request list

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsForQueueOnDate

RequestList getRequestsForQueueOnDate(Id queueId,
                                    DateTime from,
                                    DateTime to)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a list of requests for a queue and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective requests and those currently expired are returned.

Parameters:

queueId - a queue Id

from - start of date range

to - end of date range

Returns:

the returned Request list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - queueId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsForRequesterAndQueue

RequestList getRequestsForRequesterAndQueue(Id resourceId,
                                          Id queueId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

resourceId - a resource Id

queueId - a queue Id

Returns:

the returned Request list

Throws:

NullArgumentException - resourceId or queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestsForRequesterAndQueueOnDate

RequestList getRequestsForRequesterAndQueueOnDate(Id resourceId,
                                                Id queueId,
                                                DateTime from,
                                                DateTime to)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets a list of requests for a requester and queue and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective requests and those currently expired are returned.

Parameters:

resourceId - a resource Id

queueId - a queue Id

from - start of date range

to - end of date range

Returns:

the returned Request list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, queueId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequests

RequestList getRequests()
                        throws OperationFailedException,
                               PermissionDeniedException

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

Returns:

a list of Requests

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.