OSID - osid.personnel.OrganizationLookupSession Service Interface Definition

Interface	osid.personnel.OrganizationLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving organizations. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated realm view: All organization methods in this session operate, retrieve and pertain to organizations defined explicitly in the current realm. Using an isolated view is useful for managing organizations with the `OrganizationAdminSession.` federated realm view: All organization lookup methods in this session operate, retrieve and pertain to all organizations defined in this realm and any other realms implicitly available in this realm through realm inheritence. effective organization view: All organization lookup methods return organizations where the current date falls in between the effective dates inclusive. any status organization view: Organizations of any effective date are returned from methods. The methods `useFederatedRealmView()` and `useIsolatedRealmView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getRealmId
Description	Gets the `Realm` `Id` associated with this session.
Return	`osid.id.Id`		the `Realm Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRealm
Description	Gets the `Realm` associated with this session.
Return	`osid.personnel.Realm`		the realm
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupOrganizations
Description	Tests if this user can examine this realm. 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 these operations.
Return	`boolean`		`false` if realm reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeOrganizationView
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	usePlenaryOrganizationView
Description	A complete view of the `Organization` 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	useFederatedRealmView
Description	Federates the view for methods in this session. A federated view will include organizations in realms which are children of this realm in the realm hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedRealmView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this realm only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveOrganizationView
Description	Only organizations whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveOrganizationView
Description	All organizations of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getOrganization
Description	Gets the `Organization` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Organization` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Organization` and retained for compatibility. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.
Parameters	`osid.id.Id`	`organizationId`	the `Id` of the `Organization` to retrieve
Return	`osid.personnel.Organization`		the returned `Organization`
Errors	NOT_FOUND		no `Organization` found with the given `Id`
	NULL_ARGUMENT		`organizationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationsByIds
Description	Gets an `OrganizationList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the organizations 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 organizations may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.
Parameters	`osid.id.IdList`	`organizationIds`	the list of `Ids` to retrieve
Return	`osid.personnel.OrganizationList`		the returned `Organization list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`organizationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationsByGenusType
Description	Gets an `OrganizationList` corresponding to the given organization genus `Type` which does not include organizations of types derived from the specified `Type.` In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.
Parameters	`osid.type.Type`	`organizationGenusType`	an organizations genus type
Return	`osid.personnel.OrganizationList`		the returned `Organization list`
Errors	NULL_ARGUMENT		`organizationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationsByParentGenusType
Description	Gets an `OrganizationList` corresponding to the given organization genus `Type` and include any additional organizations with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.
Parameters	`osid.type.Type`	`organizationGenusType`	an organization genus type
Return	`osid.personnel.OrganizationList`		the returned `Organization list`
Errors	NULL_ARGUMENT		`organizationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationsByRecordType
Description	Gets an `OrganizationList` containing the given organization record `Type.` In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.
Parameters	`osid.type.Type`	`organizationRecordType`	an organization record type
Return	`osid.personnel.OrganizationList`		the returned `OrganizationList`
Errors	NULL_ARGUMENT		`organizationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationsOnDate
Description	Gets an `OrganizationList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.personnel.OrganizationList`		the returned `OrganizationList`
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	getOrganizations
Description	Gets all organizations. In plenary mode, the returned list contains all known organizations or an error results. Otherwise, the returned list may contain only those organizations that are accessible through this session. In effective mode, organizations are returned that are currently effective. In any effective mode, effective organizations and those currently expired are returned.
Return	`osid.personnel.OrganizationList`		a list of organizations
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.