OSID - osid.financials.posting.PostEntryLookupSession Service Interface Definition

Interface	osid.financials.posting.PostEntryLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `PostEntry` objects. The `PostEntry` represents a period in which payers are offered. 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 business view: All post entry methods in this session operate, retrieve and pertain to post entries defined explicitly in the current business. Using an isolated view is useful for managing `PostEntries` with the `PostEntryAdminSession.` federated business view: All post entry methods in this session operate, retrieve and pertain to all post entries defined in this business and any other post entries implicitly available in this business through business inheritence. 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 `useFederatedBusinessView()` and `useIsolatedBusinessView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getBusinessId
Description	Gets the `Business` `Id` associated with this session.
Return	`osid.id.Id`		the `Business Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBusiness
Description	Gets the `Business` associated with this session.
Return	`osid.financials.Business`		the business
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupPostEntries
Description	Tests if this user can perform `PostEntry` 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	useComparativePostEntryView
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	usePlenaryPostEntryView
Description	A complete view of the `PostEntry` 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	useFederatedBusinessView
Description	Federates the view for methods in this session. A federated view will include post entries in businesses which are children of this business in the business hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBusinessView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this business only.
Compliance	`mandatory`		This method is must be implemented.
Method	getPostEntry
Description	Gets the `PostEntry` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `PostEntry` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `PostEntry` and retained for compatibility.
Parameters	`osid.id.Id`	`postEntryId`	`Id` of the `PostEntry`
Return	`osid.financials.posting.PostEntry`		the entry
Errors	NOT_FOUND		`postEntryId` not found
	NULL_ARGUMENT		`postEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getPostEntriesByIds
Description	Gets a `PostEntryList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the post entries 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 `PostEntries` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`postEntryIds`	the list of `Ids` to retrieve
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`postEntryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByGenusType
Description	Gets a `PostEntryList` corresponding to the given post entry genus `Type` which does not include post entries of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.type.Type`	`entryGenusType`	a post entry genus type
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`entryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByParentGenusType
Description	Gets a `PostEntryList` corresponding to the given post entry genus `Type` and include any additional post entries with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.type.Type`	`entryGenusType`	a post entry genus type
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`entryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByRecordType
Description	Gets q `PostEntryList` containing the given post entry record `Type.` In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.type.Type`	`postEntryRecordType`	a post entry record type
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`postEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesForPost
Description	Gets a `PostEntryList` for the given post. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.id.Id`	`postId`	a post `Id`
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`postId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByFiscalPeriod
Description	Gets a `PostEntryList` in the given fiscal period. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByDate
Description	Gets a `PostEntryList` posted within given date range inclusive. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` 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	getPostEntriesByAccount
Description	Gets a `PostEntryList` for the given account. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.id.Id`	`accountId`	an account `Id`
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`accountId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByAccountAndFiscalPeriod
Description	Gets a `PostEntryList` for the given account in a fiscal period. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.id.Id`	`accountId`	an account `Id`
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`accountId` or `fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByActivity
Description	Gets a `PostEntryList` for the given activity. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByActivityAndFiscalPeriod
Description	Gets a `PostEntryList` for the given activity in a fiscal period. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`activityId` or `fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByAccountAndActivity
Description	Gets a `PostEntryList` for the given activity and account. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.id.Id`	`accountId`	an account `Id`
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`accountId` or `activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntriesByAccountAndActivityAndFiscalPeriod
Description	Gets a `PostEntryList` for the given account in a fiscal period. In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Parameters	`osid.id.Id`	`accountId`	an account `Id`
	`osid.id.Id`	`activityId`	an activity `Id`
	`osid.id.Id`	`fiscalPeriodId`	a fiscal period `Id`
Return	`osid.financials.posting.PostEntryList`		the returned `PostEntry` list
Errors	NULL_ARGUMENT		`accountId, activityId,` or `fiscalPeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPostEntries
Description	Gets all `PostEntries.` In plenary mode, the returned list contains all known post entries or an error results. Otherwise, the returned list may contain only those post entries that are accessible through this session.
Return	`osid.financials.posting.PostEntryList`		a list of `PostEntries`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.