Interface ResourcingManager
- All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, ResourcingProfile, Sourceable
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
Modifier and TypeMethodDescriptionGets theOsidSessionassociated with the availability administration service.getAvailabilityAdminSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the availability administration service for the given foundry.Gets theOsidSessionassociated with assigning availabilities to foundries.Gets theOsidSessionto lookup availability/foundry mappings.Gets theOsidSessionassociated with the availability lookup service.getAvailabilityLookupSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the availability lookup service for the given foundry.getAvailabilityNotificationSession(AvailabilityReceiver availabilityReceiver) Gets theOsidSessionassociated with the availability notification service.getAvailabilityNotificationSessionForFoundry(AvailabilityReceiver availabilityReceiver, Id foundryId) Gets theOsidSessionassociated with the availability notification service for the given foundry.Gets theOsidSessionassociated with the availability query service.getAvailabilityQuerySessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the availability query service for the given foundry.Gets theOsidSessionassociated with the availability search service.getAvailabilitySearchSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the availability search service for the given foundry.getAvailabilitySmartFoundrySession(Id foundryId) Gets theOsidSessionto manage locatin smart foundries.Gets theOsidSessionassociated with the commission administrative service.getCommissionAdminSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the commission administrative service for the given foundry.Gets theOsidSessionassociated with assigning competencies to foundries.Gets theOsidSessionto lookup commission/foundry mappings.Gets theOsidSessionassociated with the commission lookup service.getCommissionLookupSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the commission lookup service for the given foundry.getCommissionNotificationSession(CommissionReceiver commissionReceiver) Gets theOsidSessionassociated with the commission notification service.getCommissionNotificationSessionForFoundry(CommissionReceiver commissionReceiver, Id foundryId) Gets theOsidSessionassociated with the commission notification service for the given foundry.Gets theOsidSessionassociated with the commission query service.getCommissionQuerySessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the commission query service for the given foundry.Gets theOsidSessionassociated with the commission search service.getCommissionSearchSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the commission search service for the given foundry.getCommissionSmartFoundrySession(Id foundryId) Gets theOsidSessionto manage commission smart foundries.Gets theOsidSessionassociated with the competency administration service.getCompetencyAdminSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the competency administration service for the given foundry.Gets theOsidSessionassociated with assigning competencies to foundries.Gets theOsidSessionto lookup competency/foundry mappings.Gets theOsidSessionassociated with the competency lookup service.getCompetencyLookupSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the competency lookup service for the given foundry.getCompetencyNotificationSession(CompetencyReceiver competencyReceiver) Gets theOsidSessionassociated with the competency notification service.getCompetencyNotificationSessionForFoundry(CompetencyReceiver competencyReceiver, Id foundryId) Gets theOsidSessionassociated with the competency notification service for the given foundry.Gets theOsidSessionassociated with the competency query service.getCompetencyQuerySessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the competency query service for the given foundry.Gets theOsidSessionassociated with the competency search service.getCompetencySearchSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the competency search service for the given foundry.getCompetencySmartFoundrySession(Id foundryId) Gets theOsidSessionto manage competency smart foundries.Gets theOsidSessionassociated with the effort administration service.getEffortAdminSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the effort administration service for the given foundry.Gets theOsidSessionassociated with assigning efforts to foundries.Gets theOsidSessionto lookup effort/foundry mappings.Gets theOsidSessionassociated with the effort lookup service.getEffortLookupSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the effort lookup service for the given foundry.getEffortNotificationSession(EffortReceiver effortReceiver) Gets theOsidSessionassociated with the effort notification service.getEffortNotificationSessionForFoundry(EffortReceiver effortReceiver, Id foundryId) Gets theOsidSessionassociated with the effort notification service for the given foundry.Gets theOsidSessionassociated with the effort query service.getEffortQuerySessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the effort query service for the given foundry.Gets theOsidSessionassociated with the effort search service.getEffortSearchSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the effort search service for the given foundry.getEffortSmartFoundrySession(Id foundryId) Gets theOsidSessionto manage effort smart foundries.Gets theOsidSessionassociated with the foundry administrative service.Gets theOsidSessionassociated with the foundry hierarchy design service.Gets theOsidSessionassociated with the foundry hierarchy service.Gets theOsidSessionassociated with the foundry lookup service.getFoundryNotificationSession(FoundryReceiver foundryReceiver) Gets theOsidSessionassociated with the foundry notification service.Gets theOsidSessionassociated with the foundry query service.Gets theOsidSessionassociated with the foundry search service.Gets theOsidSessionassociated with the job administration service.getJobAdminSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the job administration service for the given foundry.Gets theOsidSessionassociated with assigning jobs to foundries.Gets theOsidSessionto lookup job/foundry mappings.Gets theOsidSessionassociated with the job lookup service.getJobLookupSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the job lookup service for the given foundry.getJobNotificationSession(JobReceiver jobReceiver) Gets theOsidSessionassociated with the job notification service.getJobNotificationSessionForFoundry(JobReceiver jobReceiver, Id foundryId) Gets theOsidSessionassociated with the job notification service for the given foundry.Gets theOsidSessionassociated with the job query service.getJobQuerySessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the job query service for the given foundry.Gets theOsidSessionassociated with the job search service.getJobSearchSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the job search service for the given foundry.getJobSmartFoundrySession(Id foundryId) Gets theOsidSessionto manage job smart foundries.Gets theOsidSessionassociated with the my work service.getMyWorkSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the my work service for the given foundry.Gets theResourcingBatchManager.Gets theResourcingRulesManager.Gets theOsidSessionassociated with the work administration service.getWorkAdminSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the work administration service for the given foundry.Gets theOsidSessionassociated with assigning work to foundries.Gets theOsidSessionto lookup work/foundry mappings.Gets theOsidSessionassociated with the work lookup service.getWorkLookupSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the work lookup service for the given foundry.getWorkNotificationSession(WorkReceiver workReceiver) Gets theOsidSessionassociated with the work notification service.getWorkNotificationSessionForFoundry(WorkReceiver workReceiver, Id foundryId) Gets theOsidSessionassociated with the work notification service for the given foundry.Gets theOsidSessionassociated with the work query service.getWorkQuerySessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the work query service for the given foundry.Gets theOsidSessionassociated with the work search service.getWorkSearchSessionForFoundry(Id foundryId) Gets theOsidSessionassociated with the work search service for the given foundry.getWorkSmartFoundrySession(Id foundryId) Gets theOsidSessionto manage work smart foundries.Methods inherited from interface OsidManager
closeMethods inherited from interface OsidManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime) Rolls back this service to a point in time.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface 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, supportsWorkSmartFoundryModifier and TypeMethodDescriptionGets the supportedAvailabilityrecord types.Gets the supportedAvailabilitysearch types.Gets the supportedCommissionrecord types.Gets the supportedCommissionsearch record types.Gets the supportedCompetencyrecord types.Gets the supportedCompetencysearch record types.Gets the supportedEffortrecord types.Gets the supportedEffortsearch types.Gets the supportedFoundryrecord types.Gets the supportedFoundrysearch record types.Gets the supportedJobrecord types.Gets the supportedJobsearch record types.Gets the supportedWorkrecord types.Gets the supportedWorksearch record types.booleanTests if availability administrative service is supported.booleanTests if an availability foundry lookup service is supported.booleanTests if an availability foundry assignment service is supported.booleanTests if looking up availabilities is supported.booleanTests if an availability notification service is supported.booleanTests if querying availabilities is supported.booleansupportsAvailabilityRecordType(Type availabilityRecordType) Tests if the givenAvailabilityrecord type is supported.booleanTests if searching availabilities is supported.booleansupportsAvailabilitySearchRecordType(Type availabilitySearchRecordType) Tests if the givenAvailabilitysearch type is supported.booleanTests if an availability smart foundry service is supported.booleanTests if commission administrative service is supported.booleanTests if a commission foundry lookup service is supported.booleanTests if a commission foundry service is supported.booleanTests if looking up commissions is supported.booleanTests if a commission notification service is supported.booleanTests if querying commissions is supported.booleansupportsCommissionRecordType(Type commissionRecordType) Tests if the givenCommissionrecord type is supported.booleanTests if searching commissions is supported.booleansupportsCommissionSearchRecordType(Type commissionSearchRecordType) Tests if the givenCommissionsearch record type is supported.booleanTests if a commission smart foundry lookup service is supported.booleanTests if competency administrative service is supported.booleanTests if a competency foundry lookup service is supported.booleanTests if a competency foundry service is supported.booleanTests if looking up competencies is supported.booleanTests if a competency notification service is supported.booleanTests if querying competencies is supported.booleansupportsCompetencyRecordType(Type competencyRecordType) Tests if the givenCompetencyrecord type is supported.booleanTests if searching competencies is supported.booleansupportsCompetencySearchRecordType(Type competencySearchRecordType) Tests if the givenCompetencysearch record type is supported.booleanTests if a competency smart foundry lookup service is supported.booleanTests if an effort administrative service is supported.booleanTests if an effort foundry lookup service is supported.booleanTests if an effort foundry assignment service is supported.booleanTests if looking up efforts is supported.booleanTests if an effort notification service is supported.booleanTests if querying efforts is supported.booleansupportsEffortRecordType(Type effortRecordType) Tests if the givenEffortrecord type is supported.booleanTests if searching efforts is supported.booleansupportsEffortSearchRecordType(Type effortSearchRecordType) Tests if the givenEffortsearch type is supported.booleanTests if an effort smart foundry service is supported.booleanTests if foundry administrative service is supported.booleanTests for the availability of a foundry hierarchy traversal service.booleanTests for the availability of a foundry hierarchy design service.booleanTests if looking up foundries is supported.booleanTests if a foundry notification service is supported.booleanTests if querying foundries is supported.booleansupportsFoundryRecordType(Type foundryRecordType) Tests if the givenFoundryrecord type is supported.booleanTests if searching foundries is supported.booleansupportsFoundrySearchRecordType(Type foundrySearchRecordType) Tests if the givenFoundrysearch record type is supported.booleanTests if job administrative service is supported.booleanTests if a job foundry lookup service is supported.booleanTests if a job foundry service is supported.booleanTests if looking up jobs is supported.booleanTests if a job notification service is supported.booleanTests if querying jobs is supported.booleansupportsJobRecordType(Type jobRecordType) Tests if the givenJobrecord type is supported.booleanTests if searching jobs is supported.booleansupportsJobSearchRecordType(Type jobSearchRecordType) Tests if the givenJobsearch record type is supported.booleanTests if a job smart foundry lookup service is supported.booleanTests if an availability service is supported for the current agent.booleanTests for the availability of a resourcing batch service.booleanTests for the availability of a resourcing rules service.booleanTests if any foundry federation is exposed.booleanTests if work administrative service is supported.booleanTests if a work foundry lookup service is supported.booleanTests if a work foundry service is supported.booleanTests if looking up work is supported.booleanTests if a work notification service is supported.booleanTests if querying work is supported.booleansupportsWorkRecordType(Type workRecordType) Tests if the givenWorkrecord type is supported.booleanTests if searching work is supported.booleansupportsWorkSearchRecordType(Type workSearchRecordType) Tests if the givenWorksearch record type is supported.booleanTests if a work smart foundry lookup service is supported.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getMyWorkSession
Gets theOsidSessionassociated with the my work service.- Returns:
- a
MyWorkSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsMyWork()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMyWork()} is {@code true} .
-
getMyWorkSessionForFoundry
MyWorkSession getMyWorkSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the my work service for the given foundry.- Parameters:
foundryId- theIdof the foundry- Returns:
- a
MyWorkSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMyWork()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMyWork()} and {@code supportsVisibleFederation()} are {@code true}
-
getJobLookupSession
Gets theOsidSessionassociated with the job lookup service.- Returns:
- a
JobLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJobLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobLookup()} is {@code true} .
-
getJobLookupSessionForFoundry
JobLookupSession getJobLookupSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the job lookup service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
JobLookupSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJobLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getJobQuerySession
Gets theOsidSessionassociated with the job query service.- Returns:
- a
JobQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJobQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobQuery()} is {@code true} .
-
getJobQuerySessionForFoundry
JobQuerySession getJobQuerySessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the job query service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
JobQuerySession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJobQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getJobSearchSession
Gets theOsidSessionassociated with the job search service.- Returns:
- a
JobSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJobSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobSearch()} is {@code true} .
-
getJobSearchSessionForFoundry
JobSearchSession getJobSearchSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the job search service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
JobSearchSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJobSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getJobAdminSession
Gets theOsidSessionassociated with the job administration service.- Returns:
- a
JobAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJobAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobAdmin()} is {@code true} .
-
getJobAdminSessionForFoundry
JobAdminSession getJobAdminSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the job administration service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
JobAdminSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJobAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getJobNotificationSession
JobNotificationSession getJobNotificationSession(JobReceiver jobReceiver) throws OperationFailedException Gets theOsidSessionassociated with the job notification service.- Parameters:
jobReceiver- the notification callback- Returns:
- a
JobNotificationSession - Throws:
NullArgumentException-jobReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJobNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobNotification()} is {@code true} .
-
getJobNotificationSessionForFoundry
JobNotificationSession getJobNotificationSessionForFoundry(JobReceiver jobReceiver, Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the job notification service for the given foundry.- Parameters:
jobReceiver- the notification callbackfoundryId- theIdof theFoundry- Returns:
- a
JobNotificationSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-jobReceiverorfoundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJobNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getJobFoundrySession
Gets theOsidSessionto lookup job/foundry mappings.- Returns:
- a
JobFoundrySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJobFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobFoundry()} is {@code true} .
-
getJobFoundryAssignmentSession
Gets theOsidSessionassociated with assigning jobs to foundries.- Returns:
- a
JobFoundryAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsJobFoundryAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobFoundryAssignment()} is {@code true} .
-
getJobSmartFoundrySession
JobSmartFoundrySession getJobSmartFoundrySession(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage job smart foundries.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
JobSmartFoundrySession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsJobSmartFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsJobSmartFoundry()} is {@code true} .
-
getWorkLookupSession
Gets theOsidSessionassociated with the work lookup service.- Returns:
- a
WorkLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsWorkLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkLookup()} is {@code true} .
-
getWorkLookupSessionForFoundry
WorkLookupSession getWorkLookupSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the work lookup service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
WorkLookupSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getWorkQuerySession
Gets theOsidSessionassociated with the work query service.- Returns:
- a
WorkQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsWorkQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkQuery()} is {@code true} .
-
getWorkQuerySessionForFoundry
WorkQuerySession getWorkQuerySessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the work query service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
WorkQuerySession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getWorkSearchSession
Gets theOsidSessionassociated with the work search service.- Returns:
- a
WorkSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsWorkSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkSearch()} is {@code true} .
-
getWorkSearchSessionForFoundry
WorkSearchSession getWorkSearchSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the work search service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
WorkSearchSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getWorkAdminSession
Gets theOsidSessionassociated with the work administration service.- Returns:
- a
WorkAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsWorkAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkAdmin()} is {@code true} .
-
getWorkAdminSessionForFoundry
WorkAdminSession getWorkAdminSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the work administration service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
WorkAdminSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getWorkNotificationSession
WorkNotificationSession getWorkNotificationSession(WorkReceiver workReceiver) throws OperationFailedException Gets theOsidSessionassociated with the work notification service.- Parameters:
workReceiver- the notification callback- Returns:
- a
WorkNotificationSession - Throws:
NullArgumentException-workReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkNotification()} is {@code true} .
-
getWorkNotificationSessionForFoundry
WorkNotificationSession getWorkNotificationSessionForFoundry(WorkReceiver workReceiver, Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the work notification service for the given foundry.- Parameters:
workReceiver- the notification callbackfoundryId- theIdof theFoundry- Returns:
- a
WorkNotificationSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-workReceiverorfoundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getWorkFoundrySession
Gets theOsidSessionto lookup work/foundry mappings.- Returns:
- a
WorkFoundrySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsWorkFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkFoundry()} is {@code true} .
-
getWorkFoundryAssignmentSession
Gets theOsidSessionassociated with assigning work to foundries.- Returns:
- a
WorkFoundryAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsWorkbFoundryAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkFoundryAssignment()} is {@code true} .
-
getWorkSmartFoundrySession
WorkSmartFoundrySession getWorkSmartFoundrySession(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage work smart foundries.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
WorkSmartFoundrySession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsWorkSmartFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsWorkSmartFoundry()} is {@code true} .
-
getCompetencyLookupSession
Gets theOsidSessionassociated with the competency lookup service.- Returns:
- a
CompetencyLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyLookup()} is {@code true} .
-
getCompetencyLookupSessionForFoundry
CompetencyLookupSession getCompetencyLookupSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the competency lookup service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CompetencyLookupSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getCompetencyQuerySession
Gets theOsidSessionassociated with the competency query service.- Returns:
- a
CompetencyQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyQuery()} is {@code true} .
-
getCompetencyQuerySessionForFoundry
CompetencyQuerySession getCompetencyQuerySessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the competency query service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CompetencyQuerySession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getCompetencySearchSession
Gets theOsidSessionassociated with the competency search service.- Returns:
- a
CompetencySearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCompetencySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencySearch()} is {@code true} .
-
getCompetencySearchSessionForFoundry
CompetencySearchSession getCompetencySearchSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the competency search service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CompetencySearchSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCompetencySearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencySearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getCompetencyAdminSession
Gets theOsidSessionassociated with the competency administration service.- Returns:
- a
CompetencyAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyAdmin()} is {@code true} .
-
getCompetencyAdminSessionForFoundry
CompetencyAdminSession getCompetencyAdminSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the competency administration service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CompetencyAdminSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getCompetencyNotificationSession
CompetencyNotificationSession getCompetencyNotificationSession(CompetencyReceiver competencyReceiver) throws OperationFailedException Gets theOsidSessionassociated with the competency notification service.- Parameters:
competencyReceiver- the notification callback- Returns:
- a
CompetencyNotificationSession - Throws:
NullArgumentException-competencyReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyNotification()} is {@code true} .
-
getCompetencyNotificationSessionForFoundry
CompetencyNotificationSession getCompetencyNotificationSessionForFoundry(CompetencyReceiver competencyReceiver, Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the competency notification service for the given foundry.- Parameters:
competencyReceiver- the notification callbackfoundryId- theIdof theFoundry- Returns:
- a
CompetencyNotificationSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-competencyReceiverorfoundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getCompetencyFoundrySession
Gets theOsidSessionto lookup competency/foundry mappings.- Returns:
- a
CompetencyFoundrySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyFoundry()} is {@code true} .
-
getCompetencyFoundryAssignmentSession
CompetencyFoundryAssignmentSession getCompetencyFoundryAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning competencies to foundries.- Returns:
- a
CompetencyFoundryAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCompetencyFoundryAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencyFoundryAssignment()} is {@code true} .
-
getCompetencySmartFoundrySession
CompetencySmartFoundrySession getCompetencySmartFoundrySession(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage competency smart foundries.- Parameters:
foundryId- theIdof the foundry- Returns:
- a
CompetencySmartFoundrySession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCompetencySmartFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCompetencySmartFoundry()} is {@code true} .
-
getAvailabilityLookupSession
Gets theOsidSessionassociated with the availability lookup service.- Returns:
- an
AvailabilityLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityLookup()} is {@code true} .
-
getAvailabilityLookupSessionForFoundry
AvailabilityLookupSession getAvailabilityLookupSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the availability lookup service for the given foundry.- Parameters:
foundryId- theIdof the foundry- Returns:
- an
AvailabilityLookupSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getAvailabilityQuerySession
Gets theOsidSessionassociated with the availability query service.- Returns:
- an
AvailabilityQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityQuery()} is {@code true} .
-
getAvailabilityQuerySessionForFoundry
AvailabilityQuerySession getAvailabilityQuerySessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the availability query service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
AvailabilityQuerySession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getAvailabilitySearchSession
Gets theOsidSessionassociated with the availability search service.- Returns:
- an
AvailabilitySearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilitySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilitySearch()} is {@code true} .
-
getAvailabilitySearchSessionForFoundry
AvailabilitySearchSession getAvailabilitySearchSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the availability search service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
AvailabilitySearchSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilitySearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilitySearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getAvailabilityAdminSession
Gets theOsidSessionassociated with the availability administration service.- Returns:
- an
AvailabilityAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityAdmin()} is {@code true} .
-
getAvailabilityAdminSessionForFoundry
AvailabilityAdminSession getAvailabilityAdminSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the availability administration service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
AvailabilityAdminSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getAvailabilityNotificationSession
AvailabilityNotificationSession getAvailabilityNotificationSession(AvailabilityReceiver availabilityReceiver) throws OperationFailedException Gets theOsidSessionassociated with the availability notification service.- Parameters:
availabilityReceiver- the notification callback- Returns:
- an
AvailabilityNotificationSession - Throws:
NullArgumentException-availabilityReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityNotification()} is {@code true} .
-
getAvailabilityNotificationSessionForFoundry
AvailabilityNotificationSession getAvailabilityNotificationSessionForFoundry(AvailabilityReceiver availabilityReceiver, Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the availability notification service for the given foundry.- Parameters:
availabilityReceiver- the notification callbackfoundryId- theIdof theFoundry- Returns:
- an
AvailabilityNotificationSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-availabilityReceiverorfoundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getAvailabilityFoundrySession
Gets theOsidSessionto lookup availability/foundry mappings.- Returns:
- an
AvailabilityFoundrySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityFoundry()} is {@code true} .
-
getAvailabilityFoundryAssignmentSession
AvailabilityFoundryAssignmentSession getAvailabilityFoundryAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning availabilities to foundries.- Returns:
- an
AvailabilityFoundryAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilityFoundryAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilityFoundryAssignment()} is {@code true} .
-
getAvailabilitySmartFoundrySession
AvailabilitySmartFoundrySession getAvailabilitySmartFoundrySession(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage locatin smart foundries.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
AvailabilitySmartFoundrySession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAvailabilitySmartFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAvailabilitySmartFoundry()} is {@code true} .
-
getCommissionLookupSession
Gets theOsidSessionassociated with the commission lookup service.- Returns:
- a
CommissionLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommissionLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionLookup()} is {@code true} .
-
getCommissionLookupSessionForFoundry
CommissionLookupSession getCommissionLookupSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commission lookup service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CommissionLookupSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommissionLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getCommissionQuerySession
Gets theOsidSessionassociated with the commission query service.- Returns:
- a
CommissionQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommissionQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionQuery()} is {@code true} .
-
getCommissionQuerySessionForFoundry
CommissionQuerySession getCommissionQuerySessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commission query service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CCommissionQuerySession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommissionQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getCommissionSearchSession
Gets theOsidSessionassociated with the commission search service.- Returns:
- a
CommissionSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommissionSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionSearch()} is {@code true} .
-
getCommissionSearchSessionForFoundry
CommissionSearchSession getCommissionSearchSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commission search service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CommissionSearchSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommissionSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getCommissionAdminSession
Gets theOsidSessionassociated with the commission administrative service.- Returns:
- a
CommissionAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommissionAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionAdmin()} is {@code true} .
-
getCommissionAdminSessionForFoundry
CommissionAdminSession getCommissionAdminSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commission administrative service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CommissionAdminSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommissionAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getCommissionNotificationSession
CommissionNotificationSession getCommissionNotificationSession(CommissionReceiver commissionReceiver) throws OperationFailedException Gets theOsidSessionassociated with the commission notification service.- Parameters:
commissionReceiver- the notification callback- Returns:
- a
CommissionNotificationSession - Throws:
NullArgumentException-commissionReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommissionNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionNotification()} is {@code true} .
-
getCommissionNotificationSessionForFoundry
CommissionNotificationSession getCommissionNotificationSessionForFoundry(CommissionReceiver commissionReceiver, Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the commission notification service for the given foundry.- Parameters:
commissionReceiver- the notification callbackfoundryId- theIdof theFoundry- Returns:
- a
CommissionNotificationSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-commissionReceiverorfoundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommissionNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getCommissionFoundrySession
Gets theOsidSessionto lookup commission/foundry mappings.- Returns:
- a
CommissionFoundrySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommissionFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionyFoundry()} is {@code true} .
-
getCommissionFoundryAssignmentSession
CommissionFoundryAssignmentSession getCommissionFoundryAssignmentSession() throws OperationFailedExceptionGets theOsidSessionassociated with assigning competencies to foundries.- Returns:
- a
CommissionyFoundryAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsCommissionFoundryAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionFoundryAssignment()} is {@code true} .
-
getCommissionSmartFoundrySession
CommissionSmartFoundrySession getCommissionSmartFoundrySession(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage commission smart foundries.- Parameters:
foundryId- theIdof theFoundry- Returns:
- a
CommissionSmartFoundrySession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsCommissionSmartFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsCommissionSmartFoundry()} is {@code true} .
-
getEffortLookupSession
Gets theOsidSessionassociated with the effort lookup service.- Returns:
- an
EffortLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEffortLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortLookup()} is {@code true} .
-
getEffortLookupSessionForFoundry
EffortLookupSession getEffortLookupSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the effort lookup service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
EffortLookupSession - Throws:
NotFoundException- noFoundryfound by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEffortLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getEffortQuerySession
Gets theOsidSessionassociated with the effort query service.- Returns:
- an
EffortQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEffortQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortQuery()} is {@code true} .
-
getEffortQuerySessionForFoundry
EffortQuerySession getEffortQuerySessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the effort query service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
EffortQuerySession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEffortQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getEffortSearchSession
Gets theOsidSessionassociated with the effort search service.- Returns:
- an
EffortSearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEffortSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortSearch()} is {@code true} .
-
getEffortSearchSessionForFoundry
EffortSearchSession getEffortSearchSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the effort search service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
EffortSearchSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEffortSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getEffortAdminSession
Gets theOsidSessionassociated with the effort administration service.- Returns:
- an
EffortAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEffortAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortAdmin()} is {@code true} .
-
getEffortAdminSessionForFoundry
EffortAdminSession getEffortAdminSessionForFoundry(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the effort administration service for the given foundry.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
EffortAdminSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEffortAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getEffortNotificationSession
EffortNotificationSession getEffortNotificationSession(EffortReceiver effortReceiver) throws OperationFailedException Gets theOsidSessionassociated with the effort notification service.- Parameters:
effortReceiver- the notification callback- Returns:
- an
EffortNotificationSession - Throws:
NullArgumentException-effortReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEffortNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortNotification()} is {@code true} .
-
getEffortNotificationSessionForFoundry
EffortNotificationSession getEffortNotificationSessionForFoundry(EffortReceiver effortReceiver, Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the effort notification service for the given foundry.- Parameters:
effortReceiver- the notification callbackfoundryId- theIdof theFoundry- Returns:
- an
EffortNotificationSession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-effortReceiverorfoundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEffortNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getEffortFoundrySession
Gets theOsidSessionto lookup effort/foundry mappings.- Returns:
- an
EffortFoundrySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEffortFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortFoundry()} is {@code true} .
-
getEffortFoundryAssignmentSession
Gets theOsidSessionassociated with assigning efforts to foundries.- Returns:
- an
EffortFoundryAssignmentSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsEffortFoundryAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortFoundryAssignment()} is {@code true} .
-
getEffortSmartFoundrySession
EffortFoundrySession getEffortSmartFoundrySession(Id foundryId) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage effort smart foundries.- Parameters:
foundryId- theIdof theFoundry- Returns:
- an
EffortSmartFoundrySession - Throws:
NotFoundException- no foundry found by the givenIdNullArgumentException-foundryIdisnullOperationFailedException- unable to complete requestUnimplementedException-supportsEffortSmartFoundry()isfalse- Compliance:
optional- This method must be implemented if {@code supportsEffortSmartFoundry()} is {@code true} .
-
getFoundryLookupSession
Gets theOsidSessionassociated with the foundry lookup service.- Returns:
- a
FoundryLookupSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFoundryLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFoundryLookup()} is {@code true} .
-
getFoundryQuerySession
Gets theOsidSessionassociated with the foundry query service.- Returns:
- a
FoundryQuerySession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFoundryQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFoundryQuery()} is {@code true} .
-
getFoundrySearchSession
Gets theOsidSessionassociated with the foundry search service.- Returns:
- a
FoundrySearchSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFoundrySearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFoundrySearch()} is {@code true} .
-
getFoundryAdminSession
Gets theOsidSessionassociated with the foundry administrative service.- Returns:
- a
FoundryAdminSession - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFoundryAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFoundryAdmin()} is {@code true} .
-
getFoundryNotificationSession
FoundryNotificationSession getFoundryNotificationSession(FoundryReceiver foundryReceiver) throws OperationFailedException Gets theOsidSessionassociated with the foundry notification service.- Parameters:
foundryReceiver- the notification callback- Returns:
- a
FoundryNotificationSession - Throws:
NullArgumentException-foundryReceiverisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFoundryNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFoundryNotification()} is {@code true} .
-
getFoundryHierarchySession
Gets theOsidSessionassociated with the foundry hierarchy service.- Returns:
- a
FoundryHierarchySessionfor foundries - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFoundryHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFoundryHierarchy()} is {@code true} .
-
getFoundryHierarchyDesignSession
Gets theOsidSessionassociated with the foundry hierarchy design service.- Returns:
- a
HierarchyDesignSessionfor foundries - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsFoundryHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFoundryHierarchyDesign()} is {@code true} .
-
getResourcingBatchManager
Gets theResourcingBatchManager.- Returns:
- a
ResourcingBatchManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsResourcingBatch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourcingBatch()} is {@code true} .
-
getResourcingRulesManager
Gets theResourcingRulesManager.- Returns:
- a
ResourcingRulesManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsResourcingRules()isfalse- Compliance:
optional- This method must be implemented if {@code supportsResourcingRules()} is {@code true} .
-