org.osid.profile.rules

Interface ProfileEntryEnablerRuleLookupSession

All Superinterfaces:

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

public interface ProfileEntryEnablerRuleLookupSession
extends OsidSession

This session provides methods to retrieve ProfileEntryEnabler to ProfileEntry mappings. A Profile with multiple ProfileEntryEnablers means any positive rule evaluation across the enablers result in an enabled ProfileEntry.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated profile view: All methods in this session operate, retrieve and pertain profile entry enablers defined explicitly in the current profile
• federated profile view: All 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.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupProfileEntryEnablerRules() Tests if this user can perform lookups of profile entry enabler/profile entry mappings.
Profile	getProfile() Gets the Profile associated with this session.
ProfileEntryList	getProfileEntriesForProfileEntryEnabler(Id profileEntryEnablerId) Gets the ProfileEntries mapped to a ProfileEntryEnabler.
IdList	getProfileEntryEnablerIdsForProfileEntry(Id profileEntryId) Gets the ProfileEntryEnabler Id associated with a ProfileEntry.
ProfileEntryEnablerList	getProfileEntryEnablersForProfileEntry(Id profileEntryId) Gets the ProfileEntryEnabler associated with a ProfileEntry.
IdList	getProfileEntryIdsForProfileEntryEnabler(Id profileEntryEnablerId) Gets the ProfileEntry Ids mapped to a ProfileEntryEnabler.
Id	getProfileId() Gets the Profile Id associated with this session.
void	useComparativeProfileEntryEnablerRuleView() 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	usePlenaryProfileEntryEnablerRuleView() A complete view of the ProfileEntryEnabler and ProfileEntry 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.

canLookupProfileEntryEnablerRules

boolean canLookupProfileEntryEnablerRules()

Tests if this user can perform lookups of profile entry enabler/profile entry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeProfileEntryEnablerRuleView

void useComparativeProfileEntryEnablerRuleView()

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.

usePlenaryProfileEntryEnablerRuleView

void usePlenaryProfileEntryEnablerRuleView()

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

getProfileEntryEnablerIdsForProfileEntry

IdList getProfileEntryEnablerIdsForProfileEntry(Id profileEntryId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the ProfileEntryEnabler Id associated with a ProfileEntry.

Parameters:

profileEntryId - Id of the ProfileEntry

Returns:

the profile entry enabler Ids

Throws:

NotFoundException - profileEntryId is not found

NullArgumentException - profileEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntryEnablersForProfileEntry

ProfileEntryEnablerList getProfileEntryEnablersForProfileEntry(Id profileEntryId)
                                                               throws NotFoundException,
                                                                      OperationFailedException,
                                                                      PermissionDeniedException

Gets the ProfileEntryEnabler associated with a ProfileEntry.

Parameters:

profileEntryId - Id of the ProfileEntry

Returns:

the profile entry enablers

Throws:

NotFoundException - profileEntryId is not found

NullArgumentException - profileEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntryIdsForProfileEntryEnabler

IdList getProfileEntryIdsForProfileEntryEnabler(Id profileEntryEnablerId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the ProfileEntry Ids mapped to a ProfileEntryEnabler.

Parameters:

profileEntryEnablerId - Id of a ProfileEntryEnabler

Returns:

list of profile entry Ids

Throws:

NotFoundException - profileEntryEnablerId is not found

NullArgumentException - profileEntryEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntriesForProfileEntryEnabler

ProfileEntryList getProfileEntriesForProfileEntryEnabler(Id profileEntryEnablerId)
                                                         throws NotFoundException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Gets the ProfileEntries mapped to a ProfileEntryEnabler.

Parameters:

profileEntryEnablerId - Id of a ProfileEntryEnabler

Returns:

list of profile entries

Throws:

NotFoundException - profileEntryEnablerId is not found

NullArgumentException - profileEntryEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.