Interface OfferingConstrainerEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OfferingConstrainerEnablerLookupSession
extends OsidSession

This session provides methods for retrieving OfferingConstrainerEnablers .

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 catalogue view: All offering constrainer enabler methods in this session operate, retrieve and pertain to offering constrainer enablers defined explicitly in the current catalogue. Using an isolated view is useful for managing OfferingConstrainerEnablers with the OfferingConstrainerEnablerAdminSession .
• federated catalogue view: All offering constrainer enabler methods in this session operate, retrieve and pertain to all offering constrainer enablers defined in this catalogue and any other offering constrainer enablers implicitly available in this catalogue through catalogue inheritence.
• activee offering constrainer enabler view: All offering constrainer enabler lookup methods return active offering constrainer enablers.
• any status offering constrainer enabler view: offering constrainer enablers of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

Method Summary

Modifier and Type	Method	Description
boolean	canLookupOfferingConstrainerEnablers()	Tests if this user can perform OfferingConstrainerEnablers lookups.
Catalogue	getCatalogue()	Gets the Catalogue associated with this session.
Id	getCatalogueId()	Gets the Catalogue Id associated with this session.
OfferingConstrainerEnabler	getOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)	Gets the OfferingConstrainerEnabler specified by its Id .
OfferingConstrainerEnablerList	getOfferingConstrainerEnablers()	Gets all OfferingConstrainerEnablers .
OfferingConstrainerEnablerList	getOfferingConstrainerEnablersByGenusType(Type offeringConstrainerEnablerGenusType)	Gets an OfferingConstrainerEnablerList corresponding to the given offering constrainer enabler genus Type which does not include offering constrainer enablers of genus types derived from the specified Type .
OfferingConstrainerEnablerList	getOfferingConstrainerEnablersByIds(IdList offeringConstrainerEnablerIds)	Gets an OfferingConstrainerEnablerList corresponding to the given IdList .
OfferingConstrainerEnablerList	getOfferingConstrainerEnablersByParentGenusType(Type offeringConstrainerEnablerGenusType)	Gets an OfferingConstrainerEnablerList corresponding to the given offering constrainer enabler genus Type and include any additional offering constrainer enablers with genus types derived from the specified Type .
OfferingConstrainerEnablerList	getOfferingConstrainerEnablersByRecordType(Type offeringConstrainerEnablerRecordType)	Gets an OfferingConstrainerEnablerList containing the given offering constrainer enabler record Type .
OfferingConstrainerEnablerList	getOfferingConstrainerEnablersOnDate(DateTime from, DateTime to)	Gets an OfferingConstrainerEnablerList that are effective for the entire given date range but not confined to the date range.
OfferingConstrainerEnablerList	getOfferingConstrainerEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets an OfferingConstrainerEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent.
void	useActiveOfferingConstrainerEnablerView()	Only active offering constrainer enablers are returned by methods in this session.
void	useAnyStatusOfferingConstrainerEnablerView()	All active and inactive offering constrainer enablers are returned by methods in this session.
void	useComparativeOfferingConstrainerEnablerView()	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	useFederatedCatalogueView()	Federates the view for methods in this session.
void	useIsolatedCatalogueView()	Isolates the view for methods in this session.
void	usePlenaryOfferingConstrainerEnablerView()	A complete view of the OfferingConstrainerEnabler returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.

canLookupOfferingConstrainerEnablers

boolean canLookupOfferingConstrainerEnablers()

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

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeOfferingConstrainerEnablerView

void useComparativeOfferingConstrainerEnablerView()

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.

usePlenaryOfferingConstrainerEnablerView

void usePlenaryOfferingConstrainerEnablerView()

A complete view of the OfferingConstrainerEnabler 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 offering constrainer enablers 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 lookups to this catalogue only.

Compliance:

mandatory - This method is must be implemented.

useActiveOfferingConstrainerEnablerView

void useActiveOfferingConstrainerEnablerView()

Only active offering constrainer enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusOfferingConstrainerEnablerView

void useAnyStatusOfferingConstrainerEnablerView()

All active and inactive offering constrainer enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getOfferingConstrainerEnabler

OfferingConstrainerEnabler getOfferingConstrainerEnabler(Id offeringConstrainerEnablerId)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the OfferingConstrainerEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned OfferingConstrainerEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to an OfferingConstrainerEnabler and retained for compatibility. In active mode, offering constrainer enablers are returned that are currently active. In any status mode, active and inactive offering constrainer enablers are returned.

