OSID Logo
OSID Specifications
voting rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.rules.BallotConstrainerEnablerSearchSession
Implementsosid.voting.rules.BallotConstrainerEnablerQuerySession
Description

This session provides methods for searching among BallotConstrainerEnabler objects. The search query is constructed using the BallotConstrainerEnableryQuery.

getBallotConstrainerEnablersByQuery() is the basic search method and returns a list of BallotConstrainerEnablers. A more advanced search may be performed with getBallotConstrainerEnablersBySearch(). It accepts a BallotConstrainerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as voting. getBallotConstrainerEnablersBySearch() returns a BallotConstrainerEnablerSearchResults that can be used to access the resulting BallotConstrainerEnablerList or be used to perform a search within the result set through BallotConstrainerEnablerSearch.

This session defines views that offer differing behaviors for searching.

  • federated polls view: searches include ballot constrainer enablers in polls of which this polls is an ancestor in the polls hierarchy
  • isolated polls view: searches are restricted to ballot constrainer enablers in this polls

BallotConstrainerEnablers may have a query record indicated by their respective record types. The query record is accessed via the BallotConstrainerEnablerQuery.

MethodgetBallotConstrainerEnablerSearch
Description

Gets a ballot constrainer enabler search.

Returnosid.voting.rules.BallotConstrainerEnablerSearchthe ballot constrainer enabler search
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablerSearchOrder
Description

Gets a ballot constrainer enabler search order. The BallotConstrainerEnablerSearchOrder is supplied to a BallotConstrainerEnablerSearch to specify the ordering of results.

Returnosid.voting.rules.BallotConstrainerEnablerSearchOrderthe ballot constrainer enabler search order
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablersBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.voting.rules.BallotConstrainerEnablerQueryballotConstrainerEnablerQuerythe ballot constrainer enabler query
osid.voting.rules.BallotConstrainerEnablerSearchballotConstrainerEnablerSearchthe ballot constrainer enabler search
Returnosid.voting.rules.BallotConstrainerEnablerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT ballotConstrainerEnablerQuery or ballotConstrainerEnablerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED ballotConstrainerEnablerQuery or ballotConstrainerEnablerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBallotConstrainerEnablerQueryFromInspector
Description

Gets a ballot constrainer enabler query from an inspector. The inspector is available from a BallotConstrainerEnablerSearchResults.

Parametersosid.voting.rules.BallotConstrainerEnablerQueryInspectorballotConstrainerEnablerQueryInspectora ballot constrainer enabler query inspector
Returnosid.voting.rules.BallotConstrainerEnablerQuerythe ballot constrainer enabler query
ErrorsNULL_ARGUMENT ballotConstrainerEnablerQueryInspector is null
UNSUPPORTED ballotConstrainerEnablerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.