OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Interfaceosid.resourcing.ResourcingManager
Implementsosid.OsidManager
osid.resourcing.ResourcingProfile
Used Byosid.orchestration.OrchestrationManager
Description

The resourcing manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • MyWorkSession : a session for looking up availability and commissions for the authenticated agent
  • JobLookupSession : a session to retrieve jobs
  • JobQuerySession : a session to query for jobs
  • JobSearchSession : a session to search for jobs
  • JobAdminSession : a session to create and delete jobs
  • JobNotificationSession : a session to receive notifications pertaining to job changes
  • JobFoundrySession : a session to looking mappings of jobs to foundries
  • JobFoundryAssignmentSession : a session to manage job to foundry mappings
  • JobSmartFoundrySession : a session to manage dynamic foundries of jobs
  • JobResourcingSession : a session to manage job resources
  • WorkLookupSession : a session to retrieve work
  • WorkQuerySession : a session to query for work
  • WorkSearchSession : a session to search for work
  • WorkAdminSession : a session to create and delete work
  • WorkNotificationSession : a session to receive notifications pertaining to work changes
  • WorkFoundrySession : a session to look up work foundry mappings
  • WorkFoundryAssignmentSession : a session to manage availability to foundry mappings
  • WorkSmartFoundrySession : a session to manage dynamic foundries of work
  • CompetencyLookupSession : a session to retrieve competencies
  • CompetencyQuerySession : a session to query for competencies
  • CompetencySearchSession : a session to search for competencies
  • CompetencyAdminSession : a session to create and delete competencies
  • CompetencyNotificationSession : a session to receive notifications pertaining to competency changes
  • CompetencyFoundrySession : a session to look up competency foundry mappings
  • CompetencyFoundryAssignmentSession : a session to manage competency to foundry mappings
  • CompetencySmartFoundrySession : a session to manage dynamic foundries of competencies
  • AvailabilityLookupSession : a session to retrieve availabilities
  • AvailabilityQuerySession : a session to query for availabilities
  • AvailabilitySearchSession : a session to search for availabilities
  • AvailabilityAdminSession : a session to create and delete availabilities
  • AvailabilityNotificationSession : a session to receive notifications pertaining to availability changes
  • AvailabilityFoundrySession : a session to look up availability foundry mappings
  • AvailabilityFoundryAssignmentSession : a session to manage availability to foundry mappings
  • AvailabilitySmartFoundrySession : a session to manage dynamic foundries of availabilities
  • CommissionLookupSession : a session to retrieve commissions
  • CommissionQuerySession : a session to query for commissions
  • CommissionSearchSession : a session to search for commissions
  • CommissionAdminSession : a session to create and delete commissions
  • CommissionNotificationSession : a session to receive notifications pertaining to commission changes
  • CommissionFoundrySession : a session to look up commission foundry mappings
  • CommissionFoundryAssignmentSession : a session to manage commission to foundry mappings
  • CommissionSmartFoundrySession : a session to manage dynamic foundries of commissions
  • EffortLookupSession : a session to retrieve efforts
  • EffortQuerySession : a session to query for efforts
  • EffortSearchSession : a session to search for efforts
  • EffortAdminSession : a session to create and delete efforts
  • EffortNotificationSession : a session to receive notifications pertaining to effort changes
  • EffortFoundrySession : a session to look up effort foundry mappings
  • EffortFoundryAssignmentSession : a session to manage efforts to foundry mappings
  • EffortSmartFoundrySession : a session to manage dynamic foundries of effortss
  • FoundryLookupSession : a session to retrieve foundries
  • FoundryQuerySession : a session to search for foundries
  • FoundrySearchSession : a session to search for foundries
  • FoundryAdminSession : a session to create and delete foundries
  • FoundryNotificationSession : a session to receive notifications pertaining to foundry changes
  • FoundryHierarchySession : a session to traverse a hierarchy of foundry
  • FoundryHierarchyDesignSession : a session to manage a foundry hierarchy
MethodgetMyWorkSession
Description

