Interface DemographicEnablerLookupSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DemographicEnablerLookupSession
extends OsidSession

This session provides methods for retrieving DemographicEnablers .

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 bin view: All demographic enabler methods in this session operate, retrieve and pertain to demographic enablers defined explicitly in the current bin. Using an isolated view is useful for managing DemographicEnablers with the DemographicEnablerAdminSession .
• federated bin view: All demographic enabler methods in this session operate, retrieve and pertain to all demographic enablers defined in this bin and any other demographic enablers implicitly available in this bin through bin inheritence.
• active demographic enabler view: All demographic enabler lookup methods return active demographic enablers.
• any status demographic enabler view:Ddemographic 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	canLookupDemographicEnablers()	Tests if this user can perform DemographicEnablers lookups.
Bin	getBin()	Gets the Bin associated with this session.
Id	getBinId()	Gets the Bin Id associated with this session.
DemographicEnabler	getDemographicEnabler(Id demographicEnablerId)	Gets the DemographicEnabler specified by its Id .
DemographicEnablerList	getDemographicEnablers()	Gets all DemographicEnablers .
DemographicEnablerList	getDemographicEnablersByGenusType(Type demographicEnablerGenusType)	Gets a DemographicEnablerList corresponding to the given demographic enabler genus Type which does not include demographic enablers of genus types derived from the specified Type .
DemographicEnablerList	getDemographicEnablersByIds(IdList demographicEnablerIds)	Gets a DemographicEnablerList corresponding to the given IdList .
DemographicEnablerList	getDemographicEnablersByParentGenusType(Type demographicEnablerGenusType)	Gets a DemographicEnablerList corresponding to the given demographic enabler genus Type and include any additional demographic enablers with genus types derived from the specified Type .
DemographicEnablerList	getDemographicEnablersByRecordType(Type demographicEnablerRecordType)	Gets a DemographicEnablerList containing the given demographic enabler record Type .
DemographicEnablerList	getDemographicEnablersOnDate(DateTime from, DateTime to)	Gets a DemographicEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
DemographicEnablerList	getDemographicEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to)	Gets a DemographicEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveDemographicEnablerView()	Only active demographic enablers are returned by methods in this session.
void	useAnyStatusDemographicEnablerView()	All active and inactive demographic enablers are returned by methods in this session.
void	useComparativeDemographicEnablerView()	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	useFederatedBinView()	Federates the view for methods in this session.
void	useIsolatedBinView()	Isolates the view for methods in this session.
void	usePlenaryDemographicEnablerView()	A complete view of the DemographicEnabler 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

getBinId

Id getBinId()

Gets the Bin Id associated with this session.

Returns:

the Bin Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBin

Bin getBin()
    throws OperationFailedException,
PermissionDeniedException

Gets the Bin associated with this session.

Returns:

the bin

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupDemographicEnablers

boolean canLookupDemographicEnablers()

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

useComparativeDemographicEnablerView

void useComparativeDemographicEnablerView()

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.

usePlenaryDemographicEnablerView

void usePlenaryDemographicEnablerView()

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

useFederatedBinView

void useFederatedBinView()

Federates the view for methods in this session. A federated view will include demographic enablers in bins which are children of this bin in the bin hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedBinView

void useIsolatedBinView()

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

Compliance:

mandatory - This method is must be implemented.

useActiveDemographicEnablerView

void useActiveDemographicEnablerView()

Only active demographic enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusDemographicEnablerView

void useAnyStatusDemographicEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getDemographicEnabler

DemographicEnabler getDemographicEnabler(Id demographicEnablerId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

demographicEnablerId - Id of the DemographicEnabler

Returns:

the demographic enabler

Throws:

NotFoundException - demographicEnablerId not found

NullArgumentException - demographicEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getDemographicEnablersByIds

DemographicEnablerList getDemographicEnablersByIds(IdList demographicEnablerIds)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

demographicEnablerIds - the list of Ids to retrieve

Returns:

the returned DemographicEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - demographicEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDemographicEnablersByGenusType

DemographicEnablerList getDemographicEnablersByGenusType(Type demographicEnablerGenusType)
                                                  throws OperationFailedException,
PermissionDeniedException

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

Parameters:

demographicEnablerGenusType - a demographic enabler genus type

Returns:

the returned DemographicEnabler list

Throws:

NullArgumentException - demographicEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDemographicEnablersByParentGenusType

DemographicEnablerList getDemographicEnablersByParentGenusType(Type demographicEnablerGenusType)
                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

demographicEnablerGenusType - a demographic enabler genus type

Returns:

the returned DemographicEnabler list

Throws:

NullArgumentException - demographicEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDemographicEnablersByRecordType

DemographicEnablerList getDemographicEnablersByRecordType(Type demographicEnablerRecordType)
                                                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

demographicEnablerRecordType - a demographic enabler record type

Returns:

the returned DemographicEnabler list

Throws:

NullArgumentException - demographicEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getDemographicEnablersOnDate

DemographicEnablerList getDemographicEnablersOnDate(DateTime from,
 DateTime to)
                                             throws OperationFailedException,
PermissionDeniedException

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

Parameters:

from - a start date

to - an end date

Returns:

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

getDemographicEnablersOnDateWithAgent

DemographicEnablerList getDemographicEnablersOnDateWithAgent(Id agentId,
 DateTime from,
 DateTime to)
                                                      throws OperationFailedException,
PermissionDeniedException

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

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

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

getDemographicEnablers

DemographicEnablerList getDemographicEnablers()
                                       throws OperationFailedException,
PermissionDeniedException

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

Returns:

the returned DemographicEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.