org.osid.resourcing

Interface ResourcingManager

All Superinterfaces:

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

public interface ResourcingManager
extends OsidManager, ResourcingProfile

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

• MyWorkSession: a session for looking up availability and commissions for the authenticated agent
• JobLookupSession: a session to retrieve jobs
• JobQuerySession: a session to query for jobs
• JobSearchSession: a session to search for jobs
• JobAdminSession: a session to create and delete jobs
• JobNotificationSession: a session to receive notifications pertaining to job changes
• JobFoundrySession: a session to looking mappings of jobs to foundries
• JobFoundryAssignmentSession: a session to manage job to foundry mappings
• JobSmartFoundrySession: a session to manage dynamic foundries of jobs
• JobResourcingSession: a session to manage job resources

• WorkLookupSession: a session to retrieve work
• WorkQuerySession: a session to query for work
• WorkSearchSession: a session to search for work
• WorkAdminSession: a session to create and delete work
• WorkNotificationSession: a session to receive notifications pertaining to work changes
• WorkFoundrySession: a session to look up work foundry mappings
• WorkFoundryAssignmentSession: a session to manage availability to foundry mappings
• WorkSmartFoundrySession: a session to manage dynamic foundries of work

• CompetencyLookupSession: a session to retrieve competencies
• CompetencyQuerySession: a session to query for competencies
• CompetencySearchSession: a session to search for competencies
• CompetencyAdminSession: a session to create and delete competencies
• CompetencyNotificationSession: a session to receive notifications pertaining to competency changes
• CompetencyFoundrySession: a session to look up competency foundry mappings
• CompetencyFoundryAssignmentSession: a session to manage competency to foundry mappings
• CompetencySmartFoundrySession: a session to manage dynamic foundries of competencies

• AvailabilityLookupSession: a session to retrieve availabilities
• AvailabilityQuerySession: a session to query for availabilities
• AvailabilitySearchSession: a session to search for availabilities
• AvailabilityAdminSession: a session to create and delete availabilities
• AvailabilityNotificationSession: a session to receive notifications pertaining to availability changes
• AvailabilityFoundrySession: a session to look up availability foundry mappings
• AvailabilityFoundryAssignmentSession: a session to manage availability to foundry mappings
• AvailabilitySmartFoundrySession: a session to manage dynamic foundries of availabilities

• CommissionLookupSession: a session to retrieve commissions
• CommissionQuerySession: a session to query for commissions
• CommissionSearchSession: a session to search for commissions
• CommissionAdminSession: a session to create and delete commissions
• CommissionNotificationSession: a session to receive notifications pertaining to commission changes
• CommissionFoundrySession: a session to look up commission foundry mappings
• CommissionFoundryAssignmentSession: a session to manage commission to foundry mappings
• CommissionSmartFoundrySession: a session to manage dynamic foundries of commissions

• EffortLookupSession: a session to retrieve efforts
• EffortQuerySession: a session to query for efforts
• EffortSearchSession: a session to search for efforts
• EffortAdminSession: a session to create and delete efforts
• EffortNotificationSession: a session to receive notifications pertaining to effort changes
• EffortFoundrySession: a session to look up effort foundry mappings
• EffortFoundryAssignmentSession: a session to manage efforts to foundry mappings
• EffortSmartFoundrySession: a session to manage dynamic foundries of effortss

• FoundryLookupSession: a session to retrieve foundries
• FoundryQuerySession: a session to search for foundries
• FoundrySearchSession: a session to search for foundries
• FoundryAdminSession: a session to create and delete foundries
• FoundryNotificationSession: a session to receive notifications pertaining to foundry changes
• FoundryHierarchySession: a session to traverse a hierarchy of foundry
• FoundryHierarchyDesignSession: a session to manage a foundry hierarchy

Method Summary

Methods

Modifier and Type	Method and Description
AvailabilityAdminSession	getAvailabilityAdminSession() Gets the OsidSession associated with the availability administration service.
AvailabilityAdminSession	getAvailabilityAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the availability administration service for the given foundry.
AvailabilityFoundryAssignmentSession	getAvailabilityFoundryAssignmentSession() Gets the OsidSession associated with assigning availabilities to foundries.
AvailabilityFoundrySession	getAvailabilityFoundrySession() Gets the OsidSession to lookup availability/foundry mappings.
AvailabilityLookupSession	getAvailabilityLookupSession() Gets the OsidSession associated with the availability lookup service.
AvailabilityLookupSession	getAvailabilityLookupSessionForFoundry(Id foundryId) Gets the OsidSession associated with the availability lookup service for the given foundry.
AvailabilityNotificationSession	getAvailabilityNotificationSession(AvailabilityReceiver availabilityReceiver) Gets the OsidSession associated with the availability notification service.
AvailabilityNotificationSession	getAvailabilityNotificationSessionForFoundry(AvailabilityReceiver availabilityReceiver, Id foundryId) Gets the OsidSession associated with the availability notification service for the given foundry.
AvailabilityQuerySession	getAvailabilityQuerySession() Gets the OsidSession associated with the availability query service.
AvailabilityQuerySession	getAvailabilityQuerySessionForFoundry(Id foundryId) Gets the OsidSession associated with the availability query service for the given foundry.
AvailabilitySearchSession	getAvailabilitySearchSession() Gets the OsidSession associated with the availability search service.
AvailabilitySearchSession	getAvailabilitySearchSessionForFoundry(Id foundryId) Gets the OsidSession associated with the availability search service for the given foundry.
AvailabilitySmartFoundrySession	getAvailabilitySmartFoundrySession(Id foundryId) Gets the OsidSession to manage locatin smart foundries.
CommissionAdminSession	getCommissionAdminSession() Gets the OsidSession associated with the commission administrative service.
CommissionAdminSession	getCommissionAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the commission administrative service for the given foundry.
CommissionFoundryAssignmentSession	getCommissionFoundryAssignmentSession() Gets the OsidSession associated with assigning competencies to foundries.
CommissionFoundrySession	getCommissionFoundrySession() Gets the OsidSession to lookup commission/foundry mappings.
CommissionLookupSession	getCommissionLookupSession() Gets the OsidSession associated with the commission lookup service.
CommissionLookupSession	getCommissionLookupSessionForFoundry(Id foundryId) Gets the OsidSession associated with the commission lookup service for the given foundry.
CommissionNotificationSession	getCommissionNotificationSession(CommissionReceiver commissionReceiver) Gets the OsidSession associated with the commission notification service.
CommissionNotificationSession	getCommissionNotificationSessionForFoundry(CommissionReceiver commissionReceiver, Id foundryId) Gets the OsidSession associated with the commission notification service for the given foundry.
CommissionQuerySession	getCommissionQuerySession() Gets the OsidSession associated with the commission query service.
CommissionQuerySession	getCommissionQuerySessionForFoundry(Id foundryId) Gets the OsidSession associated with the commission query service for the given foundry.
CommissionSearchSession	getCommissionSearchSession() Gets the OsidSession associated with the commission search service.
CommissionSearchSession	getCommissionSearchSessionForFoundry(Id foundryId) Gets the OsidSession associated with the commission search service for the given foundry.
CommissionSmartFoundrySession	getCommissionSmartFoundrySession(Id foundryId) Gets the OsidSession to manage commission smart foundries.
CompetencyAdminSession	getCompetencyAdminSession() Gets the OsidSession associated with the competency administration service.
CompetencyAdminSession	getCompetencyAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the competency administration service for the given foundry.
CompetencyFoundryAssignmentSession	getCompetencyFoundryAssignmentSession() Gets the OsidSession associated with assigning competencies to foundries.
CompetencyFoundrySession	getCompetencyFoundrySession() Gets the OsidSession to lookup competency/foundry mappings.
CompetencyLookupSession	getCompetencyLookupSession() Gets the OsidSession associated with the competency lookup service.
CompetencyLookupSession	getCompetencyLookupSessionForFoundry(Id foundryId) Gets the OsidSession associated with the competency lookup service for the given foundry.
CompetencyNotificationSession	getCompetencyNotificationSession(CompetencyReceiver competencyReceiver) Gets the OsidSession associated with the competency notification service.
CompetencyNotificationSession	getCompetencyNotificationSessionForFoundry(CompetencyReceiver competencyReceiver, Id foundryId) Gets the OsidSession associated with the competency notification service for the given foundry.
CompetencyQuerySession	getCompetencyQuerySession() Gets the OsidSession associated with the competency query service.
CompetencyQuerySession	getCompetencyQuerySessionForFoundry(Id foundryId) Gets the OsidSession associated with the competency query service for the given foundry.
CompetencySearchSession	getCompetencySearchSession() Gets the OsidSession associated with the competency search service.
CompetencySearchSession	getCompetencySearchSessionForFoundry(Id foundryId) Gets the OsidSession associated with the competency search service for the given foundry.
CompetencySmartFoundrySession	getCompetencySmartFoundrySession(Id foundryId) Gets the OsidSession to manage competency smart foundries.
EffortAdminSession	getEffortAdminSession() Gets the OsidSession associated with the effort administration service.
EffortAdminSession	getEffortAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the effort administration service for the given foundry.
EffortFoundryAssignmentSession	getEffortFoundryAssignmentSession() Gets the OsidSession associated with assigning efforts to foundries.
EffortFoundrySession	getEffortFoundrySession() Gets the OsidSession to lookup effort/foundry mappings.
EffortLookupSession	getEffortLookupSession() Gets the OsidSession associated with the effort lookup service.
EffortLookupSession	getEffortLookupSessionForFoundry(Id foundryId) Gets the OsidSession associated with the effort lookup service for the given foundry.
EffortNotificationSession	getEffortNotificationSession(EffortReceiver effortReceiver) Gets the OsidSession associated with the effort notification service.
EffortNotificationSession	getEffortNotificationSessionForFoundry(EffortReceiver effortReceiver, Id foundryId) Gets the OsidSession associated with the effort notification service for the given foundry.
EffortQuerySession	getEffortQuerySession() Gets the OsidSession associated with the effort query service.
EffortQuerySession	getEffortQuerySessionForFoundry(Id foundryId) Gets the OsidSession associated with the effort query service for the given foundry.
EffortSearchSession	getEffortSearchSession() Gets the OsidSession associated with the effort search service.
EffortSearchSession	getEffortSearchSessionForFoundry(Id foundryId) Gets the OsidSession associated with the effort search service for the given foundry.
EffortFoundrySession	getEffortSmartFoundrySession(Id foundryId) Gets the OsidSession to manage effort smart foundries.
FoundryAdminSession	getFoundryAdminSession() Gets the OsidSession associated with the foundry administrative service.
FoundryHierarchyDesignSession	getFoundryHierarchyDesignSession() Gets the OsidSession associated with the foundry hierarchy design service.
FoundryHierarchySession	getFoundryHierarchySession() Gets the OsidSession associated with the foundry hierarchy service.
FoundryLookupSession	getFoundryLookupSession() Gets the OsidSession associated with the foundry lookup service.
FoundryNotificationSession	getFoundryNotificationSession(FoundryReceiver foundryReceiver) Gets the OsidSession associated with the foundry notification service.
FoundryQuerySession	getFoundryQuerySession() Gets the OsidSession associated with the foundry query service.
FoundrySearchSession	getFoundrySearchSession() Gets the OsidSession associated with the foundry search service.
JobAdminSession	getJobAdminSession() Gets the OsidSession associated with the job administration service.
JobAdminSession	getJobAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the job administration service for the given foundry.
JobFoundryAssignmentSession	getJobFoundryAssignmentSession() Gets the OsidSession associated with assigning jobs to foundries.
JobFoundrySession	getJobFoundrySession() Gets the OsidSession to lookup job/foundry mappings.
JobLookupSession	getJobLookupSession() Gets the OsidSession associated with the job lookup service.
JobLookupSession	getJobLookupSessionForFoundry(Id foundryId) Gets the OsidSession associated with the job lookup service for the given foundry.
JobNotificationSession	getJobNotificationSession(JobReceiver jobReceiver) Gets the OsidSession associated with the job notification service.
JobNotificationSession	getJobNotificationSessionForFoundry(JobReceiver jobReceiver, Id foundryId) Gets the OsidSession associated with the job notification service for the given foundry.
JobQuerySession	getJobQuerySession() Gets the OsidSession associated with the job query service.
JobQuerySession	getJobQuerySessionForFoundry(Id foundryId) Gets the OsidSession associated with the job query service for the given foundry.
JobSearchSession	getJobSearchSession() Gets the OsidSession associated with the job search service.
JobSearchSession	getJobSearchSessionForFoundry(Id foundryId) Gets the OsidSession associated with the job search service for the given foundry.
JobSmartFoundrySession	getJobSmartFoundrySession(Id foundryId) Gets the OsidSession to manage job smart foundries.
MyWorkSession	getMyWorkSession() Gets the OsidSession associated with the my work service.
MyWorkSession	getMyWorkSessionForFoundry(Id foundryId) Gets the OsidSession associated with the my work service for the given foundry.
ResourcingBatchManager	getResourcingBatchManager() Gets the ResourcingBatchManager.
ResourcingRulesManager	getResourcingRulesManager() Gets the ResourcingRulesManager.
WorkAdminSession	getWorkAdminSession() Gets the OsidSession associated with the work administration service.
WorkAdminSession	getWorkAdminSessionForFoundry(Id foundryId) Gets the OsidSession associated with the work administration service for the given foundry.
WorkFoundryAssignmentSession	getWorkFoundryAssignmentSession() Gets the OsidSession associated with assigning work to foundries.
WorkFoundrySession	getWorkFoundrySession() Gets the OsidSession to lookup work/foundry mappings.
WorkLookupSession	getWorkLookupSession() Gets the OsidSession associated with the work lookup service.
WorkLookupSession	getWorkLookupSessionForFoundry(Id foundryId) Gets the OsidSession associated with the work lookup service for the given foundry.
WorkNotificationSession	getWorkNotificationSession(WorkReceiver workReceiver) Gets the OsidSession associated with the work notification service.
WorkNotificationSession	getWorkNotificationSessionForFoundry(WorkReceiver workReceiver, Id foundryId) Gets the OsidSession associated with the work notification service for the given foundry.
WorkQuerySession	getWorkQuerySession() Gets the OsidSession associated with the work query service.
WorkQuerySession	getWorkQuerySessionForFoundry(Id foundryId) Gets the OsidSession associated with the work query service for the given foundry.
WorkSearchSession	getWorkSearchSession() Gets the OsidSession associated with the work search service.
WorkSearchSession	getWorkSearchSessionForFoundry(Id foundryId) Gets the OsidSession associated with the work search service for the given foundry.
WorkSmartFoundrySession	getWorkSmartFoundrySession(Id foundryId) Gets the OsidSession to manage work smart foundries.

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.ResourcingProfile

