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:
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupProfileItemProfileMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeProfileView()
mandatory
- This method is must be implemented. void usePlenaryProfileView()
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.mandatory
- This method is must be implemented. IdList getProfileItemIdsByProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileItem
Ids
associated with a Profile.
profileId
- Id
of the Profile
Ids
NotFoundException
- profileId
is not
foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileItemList getProfileItemsByProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileItems
associated with a
Profile.
profileId
- Id
of the Profile
NotFoundException
- profileId
is not
foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getProfileItemIdsByProfiles(IdList profileIds) throws OperationFailedException, PermissionDeniedException
ProfileItem Ids
corresponding to a
list of Profiles.
profileIds
- list of profile Ids
Ids
NullArgumentException
- profileIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileItemList getProfileItemsByProfiles(IdList profileIds) throws OperationFailedException, PermissionDeniedException
ProfileItems
corresponding to a list
of Profiles.
profileIds
- list of profile Ids
NullArgumentException
- profileIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getProfileIdsByProfileItem(Id profileItemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Profile
Ids
mapped to a
ProfileItem.
profileItemId
- Id
of a ProfileItem
Ids
NotFoundException
- profileItemId
is not
foundNullArgumentException
- profileItemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileList getProfilesByProfileItem(Id profileItemId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Profiles
mapped to a
ProfileItem.
profileItemId
- Id
of a ProfileItem
NotFoundException
- profileItemId
is not
foundNullArgumentException
- profileItemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.