org.osid.profile.rules

Interface ProfileEntryEnablerLookupSession

All Superinterfaces:

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

public interface ProfileEntryEnablerLookupSession
extends OsidSession

This session provides methods for retrieving ProfileEntryEnablers.

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 profile view: All profile entry enabler methods in this session operate, retrieve and pertain to profile entry enablers defined explicitly in the current profile. Using an isolated view is useful for managing ProfileEntryEnablers with the ProfileEntryEnablerAdminSession.
• federated profile view: All profile entry enabler methods in this session operate, retrieve and pertain to all profile entry enablers defined in this profile and any other profile entry enablers implicitly available in this profile through profile inheritence.
• status profile entry enabler view: All profile entry enabler lookup methods return active profile entry.
• any status profile entry enabler view: Profile entry 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	canLookupProfileEntryEnablers() Tests if this user can perform ProfileEntryEnablers lookups.
Profile	getProfile() Gets the Profile associated with this session.
ProfileEntryEnabler	getProfileEntryEnabler(Id profileEntryEnablerId) Gets the ProfileEntryEnabler specified by its Id.
ProfileEntryEnablerList	getProfileEntryEnablers() Gets all ProfileEntryEnablers.
ProfileEntryEnablerList	getProfileEntryEnablersByGenusType(Type profileEntryEnablerGenusType) Gets a ProfileEntryEnablerList corresponding to the given profile entry enabler genus Type which does not include profile entry enablers of genus types derived from the specified Type.
ProfileEntryEnablerList	getProfileEntryEnablersByIds(IdList profileEntryEnablerIds) Gets a ProfileEntryEnablerList corresponding to the given IdList.
ProfileEntryEnablerList	getProfileEntryEnablersByParentGenusType(Type profileEntryEnablerGenusType) Gets a ProfileEntryEnablerList corresponding to the given profile entry enabler genus Type and include any additional profile entry enablers with genus types derived from the specified Type.
ProfileEntryEnablerList	getProfileEntryEnablersByRecordType(Type profileEntryEnablerRecordType) Gets a ProfileEntryEnablerList containing the given profile entry enabler record Type.
ProfileEntryEnablerList	getProfileEntryEnablersOnDate(DateTime from, DateTime to) Gets a ProfileEntryEnablerList effective during the entire given date range inclusive but not confined to the date range for any agent.
ProfileEntryEnablerList	getProfileEntryEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) Gets a ProfileEntryEnablerList effective during the entire given date range inclusive but not confined to the date range aveluated against the given agent.
Id	getProfileId() Gets the Profile Id associated with this session.
void	useActiveProfileEntryEnablerView() Only active profile entry enablers are returned by methods in this session.
void	useAnyStatusProfileEntryEnablerView() All active and inactive profile entry enablers are returned by methods in this session.
void	useComparativeProfileEntryEnablerView() 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	useFederatedProfileView() Federates the view for methods in this session.
void	useIsolatedProfileView() Isolates the view for methods in this session.
void	usePlenaryProfileEntryEnablerView() A complete view of the ProfileEntryEnabler 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

getProfileId

Id getProfileId()

Gets the Profile Id associated with this session.

Returns:

the Profile Id associated with this session

Compliance:

mandatory - This method must be implemented.

getProfile

Profile getProfile()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Profile associated with this session.

Returns:

the profile

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupProfileEntryEnablers

boolean canLookupProfileEntryEnablers()

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

useComparativeProfileEntryEnablerView

void useComparativeProfileEntryEnablerView()

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.

usePlenaryProfileEntryEnablerView

void usePlenaryProfileEntryEnablerView()

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

useFederatedProfileView

void useFederatedProfileView()

Federates the view for methods in this session. A federated view will include profile entry enablers in profiles which are children of this profile in the profile hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedProfileView

void useIsolatedProfileView()

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

Compliance:

mandatory - This method is must be implemented.

useActiveProfileEntryEnablerView

void useActiveProfileEntryEnablerView()

Only active profile entry enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusProfileEntryEnablerView

void useAnyStatusProfileEntryEnablerView()

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

Compliance:

mandatory - This method is must be implemented.

getProfileEntryEnabler

ProfileEntryEnabler getProfileEntryEnabler(Id profileEntryEnablerId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

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

Parameters:

profileEntryEnablerId - Id of the ProfileEntryEnabler

Returns:

the profile entry enabler

Throws:

NotFoundException - profileEntryEnablerId not found

NullArgumentException - profileEntryEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getProfileEntryEnablersByIds

ProfileEntryEnablerList getProfileEntryEnablersByIds(IdList profileEntryEnablerIds)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

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

Parameters:

profileEntryEnablerIds - the list of Ids to retrieve

Returns:

the returned ProfileEntryEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - profileEntryEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablersByGenusType

ProfileEntryEnablerList getProfileEntryEnablersByGenusType(Type profileEntryEnablerGenusType)
                                                           throws OperationFailedException,
                                                                  PermissionDeniedException

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

Parameters:

profileEntryEnablerGenusType - a profile entry enabler genus type

Returns:

the returned ProfileEntryEnabler list

Throws:

NullArgumentException - profileEntryEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablersByParentGenusType

ProfileEntryEnablerList getProfileEntryEnablersByParentGenusType(Type profileEntryEnablerGenusType)
                                                                 throws OperationFailedException,
                                                                        PermissionDeniedException

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

Parameters:

profileEntryEnablerGenusType - a profile entry enabler genus type

Returns:

the returned ProfileEntryEnabler list

Throws:

NullArgumentException - profileEntryEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablersByRecordType

ProfileEntryEnablerList getProfileEntryEnablersByRecordType(Type profileEntryEnablerRecordType)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

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

Parameters:

profileEntryEnablerRecordType - a profile entry enabler record type

Returns:

the returned ProfileEntryEnabler list

Throws:

NullArgumentException - profileEntryEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablersOnDate

ProfileEntryEnablerList getProfileEntryEnablersOnDate(DateTime from,
                                                    DateTime to)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

from - a start date

to - an end date

Returns:

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

getProfileEntryEnablersOnDateWithAgent

ProfileEntryEnablerList getProfileEntryEnablersOnDateWithAgent(Id agentId,
                                                             DateTime from,
                                                             DateTime to)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

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

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

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

getProfileEntryEnablers

ProfileEntryEnablerList getProfileEntryEnablers()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

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

Returns:

the returned ProfileEntryEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.