getAvailabilityRecordTypes, getAvailabilitySearchRecordTypes, getCommissionRecordTypes, getCommissionSearchRecordTypes, getCompetencyRecordTypes, getCompetencySearchRecordTypes, getEffortRecordTypes, getEffortSearchRecordTypes, getFoundryRecordTypes, getFoundrySearchRecordTypes, getJobRecordTypes, getJobSearchRecordTypes, getWorkRecordTypes, getWorkSearchRecordTypes, supportsAvailabilityAdmin, supportsAvailabilityFoundry, supportsAvailabilityFoundryAssignment, supportsAvailabilityLookup, supportsAvailabilityNotification, supportsAvailabilityQuery, supportsAvailabilityRecordType, supportsAvailabilitySearch, supportsAvailabilitySearchRecordType, supportsAvailabilitySmartFoundry, supportsCommissionAdmin, supportsCommissionFoundry, supportsCommissionFoundryAssignment, supportsCommissionLookup, supportsCommissionNotification, supportsCommissionQuery, supportsCommissionRecordType, supportsCommissionSearch, supportsCommissionSearchRecordType, supportsCommissionSmartFoundry, supportsCompetencyAdmin, supportsCompetencyFoundry, supportsCompetencyFoundryAssignment, supportsCompetencyLookup, supportsCompetencyNotification, supportsCompetencyQuery, supportsCompetencyRecordType, supportsCompetencySearch, supportsCompetencySearchRecordType, supportsCompetencySmartFoundry, supportsEffortAdmin, supportsEffortFoundry, supportsEffortFoundryAssignment, supportsEffortLookup, supportsEffortNotification, supportsEffortQuery, supportsEffortRecordType, supportsEffortSearch, supportsEffortSearchRecordType, supportsEffortSmartFoundry, supportsFoundryAdmin, supportsFoundryHierarchy, supportsFoundryHierarchyDesign, supportsFoundryLookup, supportsFoundryNotification, supportsFoundryQuery, supportsFoundryRecordType, supportsFoundrySearch, supportsFoundrySearchRecordType, supportsJobAdmin, supportsJobFoundry, supportsJobFoundryAssignment, supportsJobLookup, supportsJobNotification, supportsJobQuery, supportsJobRecordType, supportsJobSearch, supportsJobSearchRecordType, supportsJobSmartFoundry, supportsMyWork, supportsResourcingBatch, supportsResourcingRules, supportsVisibleFederation, supportsWorkAdmin, supportsWorkFoundry, supportsWorkFoundryAssignment, supportsWorkLookup, supportsWorkNotification, supportsWorkQuery, supportsWorkRecordType, supportsWorkSearch, supportsWorkSearchRecordType, supportsWorkSmartFoundry

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