Gets the OsidSession associated with the my work service.

Returnosid.resourcing.MyWorkSessiona MyWorkSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsMyWork() is false
ComplianceoptionalThis method must be implemented if supportsMyWork() is true .
MethodgetMyWorkSessionForFoundry
Description

Gets the OsidSession associated with the my work service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the foundry
Returnosid.resourcing.MyWorkSessiona MyWorkSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsMyWork() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMyWork() and supportsVisibleFederation() are true
MethodgetJobLookupSession
Description

Gets the OsidSession associated with the job lookup service.

Returnosid.resourcing.JobLookupSessiona JobLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobLookup() is false
ComplianceoptionalThis method must be implemented if supportsJobLookup() is true .
MethodgetJobLookupSessionForFoundry
Description

Gets the OsidSession associated with the job lookup service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.JobLookupSessiona JobLookupSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJobLookup() and supportsVisibleFederation() are true
MethodgetJobQuerySession
Description

Gets the OsidSession associated with the job query service.

Returnosid.resourcing.JobQuerySessiona JobQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobQuery() is false
ComplianceoptionalThis method must be implemented if supportsJobQuery() is true .
MethodgetJobQuerySessionForFoundry
Description

Gets the OsidSession associated with the job query service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.JobQuerySessiona JobQuerySession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJobQuery() and supportsVisibleFederation() are true
MethodgetJobSearchSession
Description

Gets the OsidSession associated with the job search service.

Returnosid.resourcing.JobSearchSessiona JobSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobSearch() is false
ComplianceoptionalThis method must be implemented if supportsJobSearch() is true .
MethodgetJobSearchSessionForFoundry
Description

Gets the OsidSession associated with the job search service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.JobSearchSessiona JobSearchSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJobSearch() and supportsVisibleFederation() are true
MethodgetJobAdminSession
Description

Gets the OsidSession associated with the job administration service.

Returnosid.resourcing.JobAdminSessiona JobAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobAdmin() is false
ComplianceoptionalThis method must be implemented if supportsJobAdmin() is true .
MethodgetJobAdminSessionForFoundry
Description

Gets the OsidSession associated with the job administration service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.JobAdminSessiona JobAdminSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJobAdmin() and supportsVisibleFederation() are true
MethodgetJobNotificationSession
Description

Gets the OsidSession associated with the job notification service.

Parametersosid.resourcing.JobReceiverjobReceiverthe notification callback
Returnosid.resourcing.JobNotificationSessiona JobNotificationSession
ErrorsNULL_ARGUMENTjobReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobNotification() is false
ComplianceoptionalThis method must be implemented if supportsJobNotification() is true .
MethodgetJobNotificationSessionForFoundry
Description

Gets the OsidSession associated with the job notification service for the given foundry.

Parametersosid.resourcing.JobReceiverjobReceiverthe notification callback
osid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.JobNotificationSessiona JobNotificationSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTjobReceiver or foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJobNotification() and supportsVisibleFederation() are true
MethodgetJobFoundrySession
Description

Gets the OsidSession to lookup job/foundry mappings.

Returnosid.resourcing.JobFoundrySessiona JobFoundrySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobFoundry() is false
ComplianceoptionalThis method must be implemented if supportsJobFoundry() is true .
MethodgetJobFoundryAssignmentSession
Description

Gets the OsidSession associated with assigning jobs to foundries.

Returnosid.resourcing.JobFoundryAssignmentSessiona JobFoundryAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobFoundryAssignment() is false
ComplianceoptionalThis method must be implemented if supportsJobFoundryAssignment() is true .
MethodgetJobSmartFoundrySession
Description

Gets the OsidSession to manage job smart foundries.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.JobSmartFoundrySessiona JobSmartFoundrySession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsJobSmartFoundry() is false
ComplianceoptionalThis method must be implemented if supportsJobSmartFoundry() is true .
MethodgetWorkLookupSession
Description

Gets the OsidSession associated with the work lookup service.

