Interface ResourcingBatchManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface ResourcingBatchProfile

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

Modifier and Type	Method	Description
boolean	supportsAvailabilityBatchAdmin()	Tests if bulk administration of availabilities is available.
boolean	supportsCommissionBatchAdmin()	Tests if bulk administration of commissions is available.
boolean	supportsCompetencyBatchAdmin()	Tests if bulk administration of competencies is available.
boolean	supportsEffortBatchAdmin()	Tests if bulk administration of efforts is available.
boolean	supportsFoundryBatchAdmin()	Tests if bulk administration of foundries is available.
boolean	supportsJobBatchAdmin()	Tests if bulk administration of jobs is available.
boolean	supportsVisibleFederation()	Tests if federation is visible.
boolean	supportsWorkBatchAdmin()	Tests if bulk administration of works is available.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsJobBatchAdmin()} is {@code 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 {@code supportsJobBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsWorkBatchAdmin()} is {@code 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 {@code supportsWorkBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCompetencyBatchAdmin()} is {@code 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 {@code supportsCompetencyBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsAvailabilityBatchAdmin()} is {@code 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 {@code supportsAvailabilityBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsCommissionBatchAdmin()} is {@code 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 {@code supportsCommissionBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsEffortBatchAdmin()} is {@code 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 {@code supportsEffortBatchAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsFoundryBatchAdmin()} is {@code true} .