getMyWorkSession

MyWorkSession getMyWorkSession()
                               throws OperationFailedException

Gets the OsidSession associated with the my work service.

Returns:

a MyWorkSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyWork() is false

Compliance:

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

getMyWorkSessionForFoundry

MyWorkSession getMyWorkSessionForFoundry(Id foundryId)
                                         throws NotFoundException,
                                                OperationFailedException

Gets the OsidSession associated with the my work service for the given foundry.

Parameters:

foundryId - the Id of the foundry

Returns:

a MyWorkSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyWork() or supportsVisibleFederation() is false

Compliance:

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

getJobLookupSession

JobLookupSession getJobLookupSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the job lookup service.

Returns:

a JobLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJobLookup() is false

Compliance:

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

getJobLookupSessionForFoundry

JobLookupSession getJobLookupSessionForFoundry(Id foundryId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the job lookup service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a JobLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobLookup() or supportsVisibleFederation() is false

Compliance:

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

getJobQuerySession

JobQuerySession getJobQuerySession()
                                   throws OperationFailedException

Gets the OsidSession associated with the job query service.

Returns:

a JobQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJobQuery() is false

Compliance:

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

getJobQuerySessionForFoundry

JobQuerySession getJobQuerySessionForFoundry(Id foundryId)
                                             throws NotFoundException,
                                                    OperationFailedException

Gets the OsidSession associated with the job query service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a JobQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobQuery() or supportsVisibleFederation() is false

Compliance:

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

getJobSearchSession

JobSearchSession getJobSearchSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the job search service.

Returns:

a JobSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJobSearch() is false

Compliance:

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

getJobSearchSessionForFoundry

JobSearchSession getJobSearchSessionForFoundry(Id foundryId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the job search service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a JobSearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobSearch() or supportsVisibleFederation() is false

Compliance:

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

getJobAdminSession

JobAdminSession getJobAdminSession()
                                   throws OperationFailedException

Gets the OsidSession associated with the job administration service.

Returns:

a JobAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJobAdmin() is false

Compliance:

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

getJobAdminSessionForFoundry

JobAdminSession getJobAdminSessionForFoundry(Id foundryId)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

a JobAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobAdmin() or supportsVisibleFederation() is false

Compliance:

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

getJobNotificationSession

JobNotificationSession getJobNotificationSession(JobReceiver jobReceiver)
                                                 throws OperationFailedException

Gets the OsidSession associated with the job notification service.

Parameters:

jobReceiver - the notification callback

Returns:

a JobNotificationSession

Throws:

NullArgumentException - jobReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobNotification() is false

Compliance:

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

getJobNotificationSessionForFoundry

JobNotificationSession getJobNotificationSessionForFoundry(JobReceiver jobReceiver,
                                                         Id foundryId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the job notification service for the given foundry.

Parameters:

jobReceiver - the notification callback

foundryId - the Id of the Foundry

Returns:

a JobNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - jobReceiver or foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobNotification() or supportsVisibleFederation() is false

Compliance:

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

getJobFoundrySession

JobFoundrySession getJobFoundrySession()
                                       throws OperationFailedException

Gets the OsidSession to lookup job/foundry mappings.

Returns:

a JobFoundrySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJobFoundry() is false

Compliance:

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

getJobFoundryAssignmentSession

JobFoundryAssignmentSession getJobFoundryAssignmentSession()
                                                           throws OperationFailedException

Gets the OsidSession associated with assigning jobs to foundries.

Returns:

a JobFoundryAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsJobFoundryAssignment() is false

Compliance:

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

getJobSmartFoundrySession

JobSmartFoundrySession getJobSmartFoundrySession(Id foundryId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession to manage job smart foundries.

Parameters:

foundryId - the Id of the Foundry

Returns:

a JobSmartFoundrySession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobSmartFoundry() is false

Compliance:

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

getWorkLookupSession

WorkLookupSession getWorkLookupSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the work lookup service.

Returns:

a WorkLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkLookup() is false

Compliance:

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

getWorkLookupSessionForFoundry

WorkLookupSession getWorkLookupSessionForFoundry(Id foundryId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the work lookup service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a WorkLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkLookup() or supportsVisibleFederation() is false

Compliance:

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

getWorkQuerySession

WorkQuerySession getWorkQuerySession()
                                     throws OperationFailedException

Gets the OsidSession associated with the work query service.

Returns:

a WorkQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkQuery() is false

Compliance:

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

getWorkQuerySessionForFoundry

WorkQuerySession getWorkQuerySessionForFoundry(Id foundryId)
                                               throws NotFoundException,
                                                      OperationFailedException

Gets the OsidSession associated with the work query service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a WorkQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkQuery() or supportsVisibleFederation() is false

Compliance:

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

getWorkSearchSession

WorkSearchSession getWorkSearchSession()
                                       throws OperationFailedException

Gets the OsidSession associated with the work search service.

Returns:

a WorkSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSearch() is false

Compliance:

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

getWorkSearchSessionForFoundry

WorkSearchSession getWorkSearchSessionForFoundry(Id foundryId)
                                                 throws NotFoundException,
                                                        OperationFailedException

Gets the OsidSession associated with the work search service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a WorkSearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSearch() or supportsVisibleFederation() is false

Compliance:

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

getWorkAdminSession

WorkAdminSession getWorkAdminSession()
                                     throws OperationFailedException

Gets the OsidSession associated with the work administration service.

Returns:

a WorkAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkAdmin() is false

Compliance:

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

getWorkAdminSessionForFoundry

WorkAdminSession getWorkAdminSessionForFoundry(Id foundryId)
                                               throws NotFoundException,
                                                      OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

a WorkAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkAdmin() or supportsVisibleFederation() is false

Compliance:

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

getWorkNotificationSession

WorkNotificationSession getWorkNotificationSession(WorkReceiver workReceiver)
                                                   throws OperationFailedException

Gets the OsidSession associated with the work notification service.

Parameters:

workReceiver - the notification callback

Returns:

a WorkNotificationSession

Throws:

NullArgumentException - workReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkNotification() is false

Compliance:

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

getWorkNotificationSessionForFoundry

WorkNotificationSession getWorkNotificationSessionForFoundry(WorkReceiver workReceiver,
                                                           Id foundryId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the work notification service for the given foundry.

Parameters:

workReceiver - the notification callback

foundryId - the Id of the Foundry

Returns:

a WorkNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - workReceiver or foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkNotification() or supportsVisibleFederation() is false

Compliance:

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

getWorkFoundrySession

WorkFoundrySession getWorkFoundrySession()
                                         throws OperationFailedException

Gets the OsidSession to lookup work/foundry mappings.

Returns:

a WorkFoundrySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkFoundry() is false

Compliance:

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

getWorkFoundryAssignmentSession

WorkFoundryAssignmentSession getWorkFoundryAssignmentSession()
                                                             throws OperationFailedException

Gets the OsidSession associated with assigning work to foundries.

Returns:

a WorkFoundryAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkbFoundryAssignment() is false

Compliance:

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

getWorkSmartFoundrySession

WorkSmartFoundrySession getWorkSmartFoundrySession(Id foundryId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession to manage work smart foundries.

Parameters:

foundryId - the Id of the Foundry

Returns:

a WorkSmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSmartFoundry() is false

Compliance:

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

getCompetencyLookupSession

CompetencyLookupSession getCompetencyLookupSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the competency lookup service.

Returns:

a CompetencyLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyLookup() is false

Compliance:

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

getCompetencyLookupSessionForFoundry

CompetencyLookupSession getCompetencyLookupSessionForFoundry(Id foundryId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the competency lookup service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a CompetencyLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyLookup() or supportsVisibleFederation() is false

Compliance:

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

getCompetencyQuerySession

CompetencyQuerySession getCompetencyQuerySession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the competency query service.

Returns:

a CompetencyQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyQuery() is false

Compliance:

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

getCompetencyQuerySessionForFoundry

CompetencyQuerySession getCompetencyQuerySessionForFoundry(Id foundryId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the competency query service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a CompetencyQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyQuery() or supportsVisibleFederation() is false

Compliance:

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

getCompetencySearchSession

CompetencySearchSession getCompetencySearchSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the competency search service.

Returns:

a CompetencySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencySearch() is false

Compliance:

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

getCompetencySearchSessionForFoundry

CompetencySearchSession getCompetencySearchSessionForFoundry(Id foundryId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the competency search service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a CompetencySearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencySearch() or supportsVisibleFederation() is false

Compliance:

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

getCompetencyAdminSession

CompetencyAdminSession getCompetencyAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the competency administration service.

Returns:

a CompetencyAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyAdmin() is false

Compliance:

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

getCompetencyAdminSessionForFoundry

CompetencyAdminSession getCompetencyAdminSessionForFoundry(Id foundryId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

a CompetencyAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCompetencyNotificationSession

CompetencyNotificationSession getCompetencyNotificationSession(CompetencyReceiver competencyReceiver)
                                                               throws OperationFailedException

Gets the OsidSession associated with the competency notification service.

Parameters:

competencyReceiver - the notification callback

Returns:

a CompetencyNotificationSession

Throws:

NullArgumentException - competencyReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyNotification() is false

Compliance:

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

getCompetencyNotificationSessionForFoundry

CompetencyNotificationSession getCompetencyNotificationSessionForFoundry(CompetencyReceiver competencyReceiver,
                                                                       Id foundryId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the competency notification service for the given foundry.

Parameters:

competencyReceiver - the notification callback

foundryId - the Id of the Foundry

Returns:

a CompetencyNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - competencyReceiver or foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyNotification() or supportsVisibleFederation() is false

Compliance:

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

getCompetencyFoundrySession

CompetencyFoundrySession getCompetencyFoundrySession()
                                                     throws OperationFailedException

Gets the OsidSession to lookup competency/foundry mappings.

Returns:

a CompetencyFoundrySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyFoundry() is false

Compliance:

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

getCompetencyFoundryAssignmentSession

CompetencyFoundryAssignmentSession getCompetencyFoundryAssignmentSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning competencies to foundries.

Returns:

a CompetencyFoundryAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyFoundryAssignment() is false

Compliance:

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

getCompetencySmartFoundrySession

CompetencySmartFoundrySession getCompetencySmartFoundrySession(Id foundryId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage competency smart foundries.

Parameters:

foundryId - the Id of the foundry

Returns:

a CompetencySmartFoundrySession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencySmartFoundry() is false

Compliance:

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

getAvailabilityLookupSession

AvailabilityLookupSession getAvailabilityLookupSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the availability lookup service.

Returns:

an AvailabilityLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityLookup() is false

Compliance:

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

getAvailabilityLookupSessionForFoundry

AvailabilityLookupSession getAvailabilityLookupSessionForFoundry(Id foundryId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the availability lookup service for the given foundry.

Parameters:

foundryId - the Id of the foundry

Returns:

an AvailabilityLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityLookup() or supportsVisibleFederation() is false

Compliance:

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

getAvailabilityQuerySession

AvailabilityQuerySession getAvailabilityQuerySession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the availability query service.

Returns:

an AvailabilityQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityQuery() is false

Compliance:

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

getAvailabilityQuerySessionForFoundry

AvailabilityQuerySession getAvailabilityQuerySessionForFoundry(Id foundryId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the availability query service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

an AvailabilityQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityQuery() or supportsVisibleFederation() is false

Compliance:

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

getAvailabilitySearchSession

AvailabilitySearchSession getAvailabilitySearchSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the availability search service.

Returns:

an AvailabilitySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilitySearch() is false

Compliance:

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

getAvailabilitySearchSessionForFoundry

AvailabilitySearchSession getAvailabilitySearchSessionForFoundry(Id foundryId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the availability search service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

an AvailabilitySearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilitySearch() or supportsVisibleFederation() is false

Compliance:

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

getAvailabilityAdminSession

AvailabilityAdminSession getAvailabilityAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the availability administration service.

Returns:

an AvailabilityAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityAdmin() is false

Compliance:

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

getAvailabilityAdminSessionForFoundry

AvailabilityAdminSession getAvailabilityAdminSessionForFoundry(Id foundryId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

an AvailabilityAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityAdmin() or supportsVisibleFederation() is false

Compliance:

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

getAvailabilityNotificationSession

AvailabilityNotificationSession getAvailabilityNotificationSession(AvailabilityReceiver availabilityReceiver)
                                                                   throws OperationFailedException

Gets the OsidSession associated with the availability notification service.

Parameters:

availabilityReceiver - the notification callback

Returns:

an AvailabilityNotificationSession

Throws:

NullArgumentException - availabilityReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityNotification() is false

Compliance:

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

getAvailabilityNotificationSessionForFoundry

AvailabilityNotificationSession getAvailabilityNotificationSessionForFoundry(AvailabilityReceiver availabilityReceiver,
                                                                           Id foundryId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

Gets the OsidSession associated with the availability notification service for the given foundry.

Parameters:

availabilityReceiver - the notification callback

foundryId - the Id of the Foundry

Returns:

an AvailabilityNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - availabilityReceiver or foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityNotification() or supportsVisibleFederation() is false

Compliance:

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

getAvailabilityFoundrySession

AvailabilityFoundrySession getAvailabilityFoundrySession()
                                                         throws OperationFailedException

Gets the OsidSession to lookup availability/foundry mappings.

Returns:

an AvailabilityFoundrySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityFoundry() is false

Compliance:

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

getAvailabilityFoundryAssignmentSession

AvailabilityFoundryAssignmentSession getAvailabilityFoundryAssignmentSession()
                                                                             throws OperationFailedException

Gets the OsidSession associated with assigning availabilities to foundries.

Returns:

an AvailabilityFoundryAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityFoundryAssignment() is false

Compliance:

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

getAvailabilitySmartFoundrySession

AvailabilitySmartFoundrySession getAvailabilitySmartFoundrySession(Id foundryId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

Gets the OsidSession to manage locatin smart foundries.

Parameters:

foundryId - the Id of the Foundry

Returns:

an AvailabilitySmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilitySmartFoundry() is false

Compliance:

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

getCommissionLookupSession

CommissionLookupSession getCommissionLookupSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the commission lookup service.

Returns:

a CommissionLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionLookup() is false

Compliance:

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

getCommissionLookupSessionForFoundry

CommissionLookupSession getCommissionLookupSessionForFoundry(Id foundryId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the commission lookup service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a CommissionLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionLookup() or supportsVisibleFederation() is false

Compliance:

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

getCommissionQuerySession

CommissionQuerySession getCommissionQuerySession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the commission query service.

Returns:

a CommissionQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionQuery() is false

Compliance:

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

getCommissionQuerySessionForFoundry

CommissionQuerySession getCommissionQuerySessionForFoundry(Id foundryId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the commission query service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a CCommissionQuerySession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionQuery() or supportsVisibleFederation() is false

Compliance:

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

getCommissionSearchSession

CommissionSearchSession getCommissionSearchSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the commission search service.

Returns:

a CommissionSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionSearch() is false

Compliance:

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

getCommissionSearchSessionForFoundry

CommissionSearchSession getCommissionSearchSessionForFoundry(Id foundryId)
                                                             throws NotFoundException,
                                                                    OperationFailedException

Gets the OsidSession associated with the commission search service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a CommissionSearchSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionSearch() or supportsVisibleFederation() is false

Compliance:

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

getCommissionAdminSession

CommissionAdminSession getCommissionAdminSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the commission administrative service.

Returns:

a CommissionAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionAdmin() is false

Compliance:

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

getCommissionAdminSessionForFoundry

CommissionAdminSession getCommissionAdminSessionForFoundry(Id foundryId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

Gets the OsidSession associated with the commission administrative service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

a CommissionAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionAdmin() or supportsVisibleFederation() is false

Compliance:

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

getCommissionNotificationSession

CommissionNotificationSession getCommissionNotificationSession(CommissionReceiver commissionReceiver)
                                                               throws OperationFailedException

Gets the OsidSession associated with the commission notification service.

Parameters:

commissionReceiver - the notification callback

Returns:

a CommissionNotificationSession

Throws:

NullArgumentException - commissionReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionNotification() is false

Compliance:

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

getCommissionNotificationSessionForFoundry

CommissionNotificationSession getCommissionNotificationSessionForFoundry(CommissionReceiver commissionReceiver,
                                                                       Id foundryId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

Gets the OsidSession associated with the commission notification service for the given foundry.

Parameters:

commissionReceiver - the notification callback

foundryId - the Id of the Foundry

Returns:

a CommissionNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - commissionReceiver or foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionNotification() or supportsVisibleFederation() is false

Compliance:

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

getCommissionFoundrySession

CommissionFoundrySession getCommissionFoundrySession()
                                                     throws OperationFailedException

Gets the OsidSession to lookup commission/foundry mappings.

Returns:

a CommissionFoundrySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionFoundry() is false

Compliance:

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

getCommissionFoundryAssignmentSession

CommissionFoundryAssignmentSession getCommissionFoundryAssignmentSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning competencies to foundries.

Returns:

a CommissionyFoundryAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionFoundryAssignment() is false

Compliance:

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

getCommissionSmartFoundrySession

CommissionSmartFoundrySession getCommissionSmartFoundrySession(Id foundryId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession to manage commission smart foundries.

Parameters:

foundryId - the Id of the Foundry

Returns:

a CommissionSmartFoundrySession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionSmartFoundry() is false

Compliance:

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

getEffortLookupSession

EffortLookupSession getEffortLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the effort lookup service.

Returns:

an EffortLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortLookup() is false

Compliance:

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

getEffortLookupSessionForFoundry

EffortLookupSession getEffortLookupSessionForFoundry(Id foundryId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the effort lookup service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

an EffortLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortLookup() or supportsVisibleFederation() is false

Compliance:

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

getEffortQuerySession

EffortQuerySession getEffortQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the effort query service.

Returns:

an EffortQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortQuery() is false

Compliance:

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

getEffortQuerySessionForFoundry

EffortQuerySession getEffortQuerySessionForFoundry(Id foundryId)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession associated with the effort query service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

an EffortQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortQuery() or supportsVisibleFederation() is false

Compliance:

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

getEffortSearchSession

EffortSearchSession getEffortSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the effort search service.

Returns:

an EffortSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortSearch() is false

Compliance:

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

getEffortSearchSessionForFoundry

EffortSearchSession getEffortSearchSessionForFoundry(Id foundryId)
                                                     throws NotFoundException,
                                                            OperationFailedException

Gets the OsidSession associated with the effort search service for the given foundry.

Parameters:

foundryId - the Id of the Foundry

Returns:

an EffortSearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortSearch() or supportsVisibleFederation() is false

Compliance:

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

getEffortAdminSession

EffortAdminSession getEffortAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the effort administration service.

Returns:

an EffortAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortAdmin() is false

Compliance:

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

getEffortAdminSessionForFoundry

EffortAdminSession getEffortAdminSessionForFoundry(Id foundryId)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

Returns:

an EffortAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortAdmin() or supportsVisibleFederation() is false

Compliance:

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

getEffortNotificationSession

EffortNotificationSession getEffortNotificationSession(EffortReceiver effortReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the effort notification service.

Parameters:

effortReceiver - the notification callback

Returns:

an EffortNotificationSession

Throws:

NullArgumentException - effortReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortNotification() is false

Compliance:

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

getEffortNotificationSessionForFoundry

EffortNotificationSession getEffortNotificationSessionForFoundry(EffortReceiver effortReceiver,
                                                               Id foundryId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

Gets the OsidSession associated with the effort notification service for the given foundry.

Parameters:

effortReceiver - the notification callback

foundryId - the Id of the Foundry

Returns:

an EffortNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - effortReceiver or foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortNotification() or supportsVisibleFederation() is false

Compliance:

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

getEffortFoundrySession

EffortFoundrySession getEffortFoundrySession()
                                             throws OperationFailedException

Gets the OsidSession to lookup effort/foundry mappings.

Returns:

an EffortFoundrySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortFoundry() is false

Compliance:

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

getEffortFoundryAssignmentSession

EffortFoundryAssignmentSession getEffortFoundryAssignmentSession()
                                                                 throws OperationFailedException

Gets the OsidSession associated with assigning efforts to foundries.

Returns:

an EffortFoundryAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortFoundryAssignment() is false

Compliance:

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

getEffortSmartFoundrySession

EffortFoundrySession getEffortSmartFoundrySession(Id foundryId)
                                                  throws NotFoundException,
                                                         OperationFailedException

Gets the OsidSession to manage effort smart foundries.

Parameters:

foundryId - the Id of the Foundry

Returns:

an EffortSmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortSmartFoundry() is false

Compliance:

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

getFoundryLookupSession

FoundryLookupSession getFoundryLookupSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the foundry lookup service.

Returns:

a FoundryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryLookup() is false

Compliance:

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

getFoundryQuerySession

FoundryQuerySession getFoundryQuerySession()
                                           throws OperationFailedException

Gets the OsidSession associated with the foundry query service.

Returns:

a FoundryQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryQuery() is false

Compliance:

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

getFoundrySearchSession

FoundrySearchSession getFoundrySearchSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the foundry search service.

Returns:

a FoundrySearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundrySearch() is false

Compliance:

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

getFoundryAdminSession

FoundryAdminSession getFoundryAdminSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the foundry administrative service.

Returns:

a FoundryAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryAdmin() is false

Compliance:

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

getFoundryNotificationSession

FoundryNotificationSession getFoundryNotificationSession(FoundryReceiver foundryReceiver)
                                                         throws OperationFailedException

Gets the OsidSession associated with the foundry notification service.

Parameters:

foundryReceiver - the notification callback

Returns:

a FoundryNotificationSession

Throws:

NullArgumentException - foundryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryNotification() is false

Compliance:

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

getFoundryHierarchySession

FoundryHierarchySession getFoundryHierarchySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the foundry hierarchy service.

Returns:

a FoundryHierarchySession for foundries

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryHierarchy() is false

Compliance:

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

getFoundryHierarchyDesignSession

FoundryHierarchyDesignSession getFoundryHierarchyDesignSession()
                                                               throws OperationFailedException

Gets the OsidSession associated with the foundry hierarchy design service.

Returns:

a HierarchyDesignSession for foundries

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryHierarchyDesign() is false

Compliance:

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

getResourcingBatchManager

ResourcingBatchManager getResourcingBatchManager()
                                                 throws OperationFailedException

Gets the ResourcingBatchManager.

Returns:

a ResourcingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcingBatch() is false

Compliance:

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

getResourcingRulesManager

ResourcingRulesManager getResourcingRulesManager()
                                                 throws OperationFailedException

Gets the ResourcingRulesManager.

Returns:

a ResourcingRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcingRules() is false

Compliance:

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