OSID - osid.hold.HoldSmartOublietteSession Service Interface Definition

Interface	osid.hold.HoldSmartOublietteSession
Implements	`osid.OsidSession`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `HoldQuery` can be retrieved from this session and oublietteped to this `Oubliette` to create a virtual collection of `Holds.` The holds may be sequenced using the `HoldSearchOrder` from this session. This `Oubliette` has a default query that matches any hold and a default search order that specifies no sequencing. The queries may be examined using a `HoldQueryInspector.` The query may be modified by converting the inspector back to a `HoldQuery.`
Method	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSmartOubliettes
Description	Tests if this user can manage smart oubliettes. 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 oubliette management is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHoldQuery
Description	Gets a hold query.
Return	`osid.hold.HoldQuery`		the hold query
Compliance	`mandatory`		This method must be implemented.
Method	getHoldSearchOrder
Description	Gets a hold search order.
Return	`osid.hold.HoldSearchOrder`		the hold search order
Compliance	`mandatory`		This method must be implemented.
Method	applyHoldQuery
Description	Applies a hold query to this oubliette.
Parameters	`osid.hold.HoldQuery`	`holdQuery`	the hold query
Errors	NULL_ARGUMENT		`holdQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`holdQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectHoldQuery
Description	Gets a hold query inspector for this oubliette.
Return	`osid.hold.HoldQueryInspector`		the hold query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyHoldSequencing
Description	Applies a hold search order to this oubliette.
Parameters	`osid.hold.HoldSearchOrder`	`holdSearchOrder`	the hold search order
Errors	NULL_ARGUMENT		`holdSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`holdSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getHoldQueryFromInspector
Description	Gets a hold query from an inspector.
Parameters	`osid.hold.HoldQueryInspector`	`holdQueryInspector`	a hold query inspector
Return	`osid.hold.HoldQuery`		the hold query
Errors	NULL_ARGUMENT		`holdQueryInspector` is `null`
Errors	UNSUPPORTED		`holdQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.