Interface ProfileEntryProfileSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProfileEntryProfileSession
extends OsidSession

This session provides methods to retrieve ProfileEntry to Profile mappings. A ProfileEntry may appear in multiple Profile.s Each Profile may have its own authorizations governing who is allowed to look at it.

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupProfileEntryProfileMappings()	Tests if this user can perform lookups of profile entry/profile mappings.
ProfileList	getProfileByProfileEntry(Id profileEntryId)	Gets the list of Profile objects mapped to a ProfileEntry .
ProfileEntryList	getProfileEntriesByProfile(Id profileId)	Gets the list of ProfileEntries associated with a Profile .
ProfileEntryList	getProfileEntriesByProfile(IdList profileIds)	Gets the list of ProfileEntries corresponding to a list of Profile .
IdList	getProfileEntriesIdsByProfile(IdList profileIds)	Gets the list of ProfileEntry Ids corresponding to a list of Profile objects.
IdList	getProfileEntryIdsByProfile(Id profileId)	Gets the list of ProfileEntry Ids associated with a Profile .
IdList	getProfileIdsByProfileEntry(Id profileEntryId)	Gets the list of Profile Ids mapped to a ProfileEntry .
void	useComparativeProfileView()	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	usePlenaryProfileView()	A complete view of the ProfileEntry and Profile 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

useComparativeProfileView

void useComparativeProfileView()

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.

usePlenaryProfileView

void usePlenaryProfileView()

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

canLookupProfileEntryProfileMappings

boolean canLookupProfileEntryProfileMappings()

Tests if this user can perform lookups of profile entry/profile 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.

getProfileEntryIdsByProfile

IdList getProfileEntryIdsByProfile(Id profileId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of ProfileEntry Ids associated with a Profile .

Parameters:

profileId - Id of a Profile

Returns:

list of related profile entry Ids

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntriesByProfile

ProfileEntryList getProfileEntriesByProfile(Id profileId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of ProfileEntries associated with a Profile .

Parameters:

profileId - Id of a Profile

Returns:

list of related profile entry

Throws:

NotFoundException - profileId is not found

NullArgumentException - profileId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntriesIdsByProfile

IdList getProfileEntriesIdsByProfile(IdList profileIds)
                              throws OperationFailedException,
PermissionDeniedException

Gets the list of ProfileEntry Ids corresponding to a list of Profile objects.

Parameters:

profileIds - list of profile Ids

Returns:

list of profile entry Ids

Throws:

NullArgumentException - profileIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileEntriesByProfile

ProfileEntryList getProfileEntriesByProfile(IdList profileIds)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the list of ProfileEntries corresponding to a list of Profile .

Parameters:

profileIds - list of profile Ids

Returns:

list of profile entries

Throws:

NullArgumentException - profileIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileIdsByProfileEntry

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

Gets the list of Profile Ids mapped to a ProfileEntry .

Parameters:

profileEntryId - Id of a ProfileEntry

Returns:

list of profile 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.

getProfileByProfileEntry

ProfileList getProfileByProfileEntry(Id profileEntryId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Profile objects mapped to a ProfileEntry .

Parameters:

profileEntryId - Id of a ProfileEntry

Returns:

list of profile

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.