Interface ResourcingProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, ResourcingProfile, Sourceable

public interface ResourcingProxyManager
extends OsidProxyManager, ResourcingProfile

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

Methods inherited from interface Closeable

close

Methods inherited from interface OsidProfile

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

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

Methods inherited from interface OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getAvailabilityRecordTypes()	Gets the supported Availability record types.
TypeList	getAvailabilitySearchRecordTypes()	Gets the supported Availability search types.
TypeList	getCommissionRecordTypes()	Gets the supported Commission record types.
TypeList	getCommissionSearchRecordTypes()	Gets the supported Commission search record types.
TypeList	getCompetencyRecordTypes()	Gets the supported Competency record types.
TypeList	getCompetencySearchRecordTypes()	Gets the supported Competency search record types.
TypeList	getEffortRecordTypes()	Gets the supported Effort record types.
TypeList	getEffortSearchRecordTypes()	Gets the supported Effort search types.
TypeList	getFoundryRecordTypes()	Gets the supported Foundry record types.
TypeList	getFoundrySearchRecordTypes()	Gets the supported Foundry search record types.
TypeList	getJobRecordTypes()	Gets the supported Job record types.
TypeList	getJobSearchRecordTypes()	Gets the supported Job search record types.
TypeList	getWorkRecordTypes()	Gets the supported Work record types.
TypeList	getWorkSearchRecordTypes()	Gets the supported Work search record types.
boolean	supportsAvailabilityAdmin()	Tests if availability administrative service is supported.
boolean	supportsAvailabilityFoundry()	Tests if an availability foundry lookup service is supported.
boolean	supportsAvailabilityFoundryAssignment()	Tests if an availability foundry assignment service is supported.
boolean	supportsAvailabilityLookup()	Tests if looking up availabilities is supported.
boolean	supportsAvailabilityNotification()	Tests if an availability notification service is supported.
boolean	supportsAvailabilityQuery()	Tests if querying availabilities is supported.
boolean	supportsAvailabilityRecordType(Type availabilityRecordType)	Tests if the given Availability record type is supported.
boolean	supportsAvailabilitySearch()	Tests if searching availabilities is supported.
boolean	supportsAvailabilitySearchRecordType(Type availabilitySearchRecordType)	Tests if the given Availability search type is supported.
boolean	supportsAvailabilitySmartFoundry()	Tests if an availability smart foundry service is supported.
boolean	supportsCommissionAdmin()	Tests if commission administrative service is supported.
boolean	supportsCommissionFoundry()	Tests if a commission foundry lookup service is supported.
boolean	supportsCommissionFoundryAssignment()	Tests if a commission foundry service is supported.
boolean	supportsCommissionLookup()	Tests if looking up commissions is supported.
boolean	supportsCommissionNotification()	Tests if a commission notification service is supported.
boolean	supportsCommissionQuery()	Tests if querying commissions is supported.
boolean	supportsCommissionRecordType(Type commissionRecordType)	Tests if the given Commission record type is supported.
boolean	supportsCommissionSearch()	Tests if searching commissions is supported.
boolean	supportsCommissionSearchRecordType(Type commissionSearchRecordType)	Tests if the given Commission search record type is supported.
boolean	supportsCommissionSmartFoundry()	Tests if a commission smart foundry lookup service is supported.
boolean	supportsCompetencyAdmin()	Tests if competency administrative service is supported.
boolean	supportsCompetencyFoundry()	Tests if a competency foundry lookup service is supported.
boolean	supportsCompetencyFoundryAssignment()	Tests if a competency foundry service is supported.
boolean	supportsCompetencyLookup()	Tests if looking up competencies is supported.
boolean	supportsCompetencyNotification()	Tests if a competency notification service is supported.
boolean	supportsCompetencyQuery()	Tests if querying competencies is supported.
boolean	supportsCompetencyRecordType(Type competencyRecordType)	Tests if the given Competency record type is supported.
boolean	supportsCompetencySearch()	Tests if searching competencies is supported.
boolean	supportsCompetencySearchRecordType(Type competencySearchRecordType)	Tests if the given Competency search record type is supported.
boolean	supportsCompetencySmartFoundry()	Tests if a competency smart foundry lookup service is supported.
boolean	supportsEffortAdmin()	Tests if an effort administrative service is supported.
boolean	supportsEffortFoundry()	Tests if an effort foundry lookup service is supported.
boolean	supportsEffortFoundryAssignment()	Tests if an effort foundry assignment service is supported.
boolean	supportsEffortLookup()	Tests if looking up efforts is supported.
boolean	supportsEffortNotification()	Tests if an effort notification service is supported.
boolean	supportsEffortQuery()	Tests if querying efforts is supported.
boolean	supportsEffortRecordType(Type effortRecordType)	Tests if the given Effort record type is supported.
boolean	supportsEffortSearch()	Tests if searching efforts is supported.
boolean	supportsEffortSearchRecordType(Type effortSearchRecordType)	Tests if the given Effort search type is supported.
boolean	supportsEffortSmartFoundry()	Tests if an effort smart foundry service is supported.
boolean	supportsFoundryAdmin()	Tests if foundry administrative service is supported.
boolean	supportsFoundryHierarchy()	Tests for the availability of a foundry hierarchy traversal service.
boolean	supportsFoundryHierarchyDesign()	Tests for the availability of a foundry hierarchy design service.
boolean	supportsFoundryLookup()	Tests if looking up foundries is supported.
boolean	supportsFoundryNotification()	Tests if a foundry notification service is supported.
boolean	supportsFoundryQuery()	Tests if querying foundries is supported.
boolean	supportsFoundryRecordType(Type foundryRecordType)	Tests if the given Foundry record type is supported.
boolean	supportsFoundrySearch()	Tests if searching foundries is supported.
boolean	supportsFoundrySearchRecordType(Type foundrySearchRecordType)	Tests if the given Foundry search record type is supported.
boolean	supportsJobAdmin()	Tests if job administrative service is supported.
boolean	supportsJobFoundry()	Tests if a job foundry lookup service is supported.
boolean	supportsJobFoundryAssignment()	Tests if a job foundry service is supported.
boolean	supportsJobLookup()	Tests if looking up jobs is supported.
boolean	supportsJobNotification()	Tests if a job notification service is supported.
boolean	supportsJobQuery()	Tests if querying jobs is supported.
boolean	supportsJobRecordType(Type jobRecordType)	Tests if the given Job record type is supported.
boolean	supportsJobSearch()	Tests if searching jobs is supported.
boolean	supportsJobSearchRecordType(Type jobSearchRecordType)	Tests if the given Job search record type is supported.
boolean	supportsJobSmartFoundry()	Tests if a job smart foundry lookup service is supported.
boolean	supportsMyWork()	Tests if an availability service is supported for the current agent.
boolean	supportsResourcingBatch()	Tests for the availability of a resourcing batch service.
boolean	supportsResourcingRules()	Tests for the availability of a resourcing rules service.
boolean	supportsVisibleFederation()	Tests if any foundry federation is exposed.
boolean	supportsWorkAdmin()	Tests if work administrative service is supported.
boolean	supportsWorkFoundry()	Tests if a work foundry lookup service is supported.
boolean	supportsWorkFoundryAssignment()	Tests if a work foundry service is supported.
boolean	supportsWorkLookup()	Tests if looking up work is supported.
boolean	supportsWorkNotification()	Tests if a work notification service is supported.
boolean	supportsWorkQuery()	Tests if querying work is supported.
boolean	supportsWorkRecordType(Type workRecordType)	Tests if the given Work record type is supported.
boolean	supportsWorkSearch()	Tests if searching work is supported.
boolean	supportsWorkSearchRecordType(Type workSearchRecordType)	Tests if the given Work search record type is supported.
boolean	supportsWorkSmartFoundry()	Tests if a work smart foundry lookup service is supported.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

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

