org.osid.offering

Interface ParticipantLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ParticipantLookupSession
extends OsidSession

This session defines methods for retrieving participants.

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 catalogue view: All participant methods in this session operate, retrieve and pertain to participants defined explicitly in the current catalogue. Using an isolated view is useful for managing participants with the ParticipantAdminSession.
• federated catalogue view: All participant lookup methods in this session operate, retrieve and pertain to all participants defined in this catalogue and any other catalogues implicitly available in this catalogue through catalogue inheritence.
• effective participant view: All participant lookup methods return participants where the current date falls in between the effective dates inclusive.
• any effective participant view: Participants of any effective date are returned from methods.

The methods useFederatedCatalogueView() and useIsolatedCatalogueView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupParticipants() Tests if this user can examine this catalogue.
Catalogue	getCatalogue() Gets the Catalogue associated with this session.
Id	getCatalogueId() Gets the Catalogue Id associated with this session.
Participant	getParticipant(Id participantId) Gets the Participant specified by its Id.
ParticipantList	getParticipants() Gets all participants.
ParticipantList	getParticipantsByGenusType(Type participantGenusType) Gets a ParticipantList corresponding to the given participant genus Type which does not include participants of types derived from the specified Type.
ParticipantList	getParticipantsByGenusTypeForOffering(Id offeringId, Type participantGenusType) Gets a ParticipantList by genus type for the given offering .
ParticipantList	getParticipantsByGenusTypeForOfferingAndResource(Id offeringId, Id resourceId, Type participantGenusType) Gets a ParticipantList by genus type for the given offering and resource .
ParticipantList	getParticipantsByGenusTypeForOfferingAndResourceOnDate(Id offeringId, Id resourceId, Type participantGenusType, DateTime from, DateTime to) Gets a ParticipantList by genus type for an offering, resource, and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByGenusTypeForOfferingOnDate(Id offeringId, Type participantGenusType, DateTime from, DateTime to) Gets a ParticipantList by genus type for an offering and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByGenusTypeForResource(Id resourceId, Type participantGenusType) Gets a ParticipantList by genus type for the given resource.
ParticipantList	getParticipantsByGenusTypeForResourceOnDate(Id resourceId, Type participantGenusType, DateTime from, DateTime to) Gets a ParticipantList by genus type for a resource and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByGenusTypeOnDate(Type participantGenusType, DateTime from, DateTime to) Gets a ParticipantList by genus type and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByIds(IdList participantIds) Gets a ParticipantList corresponding to the given IdList.
ParticipantList	getParticipantsByParentGenusType(Type participantGenusType) Gets a ParticipantList corresponding to the given participant genus Type and include any additional participants with genus types derived from the specified Type.
ParticipantList	getParticipantsByRecordType(Type participantRecordType) Gets a ParticipantList containing the given participant record Type.
ParticipantList	getParticipantsByTimePeriodAndGenusTypeForOffering(Id offeringId, Id timePeriodId, Type participantGenusType) Gets a ParticipantList by genus type for the given offering in a time period .
ParticipantList	getParticipantsByTimePeriodAndGenusTypeForOfferingAndResource(Id offeringId, Id resourceId, Id timePeriodId, Type participantGenusType) Gets a ParticipantList by genus type for the given offering and resource in a time period .
ParticipantList	getParticipantsByTimePeriodAndGenusTypeForOfferingAndResourceOnDate(Id offeringId, Id resourceId, Id timePeriodId, Type participantGenusType, DateTime from, DateTime to) Gets a ParticipantList by genus type for an offering and resource in a time period and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByTimePeriodAndGenusTypeForOfferingOnDate(Id offeringId, Id timePeriodId, Type participantGenusType, DateTime from, DateTime to) Gets a ParticipantList by genus type for an offering in a time period and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByTimePeriodAndGenusTypeForResource(Id resourceId, Id timePeriodId, Type participantGenusType) Gets a ParticipantList by genus type for the given resource in a time period .
ParticipantList	getParticipantsByTimePeriodAndGenusTypeForResourceOnDate(Id resourceId, Id timePeriodId, Type participantGenusType, DateTime from, DateTime to) Gets a ParticipantList by genus type for a resource in a time period and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByTimePeriodForOffering(Id offeringId, Id timePeriodId) Gets a ParticipantList for the given offering in a time period .
ParticipantList	getParticipantsByTimePeriodForOfferingAndResource(Id offeringId, Id resourceId, Id timePeriodId) Gets a ParticipantList for the given offering and resource in a time period .
ParticipantList	getParticipantsByTimePeriodForOfferingAndResourceOnDate(Id offeringId, Id resourceId, Id timePeriodId, DateTime from, DateTime to) Gets a ParticipantList for an offering and resource in a time period and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByTimePeriodForOfferingOnDate(Id offeringId, Id timePeriodId, DateTime from, DateTime to) Gets a ParticipantList for an offering in a time period and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsByTimePeriodForResource(Id resourceId, Id timePeriodId) Gets a ParticipantList for the given resource in a time period .
ParticipantList	getParticipantsByTimePeriodForResourceOnDate(Id resourceId, Id timePeriodId, DateTime from, DateTime to) Gets a ParticipantList for a resource in a time period and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsForOffering(Id offeringId) Gets a ParticipantList for the given offering .
ParticipantList	getParticipantsForOfferingAndResource(Id offeringId, Id resourceId) Gets a ParticipantList for the given offering and resource .
ParticipantList	getParticipantsForOfferingAndResourceOnDate(Id offeringId, Id resourceId, DateTime from, DateTime to) Gets a ParticipantList for an offering, resource, and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsForOfferingOnDate(Id offeringId, DateTime from, DateTime to) Gets a ParticipantList for an offering and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsForResource(Id resourceId) Gets a ParticipantList for the given resource.
ParticipantList	getParticipantsForResourceOnDate(Id resourceId, DateTime from, DateTime to) Gets a ParticipantList for a resource and effective during the entire given date range inclusive but not confined to the date range.
ParticipantList	getParticipantsOnDate(DateTime from, DateTime to) Gets a ParticipantList effective during the entire given date range inclusive but not confined to the date range.
void	useAnyEffectiveParticipantView() All participants of any effective dates are returned by methods in this session.
void	useComparativeParticipantView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useEffectiveParticipantView() Only participants whose effective dates are current are returned by methods in this session.
void	useFederatedCatalogueView() Federates the view for methods in this session.
void	useIsolatedCatalogueView() Isolates the view for methods in this session.
void	usePlenaryParticipantView() A complete view of the Participant returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCatalogueId

