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:
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
void useComparativeProfileView()
mandatory
- This method is must be implemented. void usePlenaryProfileView()
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.mandatory
- This method is must be implemented. boolean canLookupProfileEntryProfileMappings()
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. IdList getProfileEntryIdsByProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntry
Ids
associated with a Profile.
profileId
- Id
of a Profile
Ids
NotFoundException
- profileId
is not
foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesByProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntries
associated with a
Profile.
profileId
- Id
of a Profile
NotFoundException
- profileId
is not
foundNullArgumentException
- profileId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getProfileEntriesIdsByProfile(IdList profileIds) throws OperationFailedException, PermissionDeniedException
ProfileEntry Ids
corresponding to a
list of Profile
objects.profileIds
- list of profile Ids
Ids
NullArgumentException
- profileIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesByProfile(IdList profileIds) throws OperationFailedException, PermissionDeniedException
ProfileEntries
corresponding to a list
of Profile.
profileIds
- list of profile Ids
NullArgumentException
- profileIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getProfileIdsByProfileEntry(Id profileEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Profile
Ids
mapped to a
ProfileEntry.
profileEntryId
- Id
of a ProfileEntry
Ids
NotFoundException
- profileEntryId
is
not foundNullArgumentException
- profileEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileList getProfileByProfileEntry(Id profileEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Profile
objects mapped to a
ProfileEntry.
profileEntryId
- Id
of a ProfileEntry
NotFoundException
- profileEntryId
is
not foundNullArgumentException
- profileEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.