OSID - osid.resourcing.CompetencySmartFoundrySession Service Interface Definition

Interface	osid.resourcing.CompetencySmartFoundrySession
Implements	`osid.OsidSession`
Used By	`osid.resourcing.ResourcingManager`
Used By	`osid.resourcing.ResourcingProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `CompetencyQuery` can be retrieved from this session and mapped to this `Foundry` to create a virtual collection of competencies. The competencies may be sequenced using the `CompetencySearchOrder` from this session. This `Foundry` has a default query that matches any competency and a default search order that specifies no sequencing. The queries may be examined using a `CompetencyQueryInspector`. The query may be modified by converting the inspector back to a `CompetencyQuery`.
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartFoundries
Description	Tests if this user can manage smart foundries. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart foundry management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompetencyQuery
Description	Gets a competency query.
Return	`osid.resourcing.CompetencyQuery`		the competency query
Compliance	`mandatory`		This method must be implemented.
Method	getCompetencySearchOrder
Description	Gets a competency search order.
Return	`osid.resourcing.CompetencySearchOrder`		the competency search order
Compliance	`mandatory`		This method must be implemented.
Method	applyCompetencyQuery
Description	Applies a competency query to this foundry.
Parameters	`osid.resourcing.CompetencyQuery`	`competencyQuery`	the competency query
Errors	NULL_ARGUMENT		`competencyQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`competencyQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspecCompetencyQuery
Description	Gets a competency query inspector for this foundry.
Return	`osid.resourcing.CompetencyQueryInspector`		the competency query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyCompetencySequencing
Description	Applies a competency search order to this foundry.
Parameters	`osid.resourcing.CompetencySearchOrder`	`competencySearchOrder`	the competency search order
Errors	NULL_ARGUMENT		`competencySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`competencySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getCompetencyQueryFromInspector
Description	Gets a competency query from an inspector.
Parameters	`osid.resourcing.CompetencyQueryInspector`	`competencyQueryInspector`	a competency query inspector
Return	`osid.resourcing.CompetencyQuery`		the competency query
Errors	NULL_ARGUMENT		`competencyQueryInspector` is `null`
Errors	UNSUPPORTED		`competencyQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.