OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.CommissionLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving Commission relationships.

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 foundry view: All commission methods in this session operate, retrieve and pertain to commissions defined explicitly in the current foundry. Using an isolated view is useful for managing Commissions with the CommissionAdminSession.
  • federated foundry view: All commission methods in this session operate, retrieve and pertain to all commissions defined in this foundry and any other commissions implicitly available in this foundry through foundry inheritence.
  • effective commission view: All commission lookup methods return commissions where the current date falls in between the effective dates inclusive.
  • any effective commission view: Commissions of any effective date 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 useFederatedFoundryView() and useIsolatedFoundryView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupCommissions
Description

Tests if this user can perform Commission 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeCommissionView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryCommissionView
Description

A complete view of the Commission 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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedFoundryView
Description

Federates the view for methods in this session. A federated view will include commissions in foundries which are children of this foundry in the foundry hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFoundryView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this foundry only.

CompliancemandatoryThis method is must be implemented.
MethoduseEffectiveCommissionView
Description

Only commissions whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveCommissionView
Description

All commissions of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetCommission
Description

Gets the Commission specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Commission may have a different Id than requested, such as the case where a duplicate Id was assigned to a Commission and retained for compatibility.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.id.IdcommissionId Id of the Commission
Returnosid.resourcing.Commissionthe commission
ErrorsNOT_FOUND commissionId not found
NULL_ARGUMENT commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetCommissionsByIds
Description

Gets a CommissionList corresponding to the given IdList.

In plenary mode, the returned list contains all of the commissions 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 Commissions may be omitted from the list and may present the elements in any order including returning a unique set.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.id.IdListcommissionIdsthe list of Ids to retrieve
Returnosid.resourcing.CommissionListthe returned Commission list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT commissionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsByGenusType
Description

Gets a CommissionList corresponding to the given commission genus Type which does not include commissions of genus types derived from the specified Type.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.type.TypecommissionGenusTypea commission genus type
Returnosid.resourcing.CommissionListthe returned Commission list
ErrorsNULL_ARGUMENT commissionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsByParentGenusType
Description

Gets a CommissionList corresponding to the given commission genus Type and include any additional commissions with genus types derived from the specified Type.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session. In both cases, the order of the set is by the start effective date.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.type.TypecommissionGenusTypea commission genus type
Returnosid.resourcing.CommissionListthe returned Commission list
ErrorsNULL_ARGUMENT commissionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsByRecordType
Description

Gets a CommissionList containing the given commission record Type.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.type.TypecommissionRecordTypea commission record type
Returnosid.resourcing.CommissionListthe returned Commission list
ErrorsNULL_ARGUMENT commissionRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsOnDate
Description

Gets a list of commissions effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.resourcing.CommissionListthe returned Commission list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsForResource
Description

Gets a list of commissions for a resource.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
Returnosid.resourcing.CommissionListthe returned Commission list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsForResourceOnDate
Description

Gets a list of commissions for a resource and effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.resourcing.CommissionListthe returned Commission list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsForWork
Description

Gets a list of commissions for a work.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.id.IdworkIda work Id
Returnosid.resourcing.CommissionListthe returned C ommission list
ErrorsNULL_ARGUMENT workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsForWorkOnDate
Description

Gets a list of commissions for a work and effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.id.IdworkIda work Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.resourcing.CommissionListthe returned C ommission list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT workId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsForResourceAndWork
Description

Gets a list of commissions for a resource and work.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdworkIda work Id
Returnosid.resourcing.CommissionListthe returned C ommission list
ErrorsNULL_ARGUMENT resourceId or workId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissionsForResourceAndWorkOnDate
Description

Gets a list of commissions for a resource and work and effective during the entire given date range inclusive but not confined to the date range.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdworkIda work Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.resourcing.CommissionListthe returned C ommission list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, workId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCommissions
Description

Gets all Commissions.

In plenary mode, the returned list contains all known commissions or an error results. Otherwise, the returned list may contain only those commissions that are accessible through this session.

In effective mode, commissions are returned that are currently effective. In any effective mode, effective commissions and those currently expired are returned.

Returnosid.resourcing.CommissionLista list of Commissions
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.