| Interface | osid.resourcing.rules.JobConstrainerEnablerSearchSession | ||
|---|---|---|---|
| Implements | osid.resourcing.rules.JobConstrainerEnablerQuerySession | ||
| Used By | osid.resourcing.rules.ResourcingRulesManager | ||
osid.resourcing.rules.ResourcingRulesProxyManager | |||
| Description |
This session provides methods for searching among
getJobConstrainerEnablersByQuery() is the basic
search method and returns a list of
JobConstrainerEnablers . A more advanced search
may be performed with
getJobConstrainerEnablersBySearch() .It accepts a
JobConstrainerEnablerSearch in addition to the
query for the purpose of specifying additional options
affecting the entire search, such as resourcing.
getJobConstrainerEnablersBySearch() returns a
JobConstrainerEnablerSearchResults that can be
used to access the resulting
JobConstrainerEnablerList or be used to perform a
search within the result set through
JobConstrainerEnablerSearch .
This session defines views that offer differing behaviors for searching.
JobConstrainerEnablers may have a job constrainer
enabler query record indicated by their respective record
types. The job constrainer enabler query record is accessed
via the JobConstrainerEnablerQuery . | ||
| Method | getJobConstrainerEnablerSearch | ||
| Description |
Gets a job constrainer enabler search. | ||
| Return | osid.resourcing.rules.JobConstrainerEnablerSearch | the job constrainer enabler search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJobConstrainerEnablerSearchOrder | ||
| Description |
Gets a job constrainer enabler search order. The
| ||
| Return | osid.resourcing.rules.JobConstrainerEnablerSearchOrder | the job constrainer enabler search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getJobConstrainerEnablersBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.resourcing.rules.JobConstrainerEnablerQuery | jobConstrainerEnablerQuery | the job constrainer enabler query |
osid.resourcing.rules.JobConstrainerEnablerSearch | jobConstrainerEnablerSearch | the job constrainer enabler search | |
| Return | osid.resourcing.rules.JobConstrainerEnablerSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | jobConstrainerEnablerQuery or
jobConstrainerEnablerSearch is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | jobConstrainerEnablerQuery or
jobConstrainerEnablerSearch is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getJobConstrainerEnablerQueryFromInspector | ||
| Description |
Gets a job constrainer enabler query from an inspector.
The inspector is available from a
| ||
| Parameters | osid.resourcing.rules.JobConstrainerEnablerQueryInspector | jobConstrainerEnablerQueryInspector | a job constrainer enabler query inspector |
| Return | osid.resourcing.rules.JobConstrainerEnablerQuery | the job constrainer enabler query | |
| Errors | NULL_ARGUMENT | jobConstrainerEnablerQueryInspector is null | |
| UNSUPPORTED | jobConstrainerEnablerQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |