org.osid.resourcing.batch

Interface ResourcingBatchProxyManager

All Superinterfaces:

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

public interface ResourcingBatchProxyManager
extends OsidProxyManager, ResourcingBatchProfile

The resourcing batch proxy manager provides access to resourcing batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. 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(Proxy proxy) Gets the OsidSession associated with the bulk availability administration service.
AvailabilityBatchAdminSession	getAvailabilityBatchAdminSessionForFoundry(Id foundryId, Proxy proxy) Gets the OsidSession associated with the bulk availability administration service for the given foundry.
CommissionBatchAdminSession	getCommissionBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk commission administration service.
CommissionBatchAdminSession	getCommissionBatchAdminSessionForFoundry(Id foundryId, Proxy proxy) Gets the OsidSession associated with the bulk commission administration service for the given foundry.
CompetencyBatchAdminSession	getCompetencyBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk competency administration service.
CompetencyBatchAdminSession	getCompetencyBatchAdminSessionForFoundry(Id foundryId, Proxy proxy) Gets the OsidSession associated with the bulk competency administration service for the given foundry.
EffortBatchAdminSession	getEffortBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk effort administration service.
EffortBatchAdminSession	getEffortBatchAdminSessionForFoundry(Id foundryId, Proxy proxy) Gets the OsidSession associated with the bulk effort administration service for the given foundry.
FoundryBatchAdminSession	getFoundryBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk foundry administration service.
JobBatchAdminSession	getJobBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk job administration service.
JobBatchAdminSession	getJobBatchAdminSessionForFoundry(Id foundryId, Proxy proxy) Gets the OsidSession associated with the bulk job administration service for the given foundry.
WorkBatchAdminSession	getWorkBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk work administration service.
WorkBatchAdminSession	getWorkBatchAdminSessionForFoundry(Id foundryId, Proxy proxy) Gets the OsidSession associated with the bulk work administration service for the given foundry.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the bulk job administration service.

Parameters:

proxy - a proxy

Returns:

a JobBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a JobBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy 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(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the bulk work administration service.

Parameters:

proxy - a proxy

Returns:

a WorkBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a WorkBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy 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(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk competency administration service.

Parameters:

proxy - a proxy

Returns:

a CompetencyBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CompetencyBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy 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(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the bulk availability administration service.

Parameters:

proxy - a proxy

Returns:

an AvailabilityBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                       Proxy proxy)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an AvailabilityBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy 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(Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the bulk commission administration service.

Parameters:

proxy - a proxy

Returns:

a CommissionBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CommissionBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy 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(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk effort administration service.

Parameters:

proxy - a proxy

Returns:

an EffortBatchAdminSession

Throws:

NullArgumentException - proxy is null

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,
                                                           Proxy proxy)
                                                             throws NotFoundException,
                                                                    OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an EffortBatchAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy 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(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk foundry administration service.

Parameters:

proxy - a proxy

Returns:

a FoundryBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryBatchAdmin() is false

Compliance:

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