org.osid.authorization.rules

Interface AuthorizationEnablerLookupSession

All Superinterfaces:

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

public interface AuthorizationEnablerLookupSession
extends OsidSession

This session provides methods for retrieving AuthorizationEnablers.

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 vault view: All authorization enabler methods in this session operate, retrieve and pertain to authorization enablers defined explicitly in the current vault. Using an isolated view is useful for managing AuthorizationEnablers with the AuthorizationEnablerAdminSession.
• federated vault view: All authorization enabler methods in this session operate, retrieve and pertain to all authorization enablers defined in this vault and any other authorization enablers implicitly available in this vault through vault inheritence.
• active authorization enabler view: All authorization enabler lookup methods return active authorization enablers.
• any status authorization enabler view: Authorization 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

Methods

Modifier and Type	Method and Description
boolean	canLookupAuthorizationEnablers() Tests if this user can perform AuthorizationEnablers lookups.
AuthorizationEnabler	getAuthorizationEnabler(Id authorizationEnablerId) Gets the AuthorizationEnabler specified by its Id.
AuthorizationEnablerList	getAuthorizationEnablers() Gets all AuthorizationEnablers.
AuthorizationEnablerList	getAuthorizationEnablersByGenusType(Type authorizationEnablerGenusType) Gets an AuthorizationEnablerList corresponding to the given authorization enabler genus Type which does not include authorization enablers of genus types derived from the specified Type.
AuthorizationEnablerList	getAuthorizationEnablersByIds(IdList authorizationEnablerIds) Gets an AuthorizationEnablerList corresponding to the given IdList.
AuthorizationEnablerList	getAuthorizationEnablersByParentGenusType(Type authorizationEnablerGenusType) Gets an AuthorizationEnablerList corresponding to the given authorization enabler genus Type and include any additional authorization enablers with genus types derived from the specified Type.
AuthorizationEnablerList	getAuthorizationEnablersByRecordType(Type authorizationEnablerRecordType) Gets an AuthorizationEnablerList containing the given authorization enabler record Type.
AuthorizationEnablerList	getAuthorizationEnablersOnDate(DateTime from, DateTime to) Gets an AuthorizationEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
AuthorizationEnablerList	getAuthorizationEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) Gets an AuthorizationEnablerList that are effective for the entire given date range and evaluated against the given agent.
Vault	getVault() Gets the Vault associated with this session.
Id	getVaultId() Gets the Vault Id associated with this session.
void	useActiveAuthorizationEnablerView() Only active authorization enablers are returned by methods in this session.
void	useAnyStatusAuthorizationEnablerView() All active and inactive authorization enablers are returned by methods in this session.
void	useComparativeAuthorizationEnablerView() 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	useFederatedVaultView() Federates the view for methods in this session.
void	useIsolatedVaultView() Isolates the view for methods in this session.
void	usePlenaryAuthorizationEnablerView() A complete view of the AuthorizationEnabler 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

getVaultId

Id getVaultId()

Gets the Vault Id associated with this session.

Returns:

the Vault Id associated with this session

Compliance:

mandatory - This method must be implemented.

getVault

Vault getVault()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Vault associated with this session.

Returns:

the vault

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupAuthorizationEnablers

boolean canLookupAuthorizationEnablers()

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

useComparativeAuthorizationEnablerView

void useComparativeAuthorizationEnablerView()

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.

usePlenaryAuthorizationEnablerView

void usePlenaryAuthorizationEnablerView()

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

useFederatedVaultView

void useFederatedVaultView()

Federates the view for methods in this session. A federated view will include authorization enablers in vaults which are children of this vault in the vault hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedVaultView

void useIsolatedVaultView()

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

Compliance:

mandatory - This method is must be implemented.

useActiveAuthorizationEnablerView

void useActiveAuthorizationEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyStatusAuthorizationEnablerView

void useAnyStatusAuthorizationEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getAuthorizationEnabler

AuthorizationEnabler getAuthorizationEnabler(Id authorizationEnablerId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets the AuthorizationEnabler specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AuthorizationEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to an AuthorizationEnabler 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:

authorizationEnablerId - Id of the AuthorizationEnabler

Returns:

the authorization enabler

Throws:

NotFoundException - authorizationEnablerId not found

NullArgumentException - authorizationEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getAuthorizationEnablersByIds

AuthorizationEnablerList getAuthorizationEnablersByIds(IdList authorizationEnablerIds)
                                                       throws NotFoundException,
                                                              OperationFailedException,
                                                              PermissionDeniedException

Gets an AuthorizationEnablerList corresponding to the given IdList. In plenary mode, the returned list contains all of the authorization 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 AuthorizationEnablers 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:

authorizationEnablerIds - the list of Ids to retrieve

Returns:

the returned AuthorizationEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - authorizationEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablersByGenusType

AuthorizationEnablerList getAuthorizationEnablersByGenusType(Type authorizationEnablerGenusType)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

Gets an AuthorizationEnablerList corresponding to the given authorization enabler genus Type which does not include authorization enablers of genus types derived from the specified Type. In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization 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:

authorizationEnablerGenusType - an authorization enabler genus type

Returns:

the returned AuthorizationEnabler list

Throws:

NullArgumentException - authorizationEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablersByParentGenusType

AuthorizationEnablerList getAuthorizationEnablersByParentGenusType(Type authorizationEnablerGenusType)
                                                                   throws OperationFailedException,
                                                                          PermissionDeniedException

Gets an AuthorizationEnablerList corresponding to the given authorization enabler genus Type and include any additional authorization enablers with genus types derived from the specified Type. In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization 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:

authorizationEnablerGenusType - an authorization enabler genus type

Returns:

the returned AuthorizationEnabler list

Throws:

NullArgumentException - authorizationEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablersByRecordType

AuthorizationEnablerList getAuthorizationEnablersByRecordType(Type authorizationEnablerRecordType)
                                                              throws OperationFailedException,
                                                                     PermissionDeniedException

Gets an AuthorizationEnablerList containing the given authorization enabler record Type. In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization 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:

authorizationEnablerRecordType - an authorization enabler record type

Returns:

the returned AuthorizationEnabler list

Throws:

NullArgumentException - authorizationEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAuthorizationEnablersOnDate

AuthorizationEnablerList getAuthorizationEnablersOnDate(DateTime from,
                                                      DateTime to)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

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

Parameters:

from - a start date

to - an end date

Returns:

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

getAuthorizationEnablersOnDateWithAgent

AuthorizationEnablerList getAuthorizationEnablersOnDateWithAgent(Id agentId,
                                                               DateTime from,
                                                               DateTime to)
                                                                 throws OperationFailedException,
                                                                        PermissionDeniedException

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

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

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

getAuthorizationEnablers

AuthorizationEnablerList getAuthorizationEnablers()
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets all AuthorizationEnablers. In plenary mode, the returned list contains all known authorization enablers or an error results. Otherwise, the returned list may contain only those authorization 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 AuthorizationEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.