public interface ProfileEntryEnablerProfileSession extends OsidSession
This session provides methods to retrieve ProfileEntryEnabler
to Profile
mappings. A ProfileEntryEnabler
may appear in multiple Profile
objects. 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 |
canLookupProfileEntryEnablerProfileMappings()
Tests if this user can perform lookups of profile entry
enabler/profile mappings.
|
IdList |
getProfileEntryEnablerIdsByProfile(Id profileId)
Gets the list of
ProfileEntryEnablerIds associated with
a Profile. |
IdList |
getProfileEntryEnablerIdsByProfiles(IdList profileIds)
Gets the list of
ProfileEntryEnabler Ids corresponding
to a list of Profiles. |
ProfileEntryEnablerList |
getProfileEntryEnablersByProfile(Id profileId)
Gets the list of profile entry enablers associated with a
Profile. |
ProfileEntryEnablerList |
getProfileEntryEnablersByProfiles(IdList profileIds)
Gets the list of profile entry enablers corresponding to a list of
Profiles. |
IdList |
getProfileIdsByProfileEntryEnabler(Id profileEntryEnablerId)
Gets the
Profile Ids mapped to a
ProfileEntryEnabler. |
ProfileList |
getProfilesByProfileEntryEnabler(Id profileEntryEnablerId)
Gets the
Profiles mapped to a
ProfileEntryEnabler. |
void |
useComparativeProfileEntryEnablerProfileView()
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 |
usePlenaryProfileEntryEnablerProfileView()
A complete view of the
ProfileEntryEnabler and
Profile returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupProfileEntryEnablerProfileMappings()
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 useComparativeProfileEntryEnablerProfileView()
mandatory
- This method is must be implemented. void usePlenaryProfileEntryEnablerProfileView()
ProfileEntryEnabler
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 getProfileEntryEnablerIdsByProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntryEnablerIds
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. ProfileEntryEnablerList getProfileEntryEnablersByProfile(Id profileId) throws NotFoundException, OperationFailedException, PermissionDeniedException
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 getProfileEntryEnablerIdsByProfiles(IdList profileIds) throws OperationFailedException, PermissionDeniedException
ProfileEntryEnabler 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. ProfileEntryEnablerList getProfileEntryEnablersByProfiles(IdList profileIds) throws OperationFailedException, PermissionDeniedException
Profiles.
profileIds
- list of profile Ids
NullArgumentException
- profileIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getProfileIdsByProfileEntryEnabler(Id profileEntryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Profile
Ids
mapped to a
ProfileEntryEnabler.
profileEntryEnablerId
- Id
of a
ProfileEntryEnabler
NotFoundException
- profileEntryEnablerId
is not foundNullArgumentException
- profileEntryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileList getProfilesByProfileEntryEnabler(Id profileEntryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Profiles
mapped to a
ProfileEntryEnabler.
profileEntryEnablerId
- Id
of a
ProfileEntryEnabler
NotFoundException
- profileEntryEnablerId
is not foundNullArgumentException
- profileEntryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.