Returnosid.resourcing.WorkLookupSessiona WorkLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkLookup() is false
ComplianceoptionalThis method must be implemented if supportsWorkLookup() is true .
MethodgetWorkLookupSessionForFoundry
Description

Gets the OsidSession associated with the work lookup service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.WorkLookupSessiona WorkLookupSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkLookup() and supportsVisibleFederation() are true
MethodgetWorkQuerySession
Description

Gets the OsidSession associated with the work query service.

Returnosid.resourcing.WorkQuerySessiona WorkQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkQuery() is false
ComplianceoptionalThis method must be implemented if supportsWorkQuery() is true .
MethodgetWorkQuerySessionForFoundry
Description

Gets the OsidSession associated with the work query service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.WorkQuerySessiona WorkQuerySession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkQuery() and supportsVisibleFederation() are true
MethodgetWorkSearchSession
Description

Gets the OsidSession associated with the work search service.

Returnosid.resourcing.WorkSearchSessiona WorkSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkSearch() is false
ComplianceoptionalThis method must be implemented if supportsWorkSearch() is true .
MethodgetWorkSearchSessionForFoundry
Description

Gets the OsidSession associated with the work search service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.WorkSearchSessiona WorkSearchSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkSearch() and supportsVisibleFederation() are true
MethodgetWorkAdminSession
Description

Gets the OsidSession associated with the work administration service.

Returnosid.resourcing.WorkAdminSessiona WorkAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkAdmin() is false
ComplianceoptionalThis method must be implemented if supportsWorkAdmin() is true .
MethodgetWorkAdminSessionForFoundry
Description

Gets the OsidSession associated with the work administration service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.WorkAdminSessiona WorkAdminSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkAdmin() and supportsVisibleFederation() are true
MethodgetWorkNotificationSession
Description

Gets the OsidSession associated with the work notification service.

Parametersosid.resourcing.WorkReceiverworkReceiverthe notification callback
Returnosid.resourcing.WorkNotificationSessiona WorkNotificationSession
ErrorsNULL_ARGUMENTworkReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkNotification() is false
ComplianceoptionalThis method must be implemented if supportsWorkNotification() is true .
MethodgetWorkNotificationSessionForFoundry
Description

Gets the OsidSession associated with the work notification service for the given foundry.

Parametersosid.resourcing.WorkReceiverworkReceiverthe notification callback
osid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.WorkNotificationSessiona WorkNotificationSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTworkReceiver or foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkNotification() and supportsVisibleFederation() are true
MethodgetWorkFoundrySession
Description

Gets the OsidSession to lookup work/foundry mappings.

Returnosid.resourcing.WorkFoundrySessiona WorkFoundrySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkFoundry() is false
ComplianceoptionalThis method must be implemented if supportsWorkFoundry() is true .
MethodgetWorkFoundryAssignmentSession
Description

Gets the OsidSession associated with assigning work to foundries.

Returnosid.resourcing.WorkFoundryAssignmentSessiona WorkFoundryAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkbFoundryAssignment() is false
ComplianceoptionalThis method must be implemented if supportsWorkFoundryAssignment() is true .
MethodgetWorkSmartFoundrySession
Description

Gets the OsidSession to manage work smart foundries.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.WorkSmartFoundrySessiona WorkSmartFoundrySession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsWorkSmartFoundry() is false
ComplianceoptionalThis method must be implemented if supportsWorkSmartFoundry() is true .
MethodgetCompetencyLookupSession
Description

Gets the OsidSession associated with the competency lookup service.

Returnosid.resourcing.CompetencyLookupSessiona CompetencyLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyLookup() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyLookup() is true .
MethodgetCompetencyLookupSessionForFoundry
Description

Gets the OsidSession associated with the competency lookup service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CompetencyLookupSessiona CompetencyLookupSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyLookup() and supportsVisibleFederation() are true
MethodgetCompetencyQuerySession
Description

Gets the OsidSession associated with the competency query service.

Returnosid.resourcing.CompetencyQuerySessiona CompetencyQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyQuery() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyQuery() is true .
MethodgetCompetencyQuerySessionForFoundry
Description

