public interface ProfilingSession extends OsidSession
This is the basic session for querying profiles.
Modifier and Type | Method and Description |
---|---|
boolean |
canAccessProfileEntries()
Tests if this user can perform profile checks.
|
Profile |
getProfile()
Gets the
Profile associated with this session. |
ProfileEntryCondition |
getProfileEntryCondition(Id profileItemId)
Gets the
ProfileEntryCondition for making conditional
profile checks. |
Id |
getProfileId()
Gets the
Profile Id associated with this
session. |
boolean |
hasProfileEntry(Id profileItemId)
Determines if the question
Id of the profile entry is
true. |
boolean |
hasProfileEntryOnCondition(Id profileItemId,
ProfileEntryCondition condition)
Determines if the question
Id of the profile entry is
true. |
void |
useFederatedProfileView()
Federates the view for methods in this session.
|
void |
useIsolatedProfileView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getProfileId()
Profile
Id
associated with this
session. Profile Id
associated with this sessionmandatory
- This method must be implemented. Profile getProfile() throws OperationFailedException, PermissionDeniedException
Profile
associated with this session. Profile
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canAccessProfileEntries()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if profile methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedProfileView()
mandatory
- This method is must be implemented. void useIsolatedProfileView()
mandatory
- This method is must be implemented. boolean hasProfileEntry(Id profileItemId) throws OperationFailedException, PermissionDeniedException
Id
of the profile entry is
true.profileItemId
- the Id
of a ProfileItem
true
if the the profile question is true,
false
othersiseNullArgumentException
- profileItemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
making requestmandatory
- This method must be implemented. Profile
- entries may be stored in a normalized form with
respect to various Resources and created using specific nodes
in a ProfileItem
hierarchy. The provider needs
to maintain a de-normalized implicit profile entry store or
expand the applicable hierarchies on the fly to honor this
query. ProfileEntryCondition getProfileEntryCondition(Id profileItemId)
ProfileEntryCondition
for making conditional
profile checks.profileItemId
- the Id
of a ProfileItem
NullArgumentException
- profileItemId
is
null
mandatory
- This method must be implemented. boolean hasProfileEntryOnCondition(Id profileItemId, ProfileEntryCondition condition) throws OperationFailedException, PermissionDeniedException
Id
of the profile entry is
true.profileItemId
- the Id
of a ProfileItem
condition
- a profile entry condition true
if the profile entry is true, false
othersiseNullArgumentException
- profileItemId
or
condition
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
making requestUnsupportedException
- condition
is not
of this servicemandatory
- This method must be implemented. ProfileEntries
- may be stored in a normalized form with respect
to various Resources and created using specific nodes in a
ProfileItem
hierarchy. The provider needs to
maintain a de-normalized implicit entry store or expand the
applicable hierarchies on the fly to honor this query.