Method Details

getMyWorkSession

MyWorkSession getMyWorkSession(Proxy proxy)
                        throws OperationFailedException

Gets the OsidSession associated with the my work service.

Parameters:

proxy - a proxy

Returns:

a MyWorkSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyWork() is false

Compliance:

optional - This method must be implemented if {@code supportsMyWork()} is {@code true} .

getMyWorkSessionForFoundry

MyWorkSession getMyWorkSessionForFoundry(Id foundryId,
 Proxy proxy)
                                  throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the foundry

proxy - a proxy

Returns:

a MyWorkSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyWork() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsMyWork()} and {@code supportsVisibleFederation()} are {@code true}

getJobLookupSession

JobLookupSession getJobLookupSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the job lookup service.

Parameters:

proxy - a proxy

Returns:

a JobLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsJobLookup()} is {@code true} .

getJobLookupSessionForFoundry

JobLookupSession getJobLookupSessionForFoundry(Id foundryId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a JobLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsJobLookup()} and {@code supportsVisibleFederation()} are {@code true}

getJobQuerySession

JobQuerySession getJobQuerySession(Proxy proxy)
                            throws OperationFailedException

Gets the OsidSession associated with the job query service.

Parameters:

proxy - a proxy

Returns:

a JobQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsJobQuery()} is {@code true} .