Gets the OsidSession associated with the competency query service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CompetencyQuerySessiona CompetencyQuerySession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyQuery() and supportsVisibleFederation() are true
MethodgetCompetencySearchSession
Description

Gets the OsidSession associated with the competency search service.

Returnosid.resourcing.CompetencySearchSessiona CompetencySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencySearch() is false
ComplianceoptionalThis method must be implemented if supportsCompetencySearch() is true .
MethodgetCompetencySearchSessionForFoundry
Description

Gets the OsidSession associated with the competency search service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CompetencySearchSessiona CompetencySearchSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompetencySearch() and supportsVisibleFederation() are true
MethodgetCompetencyAdminSession
Description

Gets the OsidSession associated with the competency administration service.

Returnosid.resourcing.CompetencyAdminSessiona CompetencyAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyAdmin() is true .
MethodgetCompetencyAdminSessionForFoundry
Description

Gets the OsidSession associated with the competency administration service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CompetencyAdminSessiona CompetencyAdminSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyAdmin() and supportsVisibleFederation() are true
MethodgetCompetencyNotificationSession
Description

Gets the OsidSession associated with the competency notification service.

Parametersosid.resourcing.CompetencyReceivercompetencyReceiverthe notification callback
Returnosid.resourcing.CompetencyNotificationSessiona CompetencyNotificationSession
ErrorsNULL_ARGUMENTcompetencyReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyNotification() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyNotification() is true .
MethodgetCompetencyNotificationSessionForFoundry
Description

Gets the OsidSession associated with the competency notification service for the given foundry.

Parametersosid.resourcing.CompetencyReceivercompetencyReceiverthe notification callback
osid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CompetencyNotificationSessiona CompetencyNotificationSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTcompetencyReceiver or foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyNotification() and supportsVisibleFederation() are true
MethodgetCompetencyFoundrySession
Description

Gets the OsidSession to lookup competency/foundry mappings.

Returnosid.resourcing.CompetencyFoundrySessiona CompetencyFoundrySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyFoundry() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyFoundry() is true .
MethodgetCompetencyFoundryAssignmentSession
Description

Gets the OsidSession associated with assigning competencies to foundries.

Returnosid.resourcing.CompetencyFoundryAssignmentSessiona CompetencyFoundryAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencyFoundryAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyFoundryAssignment() is true .
MethodgetCompetencySmartFoundrySession
Description

Gets the OsidSession to manage competency smart foundries.

Parametersosid.id.IdfoundryIdthe Id of the foundry
Returnosid.resourcing.CompetencySmartFoundrySessiona CompetencySmartFoundrySession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCompetencySmartFoundry() is false
ComplianceoptionalThis method must be implemented if supportsCompetencySmartFoundry() is true .
MethodgetAvailabilityLookupSession
Description

Gets the OsidSession associated with the availability lookup service.

Returnosid.resourcing.AvailabilityLookupSessionan AvailabilityLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityLookup() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityLookup() is true .
MethodgetAvailabilityLookupSessionForFoundry
Description

Gets the OsidSession associated with the availability lookup service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the foundry
Returnosid.resourcing.AvailabilityLookupSessionan AvailabilityLookupSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityLookup() and supportsVisibleFederation() are true
MethodgetAvailabilityQuerySession
Description

Gets the OsidSession associated with the availability query service.

Returnosid.resourcing.AvailabilityQuerySessionan AvailabilityQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityQuery() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityQuery() is true .
MethodgetAvailabilityQuerySessionForFoundry
Description

Gets the OsidSession associated with the availability query service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.AvailabilityQuerySessionan AvailabilityQuerySession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityQuery() and supportsVisibleFederation() are true
MethodgetAvailabilitySearchSession
Description

Gets the OsidSession associated with the availability search service.

Returnosid.resourcing.AvailabilitySearchSessionan AvailabilitySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilitySearch() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilitySearch() is true .
MethodgetAvailabilitySearchSessionForFoundry
Description

