public interface RequestTransactionLookupSession extends OsidSession
This session provides methods for retrieving
RequestTransactions.
This session defines views that offer differing behaviors when retrieving multiple objects.
RequestTransactions
with the
RequesTransactionAdminSession.
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.
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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRequestTransactions()
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRequestTransactionView()
mandatory
- This method is must be implemented. void usePlenaryRequestTransactionView()
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.mandatory
- This method is must be implemented. void useFederatedDistributorView()
mandatory
- This method is must be implemented. void useIsolatedDistributorView()
mandatory
- This method is must be implemented. void useEffectiveRequestTransactionView()
mandatory
- This method is must be implemented. void useAnyEffectiveRequestTransactionView()
mandatory
- This method is must be implemented. RequestTransaction getRequestTransaction(Id requestTransactionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.requestTransactionId
- Id
of
RequestTransaction
NotFoundException
- requestTransactionId
not foundNullArgumentException
- requestTransactionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RequestTransactionList getRequestTransactionsByIds(IdList requestTransactionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
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.requestTransactionIds
- the list of Ids
to
retrieve RequestTransaction
listNotFoundException
- an Id
was not foundNullArgumentException
- requestTransactionIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsByGenusType(Type requestTransactionGenusType) throws OperationFailedException, PermissionDeniedException
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.requestTransactionGenusType
- a request transaction genus type RequestTransaction
listNullArgumentException
-
requestTransactionGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsByParentGenusType(Type requestTransactionGenusType) throws OperationFailedException, PermissionDeniedException
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.requestTransactionGenusType
- a request transaction genus type RequestTransaction
listNullArgumentException
-
requestTransactionGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsByRecordType(Type requestTransactionRecordType) throws OperationFailedException, PermissionDeniedException
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.requestTransactionRecordType
- a request transaction record type RequestTransaction
listNullArgumentException
-
requestTransactionRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsByRequest(Id requestId) throws OperationFailedException, PermissionDeniedException
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.requestId
- a request Id
RequestTransaction
listNullArgumentException
- requestId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.from
- start of date rangeto
- end of date range RequestTransaction
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsForSubmitter(Id resourceId) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
RequestTransaction
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsForSubmitterOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
from
- start of date rangeto
- end of date range RequestTransaction
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsForBroker(Id brokerId) throws OperationFailedException, PermissionDeniedException
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.brokerId
- a broker Id
RequestTransaction
listNullArgumentException
- brokerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsForBrokerOnDate(Id brokerId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
brokerId
- a broker Id
from
- start of date rangeto
- end of date range RequestTransaction
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- brokerId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsForSubmitterAndBroker(Id resourceId, Id brokerId) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
brokerId
- a broker Id
RequestTransaction
listNullArgumentException
- resourceId
or
brokerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactionsForSubmitterAndBrokerOnDate(Id resourceId, Id brokerId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
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.resourceId
- a resource Id
brokerId
- a broker Id
from
- start of date rangeto
- end of date range RequestTransaction
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, brokerId,
from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequestTransactionList getRequestTransactions() throws OperationFailedException, PermissionDeniedException
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. RequestTransaction
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.