org.osid.resourcing.batch

Interface ResourcingBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidManager, OsidProfile, ResourcingBatchProfile, Sourceable

public interface ResourcingBatchManager
extends OsidManager, ResourcingBatchProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
AvailabilityBatchAdminSession	getAvailabilityBatchAdminSession() Gets the OsidSession associated with the bulk availability administration service.
AvailabilityBatchAdminSession	getAvailabilityBatchAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the bulk availability administration service for the given foundry.
CommissionBatchAdminSession	getCommissionBatchAdminSession() Gets the OsidSession associated with the bulk commission administration service.
CommissionBatchAdminSession	getCommissionBatchAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the bulk commission administration service for the given foundry.
CompetencyBatchAdminSession	getCompetencyBatchAdminSession() Gets the OsidSession associated with the bulk competency administration service.
CompetencyBatchAdminSession	getCompetencyBatchAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the bulk competency administration service for the given foundry.
EffortBatchAdminSession	getEffortBatchAdminSession() Gets the OsidSession associated with the bulk effort administration service.
EffortBatchAdminSession	getEffortBatchAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the bulk effort administration service for the given foundry.
FoundryBatchAdminSession	getFoundryBatchAdminSession() Gets the OsidSession associated with the bulk foundry administration service.
JobBatchAdminSession	getJobBatchAdminSession() Gets the OsidSession associated with the bulk job administration service.
JobBatchAdminSession	getJobBatchAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the bulk job administration service for the given foundry.
WorkBatchAdminSession	getWorkBatchAdminSession() Gets the OsidSession associated with the bulk work administration service.
WorkBatchAdminSession	getWorkBatchAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the bulk work administration service for the given foundry.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.resourcing.batch.ResourcingBatchProfile

supportsAvailabilityBatchAdmin, supportsCommissionBatchAdmin, supportsCompetencyBatchAdmin, supportsEffortBatchAdmin, supportsFoundryBatchAdmin, supportsJobBatchAdmin, supportsVisibleFederation, supportsWorkBatchAdmin

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getJobBatchAdminSession

JobBatchAdminSession getJobBatchAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the bulk job administration service.

Returns:

a JobBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJobBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsJobBatchAdmin() is true.

getJobBatchAdminSessionForFoundry

JobBatchAdminSession getJobBatchAdminSessionForFoundry(Id foundryId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

a JobBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsJobBatchAdmin() and supportsVisibleFederation() are true

getWorkBatchAdminSession

WorkBatchAdminSession getWorkBatchAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk work administration service.

Returns:

a WorkBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsWorkBatchAdmin() is true.

getWorkBatchAdminSessionForFoundry

WorkBatchAdminSession getWorkBatchAdminSessionForFoundry(Id foundryId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

a WorkBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsWorkBatchAdmin() and supportsVisibleFederation() are true

getCompetencyBatchAdminSession

CompetencyBatchAdminSession getCompetencyBatchAdminSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk competency administration service.

Returns:

a CompetencyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsCompetencyBatchAdmin() is true.

getCompetencyBatchAdminSessionForFoundry

CompetencyBatchAdminSession getCompetencyBatchAdminSessionForFoundry(Id foundryId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

a CompetencyBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCompetencyBatchAdmin() and supportsVisibleFederation() are true

getAvailabilityBatchAdminSession

AvailabilityBatchAdminSession getAvailabilityBatchAdminSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk availability administration service.

Returns:

an AvailabilityBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsAvailabilityBatchAdmin() is true.

getAvailabilityBatchAdminSessionForFoundry

AvailabilityBatchAdminSession getAvailabilityBatchAdminSessionForFoundry(Id foundryId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

an AvailabilityBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAvailabilityBatchAdmin() and supportsVisibleFederation() are true

getCommissionBatchAdminSession

CommissionBatchAdminSession getCommissionBatchAdminSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk commission administration service.

Returns:

a CommissionBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsCommissionBatchAdmin() is true.

getCommissionBatchAdminSessionForFoundry

CommissionBatchAdminSession getCommissionBatchAdminSessionForFoundry(Id foundryId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

a CommissionBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCommissionBatchAdmin() and supportsVisibleFederation() are true

getEffortBatchAdminSession

EffortBatchAdminSession getEffortBatchAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk effort administration service.

Returns:

an EffortBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsEffortBatchAdmin() is true.

getEffortBatchAdminSessionForFoundry

EffortBatchAdminSession getEffortBatchAdminSessionForFoundry(Id foundryId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

an EffortBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsEffortBatchAdmin() and supportsVisibleFederation() are true

getFoundryBatchAdminSession

FoundryBatchAdminSession getFoundryBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk foundry administration service.

Returns:

a FoundryBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsFoundryBatchAdmin() is true.