Gets the OsidSession associated with the availability search service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.AvailabilitySearchSessionan AvailabilitySearchSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilitySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilitySearch() and supportsVisibleFederation() are true
MethodgetAvailabilityAdminSession
Description

Gets the OsidSession associated with the availability administration service.

Returnosid.resourcing.AvailabilityAdminSessionan AvailabilityAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityAdmin() is true .
MethodgetAvailabilityAdminSessionForFoundry
Description

Gets the OsidSession associated with the availability administration service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.AvailabilityAdminSessionan AvailabilityAdminSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityAdmin() and supportsVisibleFederation() are true
MethodgetAvailabilityNotificationSession
Description

Gets the OsidSession associated with the availability notification service.

Parametersosid.resourcing.AvailabilityReceiveravailabilityReceiverthe notification callback
Returnosid.resourcing.AvailabilityNotificationSessionan AvailabilityNotificationSession
ErrorsNULL_ARGUMENTavailabilityReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityNotification() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityNotification() is true .
MethodgetAvailabilityNotificationSessionForFoundry
Description

Gets the OsidSession associated with the availability notification service for the given foundry.

Parametersosid.resourcing.AvailabilityReceiveravailabilityReceiverthe notification callback
osid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.AvailabilityNotificationSessionan AvailabilityNotificationSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTavailabilityReceiver or foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityNotification() and supportsVisibleFederation() are true
MethodgetAvailabilityFoundrySession
Description

Gets the OsidSession to lookup availability/foundry mappings.

Returnosid.resourcing.AvailabilityFoundrySessionan AvailabilityFoundrySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityFoundry() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityFoundry() is true .
MethodgetAvailabilityFoundryAssignmentSession
Description

Gets the OsidSession associated with assigning availabilities to foundries.

Returnosid.resourcing.AvailabilityFoundryAssignmentSessionan AvailabilityFoundryAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilityFoundryAssignment() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityFoundryAssignment() is true .
MethodgetAvailabilitySmartFoundrySession
Description

Gets the OsidSession to manage locatin smart foundries.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.AvailabilitySmartFoundrySessionan AvailabilitySmartFoundrySession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsAvailabilitySmartFoundry() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilitySmartFoundry() is true .
MethodgetCommissionLookupSession
Description

Gets the OsidSession associated with the commission lookup service.

Returnosid.resourcing.CommissionLookupSessiona CommissionLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionLookup() is false
ComplianceoptionalThis method must be implemented if supportsCommissionLookup() is true .
MethodgetCommissionLookupSessionForFoundry
Description

Gets the OsidSession associated with the commission lookup service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CommissionLookupSessiona CommissionLookupSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommissionLookup() and supportsVisibleFederation() are true
MethodgetCommissionQuerySession
Description

Gets the OsidSession associated with the commission query service.

Returnosid.resourcing.CommissionQuerySessiona CommissionQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionQuery() is false
ComplianceoptionalThis method must be implemented if supportsCommissionQuery() is true .
MethodgetCommissionQuerySessionForFoundry
Description

Gets the OsidSession associated with the commission query service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CommissionQuerySessiona CCommissionQuerySession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommissionQuery() and supportsVisibleFederation() are true
MethodgetCommissionSearchSession
Description

Gets the OsidSession associated with the commission search service.

Returnosid.resourcing.CommissionSearchSessiona CommissionSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionSearch() is false
ComplianceoptionalThis method must be implemented if supportsCommissionSearch() is true .
MethodgetCommissionSearchSessionForFoundry
Description

Gets the OsidSession associated with the commission search service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CommissionSearchSessiona CommissionSearchSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommissionSearch() and supportsVisibleFederation() are true
MethodgetCommissionAdminSession
Description

Gets the OsidSession associated with the commission administrative service.

Returnosid.resourcing.CommissionAdminSessiona CommissionAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCommissionAdmin() is true .
MethodgetCommissionAdminSessionForFoundry
Description

