Interface ResourcingBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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

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

close

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 OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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