OSID Logo
OSID Specifications
resourcing batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.batch.ResourcingBatchManager
Implementsosid.OsidManager
osid.resourcing.batch.ResourcingBatchProfile
Description

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

  • JobBatchAdminSession: a session to create, modify and delete jobs in bulk
  • WorkBatchAdminSession: a session to create, modify and delete works in bulk
  • CompetencyBatchAdminSession: a session to create, modify and delete competencies in bulk
  • AvailabilityBatchAdminSession: a session to create, modify and delete availabilities in bulk
  • CommissionBatchSession: a session to create, modify and delete commissions in bulk
  • EffortBatchAdminSession: a session to create, modify and delete efforts in bulk
  • FoundryBatchAdminSession: a session to create, modify and delete foundries in bulk
MethodgetJobBatchAdminSession
Description

Gets the OsidSession associated with the bulk job administration service.

Returnosid.resourcing.batch.JobBatchAdminSessiona JobBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJobBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsJobBatchAdmin() is true.
MethodgetJobBatchAdminSessionForFoundry
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.batch.JobBatchAdminSessiona JobBatchAdminSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsJobBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsJobBatchAdmin() and supportsVisibleFederation() are true
MethodgetWorkBatchAdminSession
Description

Gets the OsidSession associated with the bulk work administration service.

Returnosid.resourcing.batch.WorkBatchAdminSessiona WorkBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsWorkBatchAdmin() is true.
MethodgetWorkBatchAdminSessionForFoundry
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.batch.WorkBatchAdminSessiona WorkBatchAdminSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsWorkBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsWorkBatchAdmin() and supportsVisibleFederation() are true
MethodgetCompetencyBatchAdminSession
Description

Gets the OsidSession associated with the bulk competency administration service.

Returnosid.resourcing.batch.CompetencyBatchAdminSessiona CompetencyBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompetencyBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyBatchAdmin() is true.
MethodgetCompetencyBatchAdminSessionForFoundry
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.batch.CompetencyBatchAdminSessiona CompetencyBatchAdminSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCompetencyBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCompetencyBatchAdmin() and supportsVisibleFederation() are true
MethodgetAvailabilityBatchAdminSession
Description

Gets the OsidSession associated with the bulk availability administration service.

Returnosid.resourcing.batch.AvailabilityBatchAdminSessionan AvailabilityBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAvailabilityBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityBatchAdmin() is true.
MethodgetAvailabilityBatchAdminSessionForFoundry
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.batch.AvailabilityBatchAdminSessionan AvailabilityBatchAdminSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAvailabilityBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAvailabilityBatchAdmin() and supportsVisibleFederation() are true
MethodgetCommissionBatchAdminSession
Description

Gets the OsidSession associated with the bulk commission administration service.

Returnosid.resourcing.batch.CommissionBatchAdminSessiona CommissionBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommissionBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsCommissionBatchAdmin() is true.
MethodgetCommissionBatchAdminSessionForFoundry
Description

Gets the OsidSession associated with the bulk commission administration service for the given foundry.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.batch.CommissionBatchAdminSessiona CommissionBatchAdminSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsCommissionBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsCommissionBatchAdmin() and supportsVisibleFederation() are true
MethodgetEffortBatchAdminSession
Description

Gets the OsidSession associated with the bulk effort administration service.

Returnosid.resourcing.batch.EffortBatchAdminSessionan EffortBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEffortBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsEffortBatchAdmin() is true.
MethodgetEffortBatchAdminSessionForFoundry
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.resourcing.batch.EffortBatchAdminSessionan EffortBatchAdminSession
ErrorsNOT_FOUNDno Foundry found by the given Id
NULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsEffortBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsEffortBatchAdmin() and supportsVisibleFederation() are true
MethodgetFoundryBatchAdminSession
Description

Gets the OsidSession associated with the bulk foundry administration service.

Returnosid.resourcing.batch.FoundryBatchAdminSessiona FoundryBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFoundryBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFoundryBatchAdmin() is true.