Interface CanonicalUnitEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CanonicalUnitEnablerLookupSession
extends OsidSession

This session provides methods for retrieving CanonicalUnitEnablers .

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 canonical unit enabler methods in this session operate, retrieve and pertain to canonical unit enablers defined explicitly in the current catalogue. Using an isolated view is useful for managing CanonicalUnitEnablers with the CanonicalUnitEnablerAdminSession .
• federated catalogue view: All canonical unit enabler methods in this session operate, retrieve and pertain to all canonical unit enablers defined in this catalogue and any other canonical unit enablers implicitly available in this catalogue through catalogue inheritence.
• activee canonical unit enabler view: All canonical unit enabler lookup methods return active canonical unit enablers.
• any status canonical unit enabler view: canonical unit 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	canLookupCanonicalUnitEnablers()	Tests if this user can perform CanonicalUnitEnablers lookups.
CanonicalUnitEnabler	getCanonicalUnitEnabler(Id canonicalUnitEnablerId)	Gets the CanonicalUnitEnabler specified by its Id .
CanonicalUnitEnablerList	getCanonicalUnitEnablers()	Gets all CanonicalUnitEnablers .
CanonicalUnitEnablerList	getCanonicalUnitEnablersByGenusType(Type canonicalUnitEnablerGenusType)	Gets a CanonicalUnitEnablerList corresponding to the given canonical unit enabler genus Type which does not include canonical unit enablers of genus types derived from the specified Type .
CanonicalUnitEnablerList	getCanonicalUnitEnablersByIds(IdList canonicalUnitEnablerIds)	Gets a CanonicalUnitEnablerList corresponding to the given IdList .
CanonicalUnitEnablerList	getCanonicalUnitEnablersByParentGenusType(Type canonicalUnitEnablerGenusType)	Gets a CanonicalUnitEnablerList corresponding to the given canonical unit enabler genus Type and include any additional canonical unit enablers with genus types derived from the specified Type .
CanonicalUnitEnablerList	getCanonicalUnitEnablersByRecordType(Type canonicalUnitEnablerRecordType)	Gets a CanonicalUnitEnablerList containing the given canonical unit enabler record Type .
CanonicalUnitEnablerList	getCanonicalUnitEnablersOnDate(DateTime from, DateTime to)	Gets a CanonicalUnitEnablerList that are effective for the entire given date range but not confined to the date range.
CanonicalUnitEnablerList	getCanonicalUnitEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a CanonicalUnitEnablerList that are effective for the entire given date range but not confined to the date range and evaluated against the given agent.
Catalogue	getCatalogue()	Gets the Catalogue associated with this session.
Id	getCatalogueId()	Gets the Catalogue Id associated with this session.
void	useActiveCanonicalUnitEnablerView()	Only active canonical unit enablers are returned by methods in this session.
void	useAnyStatusCanonicalUnitEnablerView()	All active and inactive canonical unit enablers are returned by methods in this session.
void	useComparativeCanonicalUnitEnablerView()	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	usePlenaryCanonicalUnitEnablerView()	A complete view of the CanonicalUnitEnabler 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.

canLookupCanonicalUnitEnablers

boolean canLookupCanonicalUnitEnablers()

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

useComparativeCanonicalUnitEnablerView

void useComparativeCanonicalUnitEnablerView()

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.

usePlenaryCanonicalUnitEnablerView

void usePlenaryCanonicalUnitEnablerView()

A complete view of the CanonicalUnitEnabler 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 canonical unit 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.

useActiveCanonicalUnitEnablerView

void useActiveCanonicalUnitEnablerView()

Only active canonical unit enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusCanonicalUnitEnablerView

void useAnyStatusCanonicalUnitEnablerView()

All active and inactive canonical unit enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getCanonicalUnitEnabler

CanonicalUnitEnabler getCanonicalUnitEnabler(Id canonicalUnitEnablerId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitEnablerId - Id of the CanonicalUnitEnabler

Returns:

the canonical unit enabler

Throws:

NotFoundException - canonicalUnitEnablerId not found

NullArgumentException - canonicalUnitEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getCanonicalUnitEnablersByIds

CanonicalUnitEnablerList getCanonicalUnitEnablersByIds(IdList canonicalUnitEnablerIds)
                                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a CanonicalUnitEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the canonical unit 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 CanonicalUnitEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, canonical unit enablers are returned that are currently active. In any status mode, active and inactive canonical unit enablers are returned.

Parameters:

canonicalUnitEnablerIds - the list of Ids to retrieve

Returns:

the returned CanonicalUnitEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - canonicalUnitEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablersByGenusType

CanonicalUnitEnablerList getCanonicalUnitEnablersByGenusType(Type canonicalUnitEnablerGenusType)
                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitEnablerGenusType - a canonical unit enabler genus type

Returns:

the returned CanonicalUnitEnabler list

Throws:

NullArgumentException - canonicalUnitEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablersByParentGenusType

CanonicalUnitEnablerList getCanonicalUnitEnablersByParentGenusType(Type canonicalUnitEnablerGenusType)
                                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitEnablerGenusType - a canonical unit enabler genus type

Returns:

the returned CanonicalUnitEnabler list

Throws:

NullArgumentException - canonicalUnitEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablersByRecordType

CanonicalUnitEnablerList getCanonicalUnitEnablersByRecordType(Type canonicalUnitEnablerRecordType)
                                                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitEnablerRecordType - a canonical unit enabler record type

Returns:

the returned CanonicalUnitEnabler list

Throws:

NullArgumentException - canonicalUnitEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitEnablersOnDate

CanonicalUnitEnablerList getCanonicalUnitEnablersOnDate(DateTime from,
 DateTime to)
                                                 throws OperationFailedException,
PermissionDeniedException

Gets a CanonicalUnitEnablerList 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 canonical unit enablers or an error results. Otherwise, the returned list may contain only those canonical unit enablers that are accessible through this session. In active mode, canonical unit enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive canonical unit enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned CanonicalUnitEnabler 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.

getCanonicalUnitEnablersOnDateWithAgent

CanonicalUnitEnablerList getCanonicalUnitEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                          throws OperationFailedException,
PermissionDeniedException

Gets a CanonicalUnitEnablerList 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 canonical unit enablers or an error results. Otherwise, the returned list may contain only those canonical unit enablers that are accessible through this session. In active mode, canonical unit enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive canonical unit enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned CanonicalUnitEnabler 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.

getCanonicalUnitEnablers

CanonicalUnitEnablerList getCanonicalUnitEnablers()
                                           throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned CanonicalUnitEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.