OSID - osid.voting.rules.BallotConstrainerLookupSession Service Interface Definition

Interface	osid.voting.rules.BallotConstrainerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `BallotConstrainers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated polls view: All ballot constrainer methods in this session operate, retrieve and pertain to ballot constrainer defined explicitly in the current polls. Using an isolated view is useful for managing `BallotConstrainers` with the `BallotConstrainerAdminSession.` federated polls view: All ballot constrainer methods in this session operate, retrieve and pertain to all ballot constrainer defined in this polls and any other ballot constrainer implicitly available in this polls through polls inheritence. active ballot constrainer view: All ballot constrainer lookup methods return active ballot constrainers. any status authorization enabler view: Ballit constrainers of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedPollsView()` and `useIsolatedPollsView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getPollsId
Description	Gets the `Polls` `Id` associated with this session.
Return	`osid.id.Id`		the `Polls Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPolls
Description	Gets the `Polls` associated with this session.
Return	`osid.voting.Polls`		the polls
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupBallotConstrainers
Description	Tests if this user can perform `BallotConstrainers` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeBallotConstrainerView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryBallotConstrainerView
Description	A complete view of the `BallotConstrainer` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedPollsView
Description	Federates the view for methods in this session. A federated view will include ballot constrainer in polls which are children of this polls in the polls hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPollsView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this polls only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveBallotConstrainerView
Description	Only active ballot constrainers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusBallotConstrainerView
Description	All active and inactive ballot constrainers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getBallotConstrainer
Description	Gets the `BallotConstrainer` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `BallotConstrainer` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `BallotConstrainer` and retained for compatibility. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
Parameters	`osid.id.Id`	`ballotConstrainerId`	`Id` of the `BallotConstrainer`
Return	`osid.voting.rules.BallotConstrainer`		the ballot constrainer
Errors	NOT_FOUND		`ballotConstrainerId` not found
	NULL_ARGUMENT		`ballotConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getBallotConstrainersByIds
Description	Gets a `BallotConstrainerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the ballot constrainer specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `BallotConstrainers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
Parameters	`osid.id.IdList`	`ballotConstrainerIds`	the list of `Ids` to retrieve
Return	`osid.voting.rules.BallotConstrainerList`		the returned `BallotConstrainer` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`ballotConstrainerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainersByGenusType
Description	Gets a `BallotConstrainerList` corresponding to the given ballot constrainer genus `Type` which does not include ballot constrainer of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known ballot constrainer or an error results. Otherwise, the returned list may contain only those ballot constrainer that are accessible through this session. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
Parameters	`osid.type.Type`	`ballotConstrainerGenusType`	a ballot constrainer genus type
Return	`osid.voting.rules.BallotConstrainerList`		the returned `BallotConstrainer` list
Errors	NULL_ARGUMENT		`ballotConstrainerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainersByParentGenusType
Description	Gets a `BallotConstrainerList` corresponding to the given ballot constrainer genus `Type` and include any additional ballot constrainer with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known ballot constrainer or an error results. Otherwise, the returned list may contain only those ballot constrainer that are accessible through this session. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
Parameters	`osid.type.Type`	`ballotConstrainerGenusType`	a ballot constrainer genus type
Return	`osid.voting.rules.BallotConstrainerList`		the returned `BallotConstrainer` list
Errors	NULL_ARGUMENT		`ballotConstrainerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainersByRecordType
Description	Gets a `BallotConstrainerList` containing the given ballot constrainer record `Type.` In plenary mode, the returned list contains all known ballot constrainer or an error results. Otherwise, the returned list may contain only those ballot constrainer that are accessible through this session. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
Parameters	`osid.type.Type`	`ballotConstrainerRecordType`	a ballot constrainer record type
Return	`osid.voting.rules.BallotConstrainerList`		the returned `BallotConstrainer` list
Errors	NULL_ARGUMENT		`ballotConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainers
Description	Gets all `BallotConstrainers.` In plenary mode, the returned list contains all known ballot constrainer or an error results. Otherwise, the returned list may contain only those ballot constrainer that are accessible through this session. In active mode, ballot constrainers are returned that are currently active. In any status mode, active and inactive ballot constrainers are returned.
Return	`osid.voting.rules.BallotConstrainerList`		the returned `BallotConstrainer` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.