getJobQuerySessionForFoundry

JobQuerySession getJobQuerySessionForFoundry(Id foundryId,
 Proxy proxy)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a JobQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsJobQuery()} and {@code supportsVisibleFederation()} are {@code true}

getJobSearchSession

JobSearchSession getJobSearchSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the job search service.

Parameters:

proxy - a proxy

Returns:

a JobSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsJobSearch()} is {@code true} .

getJobSearchSessionForFoundry

JobSearchSession getJobSearchSessionForFoundry(Id foundryId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a JobSearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsJobSearch()} and {@code supportsVisibleFederation()} are {@code true}

getJobAdminSession

JobAdminSession getJobAdminSession(Proxy proxy)
                            throws OperationFailedException

Gets the OsidSession associated with the job administration service.

Parameters:

proxy - a proxy

Returns:

a JobAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsJobAdmin()} is {@code true} .

getJobAdminSessionForFoundry

JobAdminSession getJobAdminSessionForFoundry(Id foundryId,
 Proxy proxy)
                                      throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a JobAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsJobAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getJobNotificationSession

JobNotificationSession getJobNotificationSession(JobReceiver jobReceiver,
 Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the job notification service.

Parameters:

jobReceiver - the notification callback

proxy - a proxy

Returns:

a JobNotificationSession

Throws:

NullArgumentException - jobReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsJobNotification()} is {@code true} .

getJobNotificationSessionForFoundry

JobNotificationSession getJobNotificationSessionForFoundry(JobReceiver jobReceiver,
 Id foundryId,
 Proxy proxy)
                                                    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

proxy - a proxy

Returns:

a JobNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - jobReceiver, foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsJobNotification()} and {@code supportsVisibleFederation()} are {@code true}

getJobFoundrySession

JobFoundrySession getJobFoundrySession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession to lookup job/foundry mappings.

Parameters:

proxy - a proxy

Returns:

a JobFoundrySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsJobFoundry()} is {@code true} .

getJobFoundryAssignmentSession

JobFoundryAssignmentSession getJobFoundryAssignmentSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with assigning jobs to foundries.

Parameters:

proxy - a proxy

Returns:

a JobFoundryAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobFoundryAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsJobFoundryAssignment()} is {@code true} .

getJobSmartFoundrySession

JobSmartFoundrySession getJobSmartFoundrySession(Id foundryId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage job smart foundries.

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a JobSmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsJobSmartFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsJobSmartFoundry()} is {@code true} .

getWorkLookupSession

WorkLookupSession getWorkLookupSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the work lookup service.

Parameters:

proxy - a proxy

Returns:

a WorkLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkLookup()} is {@code true} .

getWorkLookupSessionForFoundry

WorkLookupSession getWorkLookupSessionForFoundry(Id foundryId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a WorkLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkLookup()} and {@code supportsVisibleFederation()} are {@code true}

getWorkQuerySession

WorkQuerySession getWorkQuerySession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the work query service.

Parameters:

proxy - a proxy

Returns:

a WorkQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkQuery()} is {@code true} .

getWorkQuerySessionForFoundry

WorkQuerySession getWorkQuerySessionForFoundry(Id foundryId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a WorkQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkQuery()} and {@code supportsVisibleFederation()} are {@code true}

getWorkSearchSession

WorkSearchSession getWorkSearchSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the work search service.

Parameters:

proxy - a proxy

Returns:

a WorkSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkSearch()} is {@code true} .

getWorkSearchSessionForFoundry

WorkSearchSession getWorkSearchSessionForFoundry(Id foundryId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a WorkSearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkSearch()} and {@code supportsVisibleFederation()} are {@code true}

getWorkAdminSession

WorkAdminSession getWorkAdminSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the work administration service.

Parameters:

proxy - a proxy

