public interface PriceScheduleLookupSession extends OsidSession
This session provides methods for retrieving PriceSchedule
objects. The PriceSchedule
represents a collection
of prices.
This session defines views that offer differing behaviors when retrieving multiple objects.
PriceScheduleAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupPriceSchedules()
Tests if this user can perform
Price lookups. |
PriceSchedule |
getPriceSchedule(Id priceScheduleId)
Gets the
PriceSchedule specified by its Id. |
PriceSchedule |
getPriceScheduleByPrice(Id priceId)
Gets the
PriceSchedule by a Price
Id. |
PriceScheduleList |
getPriceSchedules()
Gets all
PriceSchedules. |
PriceScheduleList |
getPriceSchedulesByGenusType(Type priceScheduleGenusType)
Gets a
PriceScheduleList corresponding to the given
price schedule genus Type which does not include price
schedules of genus types derived from the specified Type. |
PriceScheduleList |
getPriceSchedulesByIds(IdList priceScheduleIds)
Gets a
PriceScheduleList corresponding to the given
IdList. |
PriceScheduleList |
getPriceSchedulesByParentGenusType(Type priceScheduleGenusType)
Gets a
PriceScheduleList corresponding to the given
price schedule genus Type and include any additional
price schedules with genus types derived from the specified
Type. |
PriceScheduleList |
getPriceSchedulesByRecordType(Type priceScheduleRecordType)
Gets a
PriceScheduleList containing the given
repository record Type. |
Store |
getStore()
Gets the
Store associated with this session. |
Id |
getStoreId()
Gets the
Store Id associated with this
session. |
void |
useComparativePriceScheduleView()
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 |
useFederatedStoreView()
Federates the view for methods in this session.
|
void |
useIsolatedStoreView()
Isolates the view for methods in this session.
|
void |
usePlenaryPriceScheduleView()
A complete view of the
PriceSchedule returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getStoreId()
Store
Id
associated with this
session. Store Id
associated with this sessionmandatory
- This method must be implemented. Store getStore() throws OperationFailedException, PermissionDeniedException
Store
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupPriceSchedules()
Price
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. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativePriceScheduleView()
mandatory
- This method is must be implemented. void usePlenaryPriceScheduleView()
PriceSchedule
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 useFederatedStoreView()
mandatory
- This method is must be implemented. void useIsolatedStoreView()
mandatory
- This method is must be implemented. PriceSchedule getPriceSchedule(Id priceScheduleId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceSchedule
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned
PriceSchedule
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a PriceSchedule
and retained for
compatibility.priceScheduleId
- Id
of the PriceSchedule
NotFoundException
- priceScheduleId
not
foundNullArgumentException
- priceScheduleId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. PriceSchedule getPriceScheduleByPrice(Id priceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceSchedule
by a Price
Id.
priceId
- Id
of a Price
NotFoundException
- priceId
not foundNullArgumentException
- priceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. PriceScheduleList getPriceSchedulesByIds(IdList priceScheduleIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
PriceScheduleList
corresponding to the given
IdList.
In plenary mode, the returned list contains all
of the price schedules 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 PriceSchedules
may be omitted
from the list and may present the elements in any order including
returning a unique set.priceScheduleIds
- the list of Ids
to retrieve PriceSchedule
listNotFoundException
- an Id
was not foundNullArgumentException
- priceScheduleIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceScheduleList getPriceSchedulesByGenusType(Type priceScheduleGenusType) throws OperationFailedException, PermissionDeniedException
PriceScheduleList
corresponding to the given
price schedule genus Type
which does not include price
schedules of genus types derived from the specified Type.
In plenary mode, the returned list contains all known price
schedules or an error results. Otherwise, the returned list may
contain only those price schedules that are accessible through this
session.priceScheduleGenusType
- a price schedule genus type PriceSchedule
listNullArgumentException
- priceScheduleGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceScheduleList getPriceSchedulesByParentGenusType(Type priceScheduleGenusType) throws OperationFailedException, PermissionDeniedException
PriceScheduleList
corresponding to the given
price schedule genus Type
and include any additional
price schedules with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
price schedules or an error results. Otherwise, the returned list may
contain only those price schedules that are accessible through this
session.priceScheduleGenusType
- a price schedule genus type PriceSchedule
listNullArgumentException
- priceScheduleGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceScheduleList getPriceSchedulesByRecordType(Type priceScheduleRecordType) throws OperationFailedException, PermissionDeniedException
PriceScheduleList
containing the given
repository record Type.
In plenary mode, the returned
list contains all known price schedules or an error results.
Otherwise, the returned list may contain only those price schedules
that are accessible through this session.priceScheduleRecordType
- a price schedule record type PriceSchedule
listNullArgumentException
- priceScheduleRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PriceScheduleList getPriceSchedules() throws OperationFailedException, PermissionDeniedException
PriceSchedules.
In plenary mode, the returned
list contains all known price schedules or an error results.
Otherwise, the returned list may contain only those price schedules
that are accessible through this session. PriceSchedules
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.