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

Interface	osid.voting.rules.BallotConstrainerEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `BallotConstrainerEnablers.` 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 enabler methods in this session operate, retrieve and pertain to ballot constrainer enablers defined explicitly in the current polls. Using an isolated view is useful for managing `BallotConstrainerEnablers` with the `BallotConstrainerEnablerAdminSession.` federated polls view: All ballot constrainer enabler methods in this session operate, retrieve and pertain to all ballot constrainer enablers defined in this polls and any other ballot constrainer enablers implicitly available in this polls through polls inheritence. active ballot constrainer enabler view: All ballot constrainer enabler lookup methods return active ballot constrainer enablers. any status ballot constrainer enabler view: Ballot constrainer enablers 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	canLookupBallotConstrainerEnablers
Description	Tests if this user can perform `BallotConstrainerEnablers` 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	useComparativeBallotConstrainerEnablerView
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	usePlenaryBallotConstrainerEnablerView
Description	A complete view of the `BallotConstrainerEnabler` 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 enablers 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	useActiveBallotConstrainerEnablerView
Description	Only active ballot constrainer enablers are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusBallotConstrainerEnablerView
Description	All active and inactive ballot constrainer enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getBallotConstrainerEnabler
Description	Gets the `BallotConstrainerEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `BallotConstrainerEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `BallotConstrainerEnabler` and retained for compatibility. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
Parameters	`osid.id.Id`	`ballotConstrainerEnablerId`	`Id` of the `BallotConstrainerEnabler`
Return	`osid.voting.rules.BallotConstrainerEnabler`		the ballot constrainer enabler
Errors	NOT_FOUND		`ballotConstrainerEnablerId` not found
	NULL_ARGUMENT		`ballotConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getBallotConstrainerEnablersByIds
Description	Gets a `BallotConstrainerEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the ballot constrainer enablers 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 `BallotConstrainerEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
Parameters	`osid.id.IdList`	`ballotConstrainerEnablerIds`	the list of `Ids` to retrieve
Return	`osid.voting.rules.BallotConstrainerEnablerList`		the returned `BallotConstrainerEnabler` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`ballotConstrainerEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablersByGenusType
Description	Gets a `BallotConstrainerEnablerList` corresponding to the given ballot constrainer enabler genus `Type` which does not include ballot constrainer enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known ballot constrainer enablers or an error results. Otherwise, the returned list may contain only those ballot constrainer enablers that are accessible through this session. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
Parameters	`osid.type.Type`	`ballotConstrainerEnablerGenusType`	a ballot constrainer enabler genus type
Return	`osid.voting.rules.BallotConstrainerEnablerList`		the returned `BallotConstrainerEnabler` list
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablersByParentGenusType
Description	Gets a `BallotConstrainerEnablerList` corresponding to the given ballot constrainer enabler genus `Type` and include any additional ballot constrainer enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known ballot constrainer enablers or an error results. Otherwise, the returned list may contain only those ballot constrainer enablers that are accessible through this session. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
Parameters	`osid.type.Type`	`ballotConstrainerEnablerGenusType`	a ballot constrainer enabler genus type
Return	`osid.voting.rules.BallotConstrainerEnablerList`		the returned `BallotConstrainerEnabler` list
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablersByRecordType
Description	Gets a `BallotConstrainerEnablerList` containing the given ballot constrainer enabler record `Type.` In plenary mode, the returned list contains all known ballot constrainer enablers or an error results. Otherwise, the returned list may contain only those ballot constrainer enablers that are accessible through this session. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
Parameters	`osid.type.Type`	`ballotConstrainerEnablerRecordType`	a ballot constrainer enabler record type
Return	`osid.voting.rules.BallotConstrainerEnablerList`		the returned `BallotConstrainerEnabler` list
Errors	NULL_ARGUMENT		`ballotConstrainerEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablersOnDate
Description	Gets a `BallotConstrainerEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known ballot constrainer enablers or an error results. Otherwise, the returned list may contain only those ballot constrainer enablers that are accessible through this session. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.voting.rules.BallotConstrainerEnablerList`		the returned `BallotConstrainerEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablersOnDateWithAgent
Description	Gets a `BallotConstrainerEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known ballot constrainer enablers or an error results. Otherwise, the returned list may contain only those ballot constrainer enablers that are accessible through this session. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.voting.rules.BallotConstrainerEnablerList`		the returned `BallotConstrainerEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBallotConstrainerEnablers
Description	Gets all `BallotConstrainerEnablers.` In plenary mode, the returned list contains all known ballot constrainer enablers or an error results. Otherwise, the returned list may contain only those ballot constrainer enablers that are accessible through this session. In active mode, ballot constrainer enablers are returned that are currently active. In any status mode, active and inactive ballot constrainer enablers are returned.
Return	`osid.voting.rules.BallotConstrainerEnablerList`		the returned `BallotConstrainerEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.