Gets the OsidSession associated with the commission administrative service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CommissionAdminSessiona CommissionAdminSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommissionAdmin() and supportsVisibleFederation() are true
MethodgetCommissionNotificationSession
Description

Gets the OsidSession associated with the commission notification service.

Parametersosid.resourcing.CommissionReceivercommissionReceiverthe notification callback
Returnosid.resourcing.CommissionNotificationSessiona CommissionNotificationSession
ErrorsNULL_ARGUMENTcommissionReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionNotification() is false
ComplianceoptionalThis method must be implemented if supportsCommissionNotification() is true .
MethodgetCommissionNotificationSessionForFoundry
Description

Gets the OsidSession associated with the commission notification service for the given foundry.

Parametersosid.resourcing.CommissionReceivercommissionReceiverthe notification callback
osid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CommissionNotificationSessiona CommissionNotificationSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTcommissionReceiver or foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommissionNotification() and supportsVisibleFederation() are true
MethodgetCommissionFoundrySession
Description

Gets the OsidSession to lookup commission/foundry mappings.

Returnosid.resourcing.CommissionFoundrySessiona CommissionFoundrySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionFoundry() is false
ComplianceoptionalThis method must be implemented if supportsCommissionyFoundry() is true .
MethodgetCommissionFoundryAssignmentSession
Description

Gets the OsidSession associated with assigning competencies to foundries.

Returnosid.resourcing.CommissionFoundryAssignmentSessiona CommissionyFoundryAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionFoundryAssignment() is false
ComplianceoptionalThis method must be implemented if supportsCommissionFoundryAssignment() is true .
MethodgetCommissionSmartFoundrySession
Description

Gets the OsidSession to manage commission smart foundries.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.CommissionSmartFoundrySessiona CommissionSmartFoundrySession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsCommissionSmartFoundry() is false
ComplianceoptionalThis method must be implemented if supportsCommissionSmartFoundry() is true .
MethodgetEffortLookupSession
Description

Gets the OsidSession associated with the effort lookup service.

Returnosid.resourcing.EffortLookupSessionan EffortLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortLookup() is false
ComplianceoptionalThis method must be implemented if supportsEffortLookup() is true .
MethodgetEffortLookupSessionForFoundry
Description

Gets the OsidSession associated with the effort lookup service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.EffortLookupSessionan EffortLookupSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEffortLookup() and supportsVisibleFederation() are true
MethodgetEffortQuerySession
Description

Gets the OsidSession associated with the effort query service.

Returnosid.resourcing.EffortQuerySessionan EffortQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortQuery() is false
ComplianceoptionalThis method must be implemented if supportsEffortQuery() is true .
MethodgetEffortQuerySessionForFoundry
Description

Gets the OsidSession associated with the effort query service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.EffortQuerySessionan EffortQuerySession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEffortQuery() and supportsVisibleFederation() are true
MethodgetEffortSearchSession
Description

Gets the OsidSession associated with the effort search service.

Returnosid.resourcing.EffortSearchSessionan EffortSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortSearch() is false
ComplianceoptionalThis method must be implemented if supportsEffortSearch() is true .
MethodgetEffortSearchSessionForFoundry
Description

Gets the OsidSession associated with the effort search service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.EffortSearchSessionan EffortSearchSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEffortSearch() and supportsVisibleFederation() are true
MethodgetEffortAdminSession
Description

Gets the OsidSession associated with the effort administration service.

Returnosid.resourcing.EffortAdminSessionan EffortAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEffortAdmin() is true .
MethodgetEffortAdminSessionForFoundry
Description

Gets the OsidSession associated with the effort administration service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.EffortAdminSessionan EffortAdminSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEffortAdmin() and supportsVisibleFederation() are true
MethodgetEffortNotificationSession
Description

Gets the OsidSession associated with the effort notification service.

Parametersosid.resourcing.EffortReceivereffortReceiverthe notification callback
Returnosid.resourcing.EffortNotificationSessionan EffortNotificationSession
ErrorsNULL_ARGUMENTeffortReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortNotification() is false
ComplianceoptionalThis method must be implemented if supportsEffortNotification() is true .
MethodgetEffortNotificationSessionForFoundry
Description

