public interface MyWorkSession extends OsidSession
This session defines methods for retrieving work for the resource related to the authenticated agent.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupMyWork()
Tests if this user can perform
Availability lookups. |
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
AvailabilityList |
getMyAvailabilities()
Gets the availabilities for the resource related to this agent.
|
CommissionList |
getMyCommissions()
Gets the commissions for the resource related to this agent.
|
EffortList |
getMyEfforts()
Gets the efforts for the resource related to this agent.
|
JobList |
getMyJobs()
Gets the jobs for the resource related to this agent.
|
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupMyWork()
Availability
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 useEffectiveWorkView()
mandatory
- This method is must be implemented. void useAnyEffectiveWorkView()
mandatory
- This method is must be implemented. AvailabilityList getMyAvailabilities() throws OperationFailedException, PermissionDeniedException
AvailabilityList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommissionList getMyCommissions() throws OperationFailedException, PermissionDeniedException
Commission
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EffortList getMyEfforts() throws OperationFailedException, PermissionDeniedException
Effort
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. JobList getMyJobs() throws OperationFailedException, PermissionDeniedException
Job
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.