Interface ProfileItemProfileSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface ProfileItemProfileSession
extends OsidSession

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

This lookup session defines two 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	canLookupProfileItemProfileMappings()	Tests if this user can perform lookups of profile/item mappings.
IdList	getProfileIdsByProfileItem(Id profileItemId)	Gets the list of Profile Ids mapped to a ProfileItem .
IdList	getProfileItemIdsByProfile(Id profileId)	Gets the list of ProfileItem Ids associated with a Profile .
IdList	getProfileItemIdsByProfiles(IdList profileIds)	Gets the list of ProfileItem Ids corresponding to a list of Profiles .
ProfileItemList	getProfileItemsByProfile(Id profileId)	Gets the list of ProfileItems associated with a Profile .
ProfileItemList	getProfileItemsByProfiles(IdList profileIds)	Gets the list of ProfileItems corresponding to a list of Profiles .
ProfileList	getProfilesByProfileItem(Id profileItemId)	Gets the list of Profiles mapped to a ProfileItem .
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 ProfileItem 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

canLookupProfileItemProfileMappings

boolean canLookupProfileItemProfileMappings()

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

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 ProfileItem 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.

getProfileItemIdsByProfile

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

Gets the list of ProfileItem Ids associated with a Profile .

Parameters:

profileId - Id of the Profile

Returns:

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

getProfileItemsByProfile

ProfileItemList getProfileItemsByProfile(Id profileId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of ProfileItems associated with a Profile .

Parameters:

profileId - Id of the Profile

Returns:

list of related profile items

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.

getProfileItemIdsByProfiles

IdList getProfileItemIdsByProfiles(IdList profileIds)
                            throws OperationFailedException,
PermissionDeniedException

Gets the list of ProfileItem Ids corresponding to a list of Profiles .

Parameters:

profileIds - list of profile Ids

Returns:

list of profile item Ids

Throws:

NullArgumentException - profileIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileItemsByProfiles

ProfileItemList getProfileItemsByProfiles(IdList profileIds)
                                   throws OperationFailedException,
PermissionDeniedException

Gets the list of ProfileItems corresponding to a list of Profiles .

Parameters:

profileIds - list of profile Ids

Returns:

list of profile items

Throws:

NullArgumentException - profileIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfileIdsByProfileItem

IdList getProfileIdsByProfileItem(Id profileItemId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Profile Ids mapped to a ProfileItem .

Parameters:

profileItemId - Id of a ProfileItem

Returns:

list of profile Ids

Throws:

NotFoundException - profileItemId is not found

NullArgumentException - profileItemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProfilesByProfileItem

ProfileList getProfilesByProfileItem(Id profileItemId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Profiles mapped to a ProfileItem .

Parameters:

profileItemId - Id of a ProfileItem

Returns:

list of profiles

Throws:

NotFoundException - profileItemId is not found

NullArgumentException - profileItemId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.