public interface MyHoldSession extends OsidSession
This session defines methods for retrieving holds pertaining to the authenticated agent.
This lookup session defines several views:
The methods useFederatedOublietteView()
and
useIsolatedOublietteView()
behave as a radio group and one should
be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupMyHolds()
Tests if this user can perform
Hold lookups. |
HoldList |
getMyHolds()
Gets all the holds associated with the authenticated agent.
|
HoldList |
getMyHoldsForBlock(Id blockId)
Gets all the holds associated with the authenticated agent for the
given block.
|
HoldList |
getMyHoldsForIssue(Id issueId)
Gets all the holds associated with the authenticated agent for the
given issue.
|
Oubliette |
getOubliette()
Gets the
Oubliette associated with this session. |
Id |
getOublietteId()
Gets the
Oubliette Id associated with
this session. |
void |
useAnyEffectiveWorkView()
All availabilities, commissions and efforts of any effective dates are
returned by methods in this session.
|
void |
useEffectiveWorkView()
Only availabilities, commissions and efforts whose effective dates are
current are returned by methods in this session.
|
void |
useFederatedOublietteView()
Federates the view for methods in this session.
|
void |
useIsolatedOublietteView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteId()
Oubliette
Id
associated with
this session. Oubliette Id
associated with this sessionmandatory
- This method must be implemented. Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
Oubliette
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupMyHolds()
Hold
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 useFederatedOublietteView()
mandatory
- This method is must be implemented. void useIsolatedOublietteView()
mandatory
- This method is must be implemented. void useEffectiveWorkView()
mandatory
- This method is must be implemented. void useAnyEffectiveWorkView()
mandatory
- This method is must be implemented. HoldList getMyHolds() throws OperationFailedException, PermissionDeniedException
HoldList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldList getMyHoldsForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
issueId
- an issue Id
Hold
listNullArgumentException
- issueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. HoldList getMyHoldsForBlock(Id blockId) throws OperationFailedException, PermissionDeniedException
blockId
- a block Id
Hold
listNullArgumentException
- blockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.