Id getCatalogueId()

Gets the Catalogue Id associated with this session.

Returns:

the Catalogue Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogue

Catalogue getCatalogue()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Catalogue associated with this session.

Returns:

the catalogue

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupParticipants

boolean canLookupParticipants()

Tests if this user can examine this catalogue. 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.

Returns:

false if catalogue reading methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeParticipantView

void useComparativeParticipantView()

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.

usePlenaryParticipantView

void usePlenaryParticipantView()

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

useFederatedCatalogueView

void useFederatedCatalogueView()

Federates the view for methods in this session. A federated view will include participants in catalogues which are children of this catalogue in the catalogue hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCatalogueView

void useIsolatedCatalogueView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this catalogue only.

Compliance:

mandatory - This method is must be implemented.

useEffectiveParticipantView

void useEffectiveParticipantView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveParticipantView

void useAnyEffectiveParticipantView()

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

Compliance:

mandatory - This method is must be implemented.

getParticipant

Participant getParticipant(Id participantId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Gets the Participant specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Participant may have a different Id than requested, such as the case where a duplicate Id was assigned to a Participant and retained for compatibility. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

participantId - the Id of the Participant to retrieve

Returns:

the returned Participant

Throws:

NotFoundException - no Participant found with the given Id

NullArgumentException - participantId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByIds

ParticipantList getParticipantsByIds(IdList participantIds)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Gets a ParticipantList corresponding to the given IdList. In plenary mode, the returned list contains all of the participants 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 participants may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

participantIds - the list of Ids to retrieve

Returns:

the returned Participant list

Throws:

NotFoundException - an Id was not found

NullArgumentException - participantIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByGenusType

ParticipantList getParticipantsByGenusType(Type participantGenusType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a ParticipantList corresponding to the given participant genus Type which does not include participants of types derived from the specified Type. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

participantGenusType - a participant genus type

Returns:

the returned Participant list

Throws:

NullArgumentException - participantGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByParentGenusType

ParticipantList getParticipantsByParentGenusType(Type participantGenusType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a ParticipantList corresponding to the given participant genus Type and include any additional participants with genus types derived from the specified Type. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In active mode, participants are returned that are currently active. In any status mode, active and inactive participants are returned.

Parameters:

participantGenusType - a participant genus type

Returns:

the returned Participant list

Throws:

NullArgumentException - participantGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByRecordType

ParticipantList getParticipantsByRecordType(Type participantRecordType)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a ParticipantList containing the given participant record Type. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

participantRecordType - a participant record type

Returns:

the returned ParticipantList

Throws:

NullArgumentException - participantRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsOnDate

ParticipantList getParticipantsOnDate(DateTime from,
                                    DateTime to)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Gets a ParticipantList effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

the returned ParticipantList

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByGenusTypeOnDate

ParticipantList getParticipantsByGenusTypeOnDate(Type participantGenusType,
                                               DateTime from,
                                               DateTime to)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a ParticipantList by genus type 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

participantGenusType - a participant genus type

from - start of date range

to - end of date range

Returns:

the returned ParticipantList

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - participantGenusType, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsForOffering

ParticipantList getParticipantsForOffering(Id offeringId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a ParticipantList for the given offering . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

Returns:

the returned ParticipantList

Throws:

NullArgumentException - offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByGenusTypeForOffering

ParticipantList getParticipantsByGenusTypeForOffering(Id offeringId,
                                                    Type participantGenusType)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a ParticipantList by genus type for the given offering . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

participantGenusType - a participant genus type

Returns:

the returned ParticipantList

Throws:

NullArgumentException - participantGenusType or offeringId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsForOfferingOnDate

ParticipantList getParticipantsForOfferingOnDate(Id offeringId,
                                               DateTime from,
                                               DateTime to)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a ParticipantList for an offering 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - offeringId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByGenusTypeForOfferingOnDate

ParticipantList getParticipantsByGenusTypeForOfferingOnDate(Id offeringId,
                                                          Type participantGenusType,
                                                          DateTime from,
                                                          DateTime to)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets a ParticipantList by genus type for an offering 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

participantGenusType - a participant genus type

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - offeringId, participantGenusType, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodForOffering

ParticipantList getParticipantsByTimePeriodForOffering(Id offeringId,
                                                     Id timePeriodId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets a ParticipantList for the given offering in a time period . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

timePeriodId - a time period Id

Returns:

the returned ParticipantList

Throws:

NullArgumentException - offeringId or timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodAndGenusTypeForOffering

ParticipantList getParticipantsByTimePeriodAndGenusTypeForOffering(Id offeringId,
                                                                 Id timePeriodId,
                                                                 Type participantGenusType)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

Gets a ParticipantList by genus type for the given offering in a time period . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

timePeriodId - a time period Id

participantGenusType - a participant genus type

Returns:

the returned ParticipantList

Throws:

NullArgumentException - offeringId, timePeriodId, or participantGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodForOfferingOnDate

ParticipantList getParticipantsByTimePeriodForOfferingOnDate(Id offeringId,
                                                           Id timePeriodId,
                                                           DateTime from,
                                                           DateTime to)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

Gets a ParticipantList for an offering in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

timePeriodId - a time period Id

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - offeringId, timePeriodId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodAndGenusTypeForOfferingOnDate

ParticipantList getParticipantsByTimePeriodAndGenusTypeForOfferingOnDate(Id offeringId,
                                                                       Id timePeriodId,
                                                                       Type participantGenusType,
                                                                       DateTime from,
                                                                       DateTime to)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

Gets a ParticipantList by genus type for an offering in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

timePeriodId - a time period Id

participantGenusType - a participant genus type

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - offeringId, timePeriodId, participantGenusType, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsForResource

ParticipantList getParticipantsForResource(Id resourceId)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

Gets a ParticipantList for the given resource. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

resourceId - a resource Id

Returns:

the returned ParticipantList

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByGenusTypeForResource

ParticipantList getParticipantsByGenusTypeForResource(Id resourceId,
                                                    Type participantGenusType)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a ParticipantList by genus type for the given resource. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

resourceId - a resource Id

participantGenusType - a participant genus type

Returns:

the returned ParticipantList

Throws:

NullArgumentException - resourceId or participantGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsForResourceOnDate

ParticipantList getParticipantsForResourceOnDate(Id resourceId,
                                               DateTime from,
                                               DateTime to)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

Gets a ParticipantList 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

resourceId - a resource Id

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByGenusTypeForResourceOnDate

ParticipantList getParticipantsByGenusTypeForResourceOnDate(Id resourceId,
                                                          Type participantGenusType,
                                                          DateTime from,
                                                          DateTime to)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets a ParticipantList by genus type 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

resourceId - a resource Id

participantGenusType - a participant genus type

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, participantGenusType, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodForResource

ParticipantList getParticipantsByTimePeriodForResource(Id resourceId,
                                                     Id timePeriodId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

Gets a ParticipantList for the given resource in a time period . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

resourceId - a resource Id

timePeriodId - a time period Id

Returns:

the returned ParticipantList

Throws:

NullArgumentException - resourceId or timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodAndGenusTypeForResource

ParticipantList getParticipantsByTimePeriodAndGenusTypeForResource(Id resourceId,
                                                                 Id timePeriodId,
                                                                 Type participantGenusType)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

Gets a ParticipantList by genus type for the given resource in a time period . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

resourceId - a resource Id

timePeriodId - a time period Id

participantGenusType - a participant genus type

Returns:

the returned ParticipantList

Throws:

NullArgumentException - resourceId, timePeriodId, or participantGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodForResourceOnDate

ParticipantList getParticipantsByTimePeriodForResourceOnDate(Id resourceId,
                                                           Id timePeriodId,
                                                           DateTime from,
                                                           DateTime to)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

Gets a ParticipantList for a resource in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

resourceId - a resource Id

timePeriodId - a time period Id

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, timePeriodId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodAndGenusTypeForResourceOnDate

ParticipantList getParticipantsByTimePeriodAndGenusTypeForResourceOnDate(Id resourceId,
                                                                       Id timePeriodId,
                                                                       Type participantGenusType,
                                                                       DateTime from,
                                                                       DateTime to)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

Gets a ParticipantList by genus type for a resource in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

resourceId - a resource Id

timePeriodId - a time period Id

participantGenusType - a participant genus type

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, timePeriodId, participantGenusType, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsForOfferingAndResource

ParticipantList getParticipantsForOfferingAndResource(Id offeringId,
                                                    Id resourceId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a ParticipantList for the given offering and resource . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

resourceId - a resource Id

Returns:

the returned ParticipantList

Throws:

NullArgumentException - offeringId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByGenusTypeForOfferingAndResource

ParticipantList getParticipantsByGenusTypeForOfferingAndResource(Id offeringId,
                                                               Id resourceId,
                                                               Type participantGenusType)
                                                                 throws OperationFailedException,
                                                                        PermissionDeniedException

Gets a ParticipantList by genus type for the given offering and resource . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

resourceId - a resource Id

participantGenusType - a participant genus type

Returns:

the returned ParticipantList

Throws:

NullArgumentException - offeringId, resourceId or participantGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsForOfferingAndResourceOnDate

ParticipantList getParticipantsForOfferingAndResourceOnDate(Id offeringId,
                                                          Id resourceId,
                                                          DateTime from,
                                                          DateTime to)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets a ParticipantList for an offering, 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

resourceId - a resource Id

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByGenusTypeForOfferingAndResourceOnDate

ParticipantList getParticipantsByGenusTypeForOfferingAndResourceOnDate(Id offeringId,
                                                                     Id resourceId,
                                                                     Type participantGenusType,
                                                                     DateTime from,
                                                                     DateTime to)
                                                                       throws OperationFailedException,
                                                                              PermissionDeniedException

Gets a ParticipantList by genus type for an offering, 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

resourceId - a resource Id

participantGenusType - a participant genus type

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, participantGenusType, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodForOfferingAndResource

ParticipantList getParticipantsByTimePeriodForOfferingAndResource(Id offeringId,
                                                                Id resourceId,
                                                                Id timePeriodId)
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

Gets a ParticipantList for the given offering and resource in a time period . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

resourceId - a resource Id

timePeriodId - a time period Id

Returns:

the returned ParticipantList

Throws:

NullArgumentException - offeringId, resourceId, or timePeriodId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodAndGenusTypeForOfferingAndResource

ParticipantList getParticipantsByTimePeriodAndGenusTypeForOfferingAndResource(Id offeringId,
                                                                            Id resourceId,
                                                                            Id timePeriodId,
                                                                            Type participantGenusType)
                                                                              throws OperationFailedException,
                                                                                     PermissionDeniedException

Gets a ParticipantList by genus type for the given offering and resource in a time period . In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

resourceId - a resource Id

timePeriodId - a time period Id

participantGenusType - a participant genus type

Returns:

the returned ParticipantList

Throws:

NullArgumentException - offeringId, resourceId, timePeriodId or participantGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodForOfferingAndResourceOnDate

ParticipantList getParticipantsByTimePeriodForOfferingAndResourceOnDate(Id offeringId,
                                                                      Id resourceId,
                                                                      Id timePeriodId,
                                                                      DateTime from,
                                                                      DateTime to)
                                                                        throws OperationFailedException,
                                                                               PermissionDeniedException

Gets a ParticipantList for an offering and resource in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

resourceId - a resource Id

timePeriodId - a time period Id

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - offeringId, resourceId, timePeriodId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipantsByTimePeriodAndGenusTypeForOfferingAndResourceOnDate

ParticipantList getParticipantsByTimePeriodAndGenusTypeForOfferingAndResourceOnDate(Id offeringId,
                                                                                  Id resourceId,
                                                                                  Id timePeriodId,
                                                                                  Type participantGenusType,
                                                                                  DateTime from,
                                                                                  DateTime to)
                                                                                    throws OperationFailedException,
                                                                                           PermissionDeniedException

Gets a ParticipantList by genus type for an offering and resource in a time period 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 participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Parameters:

offeringId - an offering Id

resourceId - a resource Id

timePeriodId - a time period Id

participantGenusType - a participant genus type

from - start of date range

to - end of date range

Returns:

a list of participants

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - offeringId, resourceId, timePeriodId,participantGenusType, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getParticipants

ParticipantList getParticipants()
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets all participants. In plenary mode, the returned list contains all known participants or an error results. Otherwise, the returned list may contain only those participants that are accessible through this session. In effective mode, participants are returned that are currently effective. In any effective mode, effective participants and those currently expired are returned.

Returns:

a list of participants

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.