OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.MyWorkSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving work for the resource related to the authenticated agent.

This lookup session defines several views:

  • effective work view: All lookup methods return availabilities, efforts and commissions where the current date falls in between the effective dates inclusive.
  • any effective work view: Availabilities, efforts and commissions of any effective date are returned from methods.
MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupMyWork
Description

Tests if this user can perform 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseEffectiveWorkView
Description

Only availabilities, commissions and efforts whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveWorkView
Description

All availabilities, commissions and efforts of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetMyAvailabilities
Description

Gets the availabilities for the resource related to this agent.

Returnosid.resourcing.AvailabilityListthe returned AvailabilityList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyCommissions
Description

Gets the commissions for the resource related to this agent.

Returnosid.resourcing.CommissionListthe returned Commission list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyEfforts
Description

Gets the efforts for the resource related to this agent.

Returnosid.resourcing.EffortListthe returned Effort list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetMyJobs
Description

Gets the jobs for the resource related to this agent.

Returnosid.resourcing.JobListthe returned Job list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.