OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Interfaceosid.personnel.PositionSearchSession
Implementsosid.personnel.PositionQuerySession
Used Byosid.personnel.PersonnelManager
osid.personnel.PersonnelProxyManager
Description

This session provides methods for searching Position objects. The search query is constructed using the PositionQuery . The position record Type also specifies the record for the position query.

getPositionsByQuery() is the basic search method and returns a list of Position elements. A more advanced search may be performed with getPositionsBySearch() .It accepts a PositionSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getPositionsBySearch() returns a PositionSearchResults that can be used to access the resulting PositionList or be used to perform a search within the result set through PositionSearch .

This session defines views that offer differing behaviors for searching.

  • federated realm view: searches include positions in realms of which this realm is an ancestor in the realm hierarchy
  • isolated realm view: searches are restricted to positions in this realm

Positions may have a query record indicated by their respective record types. The query record is accessed via the PositionQuery . The returns in this session may not be cast directly to these interfaces.

MethodgetPositionSearch
Description

Gets a position search.

Returnosid.personnel.PositionSearchthe position search
CompliancemandatoryThis method must be implemented.
MethodgetPositionSearchOrder
Description

Gets a position search order. The PositionSearchOrder is supplied to a PositionSearch to specify the ordering of results.

Returnosid.personnel.PositionSearchOrderthe position search order
CompliancemandatoryThis method must be implemented.
MethodgetPositionsBySearch
Description

Gets the search results matching the given search.

Parametersosid.personnel.PositionQuerypositionQuerythe position query
osid.personnel.PositionSearchpositionSearchthe position search
Returnosid.personnel.PositionSearchResultsthe search results
ErrorsNULL_ARGUMENTpositionQuery or positionSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDpositionQuery or positionSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetPositionQueryFromInspector
Description

Gets a position query from an inspector. The inspector is available from a PositionSearchResults .

Parametersosid.personnel.PositionQueryInspectorpositionQueryInspectora position query inspector
Returnosid.personnel.PositionQuerythe position query
ErrorsNULL_ARGUMENTpositionQueryInspector is null
UNSUPPORTEDpositionQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.