Returns:

a WorkAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkAdmin()} is {@code true} .

getWorkAdminSessionForFoundry

WorkAdminSession getWorkAdminSessionForFoundry(Id foundryId,
 Proxy proxy)
                                        throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a WorkAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getWorkNotificationSession

WorkNotificationSession getWorkNotificationSession(WorkReceiver workReceiver,
 Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the work notification service.

Parameters:

workReceiver - the notification callback

proxy - a proxy

Returns:

a WorkNotificationSession

Throws:

NullArgumentException - workReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkNotification()} is {@code true} .

getWorkNotificationSessionForFoundry

WorkNotificationSession getWorkNotificationSessionForFoundry(WorkReceiver workReceiver,
 Id foundryId,
 Proxy proxy)
                                                      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

proxy - a proxy

Returns:

a WorkNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - workReceiver, foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkNotification()} and {@code supportsVisibleFederation()} are {@code true}

getWorkFoundrySession

WorkFoundrySession getWorkFoundrySession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession to lookup work/foundry mappings.

Parameters:

proxy - a proxy

Returns:

a WorkFoundrySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkFoundry()} is {@code true} .

getWorkFoundryAssignmentSession

WorkFoundryAssignmentSession getWorkFoundryAssignmentSession(Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with assigning work to foundries.

Parameters:

proxy - a proxy

Returns:

a WorkFoundryAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkbFoundryAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkFoundryAssignment()} is {@code true} .

getWorkSmartFoundrySession

WorkSmartFoundrySession getWorkSmartFoundrySession(Id foundryId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage work smart foundries.

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a WorkSmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - no Foundry found by the given Id

OperationFailedException - unable to complete request

UnimplementedException - supportsWorkSmartFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsWorkSmartFoundry()} is {@code true} .

getCompetencyLookupSession

CompetencyLookupSession getCompetencyLookupSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the competency lookup service.

Parameters:

proxy - a proxy

Returns:

a CompetencyLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyLookup()} is {@code true} .

getCompetencyLookupSessionForFoundry

CompetencyLookupSession getCompetencyLookupSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CompetencyLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyLookup()} and {@code supportsVisibleFederation()} are {@code true}

getCompetencyQuerySession

CompetencyQuerySession getCompetencyQuerySession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the competency query service.

Parameters:

proxy - a proxy

Returns:

a CompetencyQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyQuery()} is {@code true} .

getCompetencyQuerySessionForFoundry

CompetencyQuerySession getCompetencyQuerySessionForFoundry(Id foundryId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CompetencyQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyQuery()} and {@code supportsVisibleFederation()} are {@code true}

getCompetencySearchSession

CompetencySearchSession getCompetencySearchSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the competency search service.

Parameters:

proxy - a proxy

Returns:

a CompetencySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencySearch()} is {@code true} .

getCompetencySearchSessionForFoundry

CompetencySearchSession getCompetencySearchSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CompetencySearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencySearch()} and {@code supportsVisibleFederation()} are {@code true}

getCompetencyAdminSession

CompetencyAdminSession getCompetencyAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the competency administration service.

Parameters:

proxy - a proxy

Returns:

a CompetencyAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyAdmin()} is {@code true} .

getCompetencyAdminSessionForFoundry

CompetencyAdminSession getCompetencyAdminSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CompetencyAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getCompetencyNotificationSession

CompetencyNotificationSession getCompetencyNotificationSession(CompetencyReceiver competencyReceiver,
 Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the competency notification service.

Parameters:

competencyReceiver - the notification callback

proxy - a proxy

Returns:

a CompetencyNotificationSession

Throws:

NullArgumentException - competencyReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyNotification()} is {@code true} .

getCompetencyNotificationSessionForFoundry

CompetencyNotificationSession getCompetencyNotificationSessionForFoundry(CompetencyReceiver competencyReceiver,
 Id foundryId,
 Proxy proxy)
                                                                  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

proxy - a proxy

Returns:

a CompetencyNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - competencyReceiver, foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyNotification()} and {@code supportsVisibleFederation()} are {@code true}

getCompetencyFoundrySession

CompetencyFoundrySession getCompetencyFoundrySession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession to lookup competency/foundry mappings.

Parameters:

proxy - a proxy

Returns:

a CompetencyFoundrySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyFoundry()} is {@code true} .

getCompetencyFoundryAssignmentSession

CompetencyFoundryAssignmentSession getCompetencyFoundryAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning competencies to foundries.

Parameters:

proxy - a proxy

Returns:

a CompetencyFoundryAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencyFoundryAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencyFoundryAssignment()} is {@code true} .

getCompetencySmartFoundrySession

CompetencySmartFoundrySession getCompetencySmartFoundrySession(Id foundryId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage competency smart foundries.

Parameters:

foundryId - the Id of the foundry

proxy - a proxy

Returns:

a CompetencySmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCompetencySmartFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsCompetencySmartFoundry()} is {@code true} .

getAvailabilityLookupSession

AvailabilityLookupSession getAvailabilityLookupSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the availability lookup service.

Parameters:

proxy - a proxy

Returns:

an AvailabilityLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityLookup()} is {@code true} .

getAvailabilityLookupSessionForFoundry

AvailabilityLookupSession getAvailabilityLookupSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the foundry

proxy - a proxy

Returns:

an AvailabilityLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityLookup()} and {@code supportsVisibleFederation()} are {@code true}

getAvailabilityQuerySession

AvailabilityQuerySession getAvailabilityQuerySession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the availability query service.

Parameters:

proxy - a proxy

Returns:

an AvailabilityQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityQuery()} is {@code true} .

getAvailabilityQuerySessionForFoundry

AvailabilityQuerySession getAvailabilityQuerySessionForFoundry(Id foundryId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an AvailabilityQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityQuery()} and {@code supportsVisibleFederation()} are {@code true}

getAvailabilitySearchSession

AvailabilitySearchSession getAvailabilitySearchSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the availability search service.

Parameters:

proxy - a proxy

Returns:

an AvailabilitySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilitySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilitySearch()} is {@code true} .

getAvailabilitySearchSessionForFoundry

AvailabilitySearchSession getAvailabilitySearchSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an AvailabilitySearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilitySearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilitySearch()} and {@code supportsVisibleFederation()} are {@code true}

getAvailabilityAdminSession

AvailabilityAdminSession getAvailabilityAdminSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the availability administration service.

Parameters:

proxy - a proxy

Returns:

an AvailabilityAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityAdmin()} is {@code true} .

getAvailabilityAdminSessionForFoundry

AvailabilityAdminSession getAvailabilityAdminSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an AvailabilityAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getAvailabilityNotificationSession

AvailabilityNotificationSession getAvailabilityNotificationSession(AvailabilityReceiver availabilityReceiver,
 Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the availability notification service.

Parameters:

availabilityReceiver - the notification callback

proxy - a proxy

Returns:

an AvailabilityNotificationSession

Throws:

NullArgumentException - availabilityReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityNotification()} is {@code true} .

getAvailabilityNotificationSessionForFoundry

AvailabilityNotificationSession getAvailabilityNotificationSessionForFoundry(AvailabilityReceiver availabilityReceiver,
 Id foundryId,
 Proxy proxy)
                                                                      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

proxy - a proxy

Returns:

an AvailabilityNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - availabilityReceiver , foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityNotification()} and {@code supportsVisibleFederation()} are {@code true}

getAvailabilityFoundrySession

AvailabilityFoundrySession getAvailabilityFoundrySession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession to lookup availability/foundry mappings.

Parameters:

proxy - a proxy

Returns:

an AvailabilityFoundrySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityFoundry()} is {@code true} .

getAvailabilityFoundryAssignmentSession

AvailabilityFoundryAssignmentSession getAvailabilityFoundryAssignmentSession(Proxy proxy)
                                                                      throws OperationFailedException

Gets the OsidSession associated with assigning availabilities to foundries.

Parameters:

proxy - a proxy

Returns:

an AvailabilityFoundryAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilityFoundryAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilityFoundryAssignment()} is {@code true} .

getAvailabilitySmartFoundrySession

AvailabilitySmartFoundrySession getAvailabilitySmartFoundrySession(Id foundryId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart foundries.

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an AvailabilitySmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAvailabilitySmartFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsAvailabilitySmartFoundry()} is {@code true} .

getCommissionLookupSession

CommissionLookupSession getCommissionLookupSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the commission lookup service.

Parameters:

proxy - a proxy

Returns:

a CommissionLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionLookup()} is {@code true} .

getCommissionLookupSessionForFoundry

CommissionLookupSession getCommissionLookupSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CommissionLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionLookup()} and {@code supportsVisibleFederation()} are {@code true}

getCommissionQuerySession

CommissionQuerySession getCommissionQuerySession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the commission query service.

Parameters:

proxy - a proxy

Returns:

a CommissionQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionQuery()} is {@code true} .

getCommissionQuerySessionForFoundry

CommissionQuerySession getCommissionQuerySessionForFoundry(Id foundryId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CommissionQuerySession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionQuery()} and {@code supportsVisibleFederation()} are {@code true}

getCommissionSearchSession

CommissionSearchSession getCommissionSearchSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the commission search service.

Parameters:

proxy - a proxy

Returns:

a CommissionSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionSearch()} is {@code true} .

getCommissionSearchSessionForFoundry

CommissionSearchSession getCommissionSearchSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                      throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CommissionSearchSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionSearch()} and {@code supportsVisibleFederation()} are {@code true}

getCommissionAdminSession

CommissionAdminSession getCommissionAdminSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the commission administrative service.

Parameters:

proxy - a proxy

Returns:

a CommissionAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionAdmin()} is {@code true} .

getCommissionAdminSessionForFoundry

CommissionAdminSession getCommissionAdminSessionForFoundry(Id foundryId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CommissionAdminSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getCommissionNotificationSession

CommissionNotificationSession getCommissionNotificationSession(CommissionReceiver commissionReceiver,
 Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the commission notification service.

Parameters:

commissionReceiver - the notification callback

proxy - a proxy

Returns:

a CommissionNotificationSession

Throws:

NullArgumentException - commissionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionNotification()} is {@code true} .

getCommissionNotificationSessionForFoundry

CommissionNotificationSession getCommissionNotificationSessionForFoundry(CommissionReceiver commissionReceiver,
 Id foundryId,
 Proxy proxy)
                                                                  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

proxy - a proxy

Returns:

a CommissionNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - commissionReceiver, foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionNotification()} and {@code supportsVisibleFederation()} are {@code true}

getCommissionFoundrySession

CommissionFoundrySession getCommissionFoundrySession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession to lookup commission/foundry mappings.

Parameters:

proxy - a proxy

Returns:

a CommissionFoundrySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionyFoundry()} is {@code true} .

getCommissionFoundryAssignmentSession

CommissionFoundryAssignmentSession getCommissionFoundryAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the OsidSession associated with assigning competencies to foundries.

Parameters:

proxy - a proxy

Returns:

a CommissionyFoundryAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionFoundryAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionFoundryAssignment()} is {@code true} .

getCommissionSmartFoundrySession

CommissionSmartFoundrySession getCommissionSmartFoundrySession(Id foundryId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage commission smart foundries.

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

a CommissionSmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommissionSmartFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsCommissionSmartFoundry()} is {@code true} .

getEffortLookupSession

EffortLookupSession getEffortLookupSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the effort lookup service.

Parameters:

proxy - a proxy

Returns:

an EffortLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortLookup()} is {@code true} .

getEffortLookupSessionForFoundry

EffortLookupSession getEffortLookupSessionForFoundry(Id foundryId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an EffortLookupSession

Throws:

NotFoundException - no Foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortLookup()} and {@code supportsVisibleFederation()} are {@code true}

getEffortQuerySession

EffortQuerySession getEffortQuerySession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the effort query service.

Parameters:

proxy - a proxy

Returns:

an EffortQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortQuery()} is {@code true} .

getEffortQuerySessionForFoundry

EffortQuerySession getEffortQuerySessionForFoundry(Id foundryId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an EffortQuerySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortQuery()} and {@code supportsVisibleFederation()} are {@code true}

getEffortSearchSession

EffortSearchSession getEffortSearchSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the effort search service.

Parameters:

proxy - a proxy

Returns:

an EffortSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortSearch()} is {@code true} .

getEffortSearchSessionForFoundry

EffortSearchSession getEffortSearchSessionForFoundry(Id foundryId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an EffortSearchSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortSearch()} and {@code supportsVisibleFederation()} are {@code true}

getEffortAdminSession

EffortAdminSession getEffortAdminSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the effort administration service.

Parameters:

proxy - a proxy

Returns:

an EffortAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortAdmin()} is {@code true} .

