public interface MySupplierSession extends OsidSession
This session defines methods for retrieving provisions supplied by the resource related to the authenticated agent.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupMyProvisions()
Tests if this user can perform
Provisions lookups. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
PoolList |
getMyPools()
Gets all the pools in which the resource related to the authenticated
agent is a part.
|
ProvisionableList |
getMyProvisionables()
Gets all the provisionables in which the resource related to the
authenticated agent.
|
ProvisionList |
getMyProvisions()
Gets the provisions for the resource related to this agent.
|
void |
useAnyEffectiveProvisionView()
All provisionables requests and pools of any effective dates are
returned by methods in this session.
|
void |
useEffectiveProvisionView()
Only provisionables requests and pools whose effective dates are
current are returned by methods in this session.
|
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 canLookupMyProvisions()
Provisions
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 useEffectiveProvisionView()
mandatory
- This method is must be implemented. void useAnyEffectiveProvisionView()
mandatory
- This method is must be implemented. ProvisionList getMyProvisions() throws OperationFailedException, PermissionDeniedException
ProvisionList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PoolList getMyPools() throws OperationFailedException, PermissionDeniedException
Pool
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProvisionableList getMyProvisionables() throws OperationFailedException, PermissionDeniedException
Provisionable
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.