Parameters:

offeringConstrainerEnablerId - Id of the OfferingConstrainerEnabler

Returns:

the offering constrainer enabler

Throws:

NotFoundException - offeringConstrainerEnablerId not found

NullArgumentException - offeringConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getOfferingConstrainerEnablersByIds

OfferingConstrainerEnablerList getOfferingConstrainerEnablersByIds(IdList offeringConstrainerEnablerIds)
                                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets an OfferingConstrainerEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the offering constrainer enablers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible OfferingConstrainerEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, offering constrainer enablers are returned that are currently active. In any status mode, active and inactive offering constrainer enablers are returned.

Parameters:

offeringConstrainerEnablerIds - the list of Ids to retrieve

Returns:

the returned OfferingConstrainerEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - offeringConstrainerEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainerEnablersByGenusType

OfferingConstrainerEnablerList getOfferingConstrainerEnablersByGenusType(Type offeringConstrainerEnablerGenusType)
                                                                  throws OperationFailedException,
PermissionDeniedException

Gets an OfferingConstrainerEnablerList corresponding to the given offering constrainer enabler genus Type which does not include offering constrainer enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known offering constrainer enablers or an error results. Otherwise, the returned list may contain only those offering constrainer enablers that are accessible through this session. In active mode, offering constrainer enablers are returned that are currently active. In any status mode, active and inactive offering constrainer enablers are returned.

Parameters:

offeringConstrainerEnablerGenusType - an offering constrainer enabler genus type

Returns:

the returned OfferingConstrainerEnabler list

Throws:

NullArgumentException - offeringConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainerEnablersByParentGenusType

OfferingConstrainerEnablerList getOfferingConstrainerEnablersByParentGenusType(Type offeringConstrainerEnablerGenusType)
                                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

offeringConstrainerEnablerGenusType - an offering constrainer enabler genus type

Returns:

the returned OfferingConstrainerEnabler list

Throws:

NullArgumentException - offeringConstrainerEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainerEnablersByRecordType

OfferingConstrainerEnablerList getOfferingConstrainerEnablersByRecordType(Type offeringConstrainerEnablerRecordType)
                                                                   throws OperationFailedException,
PermissionDeniedException

Gets an OfferingConstrainerEnablerList containing the given offering constrainer enabler record Type . In plenary mode, the returned list contains all known offering constrainer enablers or an error results. Otherwise, the returned list may contain only those offering constrainer enablers that are accessible through this session. In active mode, offering constrainer enablers are returned that are currently active. In any status mode, active and inactive offering constrainer enablers are returned.

Parameters:

offeringConstrainerEnablerRecordType - an offering constrainer enabler record type

Returns:

the returned OfferingConstrainerEnabler list

Throws:

NullArgumentException - offeringConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainerEnablersOnDate

OfferingConstrainerEnablerList getOfferingConstrainerEnablersOnDate(DateTime from,
 DateTime to)
                                                             throws OperationFailedException,
PermissionDeniedException

Gets an OfferingConstrainerEnablerList that are effective for the entire given date range but not confined to the date range. In plenary mode, the returned list contains all known offering constrainer enablers or an error results. Otherwise, the returned list may contain only those offering constrainer enablers that are accessible through this session. In active mode, offering constrainer enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive offering constrainer enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned OfferingConstrainerEnabler list

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.

getOfferingConstrainerEnablersOnDateWithAgent

OfferingConstrainerEnablerList getOfferingConstrainerEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                                      throws OperationFailedException,
PermissionDeniedException

Gets an OfferingConstrainerEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known offering constrainer enablers or an error results. Otherwise, the returned list may contain only those offering constrainer enablers that are accessible through this session. In active mode, offering constrainer enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive offering constrainer enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned OfferingConstrainerEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfferingConstrainerEnablers

OfferingConstrainerEnablerList getOfferingConstrainerEnablers()
                                                       throws OperationFailedException,
PermissionDeniedException

Gets all OfferingConstrainerEnablers . In plenary mode, the returned list contains all known offering constrainer enablers or an error results. Otherwise, the returned list may contain only those offering constrainer enablers that are accessible through this session. In active mode, offering constrainer enablers are returned that are currently active. In any status mode, active and inactive offering constrainer enablers are returned.

Returns:

the returned OfferingConstrainerEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.