Gets the OsidSession associated with the effort notification service for the given foundry.

Parametersosid.resourcing.EffortReceivereffortReceiverthe notification callback
osid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.EffortNotificationSessionan EffortNotificationSession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTeffortReceiver or foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEffortNotification() and supportsVisibleFederation() are true
MethodgetEffortFoundrySession
Description

Gets the OsidSession to lookup effort/foundry mappings.

Returnosid.resourcing.EffortFoundrySessionan EffortFoundrySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortFoundry() is false
ComplianceoptionalThis method must be implemented if supportsEffortFoundry() is true .
MethodgetEffortFoundryAssignmentSession
Description

Gets the OsidSession associated with assigning efforts to foundries.

Returnosid.resourcing.EffortFoundryAssignmentSessionan EffortFoundryAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortFoundryAssignment() is false
ComplianceoptionalThis method must be implemented if supportsEffortFoundryAssignment() is true .
MethodgetEffortSmartFoundrySession
Description

Gets the OsidSession to manage effort smart foundries.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.EffortFoundrySessionan EffortSmartFoundrySession
ErrorsNOT_FOUNDno foundry found by the given Id
NULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsEffortSmartFoundry() is false
ComplianceoptionalThis method must be implemented if supportsEffortSmartFoundry() is true .
MethodgetFoundryLookupSession
Description

Gets the OsidSession associated with the foundry lookup service.

Returnosid.resourcing.FoundryLookupSessiona FoundryLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFoundryLookup() is false
ComplianceoptionalThis method must be implemented if supportsFoundryLookup() is true .
MethodgetFoundryQuerySession
Description

Gets the OsidSession associated with the foundry query service.

Returnosid.resourcing.FoundryQuerySessiona FoundryQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFoundryQuery() is false
ComplianceoptionalThis method must be implemented if supportsFoundryQuery() is true .
MethodgetFoundrySearchSession
Description

Gets the OsidSession associated with the foundry search service.

Returnosid.resourcing.FoundrySearchSessiona FoundrySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFoundrySearch() is false
ComplianceoptionalThis method must be implemented if supportsFoundrySearch() is true .
MethodgetFoundryAdminSession
Description

Gets the OsidSession associated with the foundry administrative service.

Returnosid.resourcing.FoundryAdminSessiona FoundryAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFoundryAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFoundryAdmin() is true .
MethodgetFoundryNotificationSession
Description

Gets the OsidSession associated with the foundry notification service.

Parametersosid.resourcing.FoundryReceiverfoundryReceiverthe notification callback
Returnosid.resourcing.FoundryNotificationSessiona FoundryNotificationSession
ErrorsNULL_ARGUMENTfoundryReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFoundryNotification() is false
ComplianceoptionalThis method must be implemented if supportsFoundryNotification() is true .
MethodgetFoundryHierarchySession
Description

Gets the OsidSession associated with the foundry hierarchy service.

Returnosid.resourcing.FoundryHierarchySessiona FoundryHierarchySession for foundries
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFoundryHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsFoundryHierarchy() is true .
MethodgetFoundryHierarchyDesignSession
Description

Gets the OsidSession associated with the foundry hierarchy design service.

Returnosid.resourcing.FoundryHierarchyDesignSessiona HierarchyDesignSession for foundries
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFoundryHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsFoundryHierarchyDesign() is true .
MethodgetResourcingBatchManager
Description

Gets the ResourcingBatchManager .

Returnosid.resourcing.batch.ResourcingBatchManagera ResourcingBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsResourcingBatch() is false
ComplianceoptionalThis method must be implemented if supportsResourcingBatch() is true .
MethodgetResourcingRulesManager
Description

Gets the ResourcingRulesManager .

Returnosid.resourcing.rules.ResourcingRulesManagera ResourcingRulesManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsResourcingRules() is false
ComplianceoptionalThis method must be implemented if supportsResourcingRules() is true .