getEffortAdminSessionForFoundry

EffortAdminSession getEffortAdminSessionForFoundry(Id foundryId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

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

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an EffortAdminSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getEffortNotificationSession

EffortNotificationSession getEffortNotificationSession(EffortReceiver effortReceiver,
 Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the effort notification service.

Parameters:

effortReceiver - the notification callback

proxy - a proxy

Returns:

an EffortNotificationSession

Throws:

NullArgumentException - effortReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortNotification()} is {@code true} .

getEffortNotificationSessionForFoundry

EffortNotificationSession getEffortNotificationSessionForFoundry(EffortReceiver effortReceiver,
 Id foundryId,
 Proxy proxy)
                                                          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

proxy - a proxy

Returns:

an EffortNotificationSession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - effortReceiver, foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortNotification()} and {@code supportsVisibleFederation()} are {@code true}

getEffortFoundrySession

EffortFoundrySession getEffortFoundrySession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession to lookup effort/foundry mappings.

Parameters:

proxy - a proxy

Returns:

an EffortFoundrySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortFoundry()} is {@code true} .

getEffortFoundryAssignmentSession

EffortFoundryAssignmentSession getEffortFoundryAssignmentSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with assigning efforts to foundries.

Parameters:

proxy - a proxy

Returns:

an EffortFoundryAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortFoundryAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortFoundryAssignment()} is {@code true} .

getEffortSmartFoundrySession

EffortFoundrySession getEffortSmartFoundrySession(Id foundryId,
 Proxy proxy)
                                           throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage effort smart foundries.

Parameters:

foundryId - the Id of the Foundry

proxy - a proxy

Returns:

an EffortSmartFoundrySession

Throws:

NotFoundException - no foundry found by the given Id

NullArgumentException - foundryId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsEffortSmartFoundry() is false

Compliance:

optional - This method must be implemented if {@code supportsEffortSmartFoundry()} is {@code true} .

getFoundryLookupSession

FoundryLookupSession getFoundryLookupSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the foundry lookup service.

Parameters:

proxy - a proxy

Returns:

a FoundryLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsFoundryLookup()} is {@code true} .

getFoundryQuerySession

FoundryQuerySession getFoundryQuerySession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the foundry query service.

Parameters:

proxy - a proxy

Returns:

a FoundryQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsFoundryQuery()} is {@code true} .

getFoundrySearchSession

FoundrySearchSession getFoundrySearchSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the foundry search service.

Parameters:

proxy - a proxy

Returns:

a FoundrySearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundrySearch() is false

Compliance:

optional - This method must be implemented if {@code supportsFoundrySearch()} is {@code true} .

getFoundryAdminSession

FoundryAdminSession getFoundryAdminSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the foundry administrative service.

Parameters:

proxy - a proxy

Returns:

a FoundryAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsFoundryAdmin()} is {@code true} .

getFoundryNotificationSession

FoundryNotificationSession getFoundryNotificationSession(FoundryReceiver foundryReceiver,
 Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the foundry notification service.

Parameters:

foundryReceiver - the notification callback

proxy - a proxy

Returns:

a FoundryNotificationSession

Throws:

NullArgumentException - foundryReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsFoundryNotification()} is {@code true} .

getFoundryHierarchySession

FoundryHierarchySession getFoundryHierarchySession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the foundry hierarchy service.

Parameters:

proxy - a proxy

Returns:

a FoundryHierarchySession for foundries

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsFoundryHierarchy()} is {@code true} .

getFoundryHierarchyDesignSession

FoundryHierarchyDesignSession getFoundryHierarchyDesignSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the OsidSession associated with the foundry hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for foundries

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFoundryHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsFoundryHierarchyDesign()} is {@code true} .

getResourcingBatchProxyManager

ResourcingBatchProxyManager getResourcingBatchProxyManager()
                                                    throws OperationFailedException

Gets the ResourcingBatchProxyManager .

Returns:

a ResourcingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsResourcingBatch()} is {@code true} .

getResourcingRulesProxyManager

ResourcingRulesProxyManager getResourcingRulesProxyManager()
                                                    throws OperationFailedException

Gets the ResourcingRulesProxyManager .

Returns:

a ResourcingRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcingRules() is false

Compliance:

optional - This method must be implemented if {@code supportsResourcingRules()} is {@code true} .