public interface ProfileEntryLookupSession extends OsidSession
This session defines methods to search and retrieve ProfileEntry
mappings.
This lookup session defines two sets of views:
ProfileEntries
defined
explicitly in the current Profile.
Using an isolated
view is useful for managing ProfileEntries
with the
ProfileEntryAdminSession.
Resource
groups. Resource
groups. The view methods such as useExplicitProfileEntryView()
and useImplicitProfileEntryView()
behave as a radio group
and one should be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupProfileEntries()
Tests if this user can perform profile lookups.
|
ProfileEntry |
getExplicitProfileEntry(Id profileEntryId)
Gets the explicit
ProfileEntry that generated the given
implicit profile entry. |
Profile |
getProfile()
Gets the
Profile associated with this session. |
ProfileEntryList |
getProfileEntries()
Geta all
ProfileEntries. |
ProfileEntryList |
getProfileEntriesByGenusType(Type profileEntryGenusType)
Gets a
ProfileEntryList corresponding to the given
profile entry genus Type which does not include profile
entries of genus types derived from the specified Type. |
ProfileEntryList |
getProfileEntriesByIds(IdList profileEntryIds)
Gets an
ProfileEntryList corresponding to the given
IdList. |
ProfileEntryList |
getProfileEntriesByParentGenusType(Type profileEntryGenusType)
Gets a
ProfileEntryList corresponding to the given
profile entry genus Type and include profile entries of
genus types derived from the specified Type. |
ProfileEntryList |
getProfileEntriesByRecordType(Type profileEntryRecordType)
Gets a
ProfileEntryList containing the given profile
entry record Type. |
ProfileEntryList |
getProfileEntriesForAgent(Id agentId)
Gets a list of
ProfileEntries associated with a given
agent. |
ProfileEntryList |
getProfileEntriesForAgentAndProfileItem(Id agentId,
Id profileItemId)
Gets a list of
ProfileEntries associated for entries
explicitly mapped to a given agent and profile item. |
ProfileEntryList |
getProfileEntriesForAgentAndProfileItemOnDate(Id agentId,
Id profileItemId,
DateTime from,
DateTime to)
Gets a
ProfileEntryList for entries explicitly mapped
to a given agent and profile item and effective during the entire
given date range inclusive but not confined to the date range. |
ProfileEntryList |
getProfileEntriesForAgentOnDate(Id agentId,
DateTime from,
DateTime to)
Gets a
ProfileEntryList for the given agent and
effective during the entire given date range inclusive but not
confined to the date range. |
ProfileEntryList |
getProfileEntriesForProfileItem(Id profileItemId)
Gets a
ProfileEntryList for a given profile item. |
ProfileEntryList |
getProfileEntriesForProfileItemOnDate(Id profileItemId,
DateTime from,
DateTime to)
Gets a
ProfileEntryList for the given profile item and
effective during the entire given date range inclusive but not
confined to the date range. |
ProfileEntryList |
getProfileEntriesForResource(Id resourceId)
Gets a list of
ProfileEntries associated for entries
related to a given resource. |
ProfileEntryList |
getProfileEntriesForResourceAndProfileItem(Id resourceId,
Id profileItemId)
Gets a list of
ProfileEntries associated for entries
explicitly mapped to a given resource and profile item. |
ProfileEntryList |
getProfileEntriesForResourceAndProfileItemOnDate(Id resourceId,
Id profileItemId,
DateTime from,
DateTime to)
Gets a
ProfileEntryList for entries explicitly mapped
to a given resource and profile item and effective during the entire
given date range inclusive but not confined to the date range. |
ProfileEntryList |
getProfileEntriesForResourceOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a
ProfileEntryList for entries explicitly mapped
to a given resource and effective during the entire given date range
inclusive but not confined to the date range. |
ProfileEntryList |
getProfileEntriesOnDate(DateTime from,
DateTime to)
Gets a
ProfileEntryList effective date during the
entire given date range inclusive but not confined to the date range. |
ProfileEntry |
getProfileEntry(Id profileEntryId)
Gets the
ProfileEntry specified by its Id. |
Id |
getProfileId()
Gets the
Profile Id associated with this
session. |
void |
useAnyEffectiveProfileEntryView()
All profile entries of any effective dates are returned by all methods
in this session.
|
void |
useComparativeProfileEntryView()
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 |
useEffectiveProfileEntryView()
Only profile entries whose effective dates are current are returned by
methods in this session.
|
void |
useExplicitProfileEntryView()
Sets the view for methods in this session to explicit profile entries.
|
void |
useExplicitResourceView()
Only include profile entries explicitly mapped to the given resource
when looking up profile entries by resource.
|
void |
useFederatedProfileView()
Federates the view for methods in this session.
|
void |
useImplicitProfileEntryView()
Sets the view for methods in this session to implicit profile entries.
|
void |
useImplicitResourceView()
Include profile entries of any agent of a resource when looking up
profile entries by resource.
|
void |
useIsolatedProfileView()
Isolates the view for methods in this session.
|
void |
usePlenaryProfileEntryView()
A complete view of the
ProfileEntry returns is desired. |
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 canLookupProfileEntries()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeProfileEntryView()
mandatory
- This method is must be implemented. void usePlenaryProfileEntryView()
ProfileEntry
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. void useFederatedProfileView()
mandatory
- This method is must be implemented. void useIsolatedProfileView()
mandatory
- This method is must be implemented. void useEffectiveProfileEntryView()
mandatory
- This method is must be implemented. void useAnyEffectiveProfileEntryView()
mandatory
- This method is must be implemented. void useImplicitProfileEntryView()
ProfileItem
or
Resource
hierarchies. This method is the opposite of
explicitProfileEntryView().
mandatory
- This method is must be implemented. void useExplicitProfileEntryView()
implicitProfileEntryView().
mandatory
- This method is must be implemented. void useImplicitResourceView()
mandatory
- This method is must be implemented. void useExplicitResourceView()
mandatory
- This method is must be implemented. ProfileEntry getProfileEntry(Id profileEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntry
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ProfileEntry
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an ProfileEntry
and retained for
compatibility.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.profileEntryId
- the Id
of the
ProfileEntry
to retrieve ProfileEntry
NotFoundException
- no ProfileEntry
found with the given Id
NullArgumentException
- profileEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesByIds(IdList profileEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntryList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
entries specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible ProfileEntries
may be omitted from the
list and may present the elements in any order including returning a
unique set.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.profileEntryIds
- the list of Ids
to retrieve ProfileEntry list
NotFoundException
- an Id was
not foundNullArgumentException
- profileEntryIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesByGenusType(Type profileEntryGenusType) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
corresponding to the given
profile entry genus Type
which does not include profile
entries of genus types derived from the specified Type.
In plenary mode, the returned list contains all known profile entries
or an error results. Otherwise, the returned list may contain only
those profile ebtries that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.profileEntryGenusType
- a profile entry genus type ProfileEntry
listNullArgumentException
- profileEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntryList getProfileEntriesByParentGenusType(Type profileEntryGenusType) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
corresponding to the given
profile entry genus Type and
include profile entries of
genus types derived from the specified Type.
In plenary mode, the returned list contains all known
profile entries or an error results. Otherwise, the returned list may
contain only those profile ebtries that are accessible through this
session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.profileEntryGenusType
- a profile entry genus type ProfileEntry
listNullArgumentException
- profileEntryGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntryList getProfileEntriesByRecordType(Type profileEntryRecordType) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
containing the given profile
entry record Type.
In plenary mode, the returned list contains all known
profile entries or an error results. Otherwise, the returned list may
contain only those profile entries that are accessible through this
session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.profileEntryRecordType
- a profile entry record type ProfileEntry
listNullArgumentException
- profileEntryRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntryList getProfileEntriesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
effective date during the
entire given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known authorizations
or an error results. Otherwise, the returned list may contain only
those authorizations that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective in addition to being effective durting the date range. In
any effective mode, effective profile entries and those currently
expired are returned.from
- starting dateto
- ending date ProfileEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
ProfileEntries
associated for entries
related to a given resource.
In explicit resource view, only include entries with the given
resource. In implicit resource view, also include entries using any
agent of the given resource.
In plenary mode, the returned list contains all known profile entries
or an error results. Otherwise, the returned list may contain only
those profile ebtries that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.resourceId
- a resource Id
ProfileEntry list
NullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForResourceOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
for entries explicitly mapped
to a given resource and effective during the entire given date range
inclusive but not confined to the date range.
In explicit resource view, only include entries with the given
resource. In implicit resource view, also include entries using any
agent of the given resource.
In plenary mode, the returned list contains all known authorizations
or an error results. Otherwise, the returned list may contain only
those authorizations that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.resourceId
- a resource Id
from
- starting dateto
- ending date ProfileEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForAgent(Id agentId) throws OperationFailedException, PermissionDeniedException
ProfileEntries
associated with a given
agent.
In plenary mode, the returned list contains all known profile entries
or an error results. Otherwise, the returned list may contain only
those profile ebtries that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.agentId
- an agent Id
ProfileEntry list
NullArgumentException
- agentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForAgentOnDate(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
for the given agent and
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known authorizations
or an error results. Otherwise, the returned list may contain only
those authorizations that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective in addition to being effective during the date range. In any
effective mode, effective profile entries and those currently expired
are returned.agentId
- an agent Id
from
- starting dateto
- ending date ProfileEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForProfileItem(Id profileItemId) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
for a given profile item.
In plenary mode, the returned list contains all known profile entries
or an error results. Otherwise, the returned list may contain only
those profile entries that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.profileItemId
- a profile item Id
ProfileEntry list
NullArgumentException
- profileItemId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForProfileItemOnDate(Id profileItemId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
for the given profile item and
effective during the entire given date range inclusive but not
confined to the date range.
In plenary mode, the returned list contains all known authorizations
or an error results. Otherwise, the returned list may contain only
those authorizations that are accessible through this session.
In effective mode, profile entries are returned that are currently
effectiv in addition to being effective during the date range. In any
effective mode, effective profile entries and those currently expired
are returned.profileItemId
- a profile item Id
from
- starting dateto
- ending date ProfileEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- profileItemId, from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForResourceAndProfileItem(Id resourceId, Id profileItemId) throws OperationFailedException, PermissionDeniedException
ProfileEntries
associated for entries
explicitly mapped to a given resource and profile item.
In explicit resource view, only include entries with the given
resource. In implicit resource view, also include entries using any
agent of the given resource.
In plenary mode, the returned list contains all known profile entries
or an error results. Otherwise, the returned list may contain only
those profile ebtries that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.resourceId
- a resource Id
profileItemId
- a profile item Id
ProfileEntry list
NullArgumentException
- resourceId
or
profileItemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForResourceAndProfileItemOnDate(Id resourceId, Id profileItemId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
for entries explicitly mapped
to a given resource and profile item and effective during the entire
given date range inclusive but not confined to the date range.
In explicit resource view, only include entries with the given
resource. In implicit resource view, also include entries using any
agent of the given resource.
In plenary mode, the returned list contains all known authorizations
or an error results. Otherwise, the returned list may contain only
those authorizations that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.resourceId
- a resource Id
profileItemId
- a profile item Id
from
- starting dateto
- ending date ProfileEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId,
profileItemId, from
or to
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForAgentAndProfileItem(Id agentId, Id profileItemId) throws OperationFailedException, PermissionDeniedException
ProfileEntries
associated for entries
explicitly mapped to a given agent and profile item.
In plenary mode, the returned list contains all known profile entries
or an error results. Otherwise, the returned list may contain only
those profile ebtries that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.agentId
- an agent Id
profileItemId
- a profile item Id
ProfileEntry list
NullArgumentException
- agentId
or
profileItemId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntriesForAgentAndProfileItemOnDate(Id agentId, Id profileItemId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
ProfileEntryList
for entries explicitly mapped
to a given agent and profile item and effective during the entire
given date range inclusive but not confined to the date range.
In plenary mode, the returned list contains all known authorizations
or an error results. Otherwise, the returned list may contain only
those authorizations that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned.agentId
- an agent Id
profileItemId
- a profile item Id
from
- starting dateto
- ending date ProfileEntry
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, profileItemId,
from
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. ProfileEntry getExplicitProfileEntry(Id profileEntryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProfileEntry
that generated the given
implicit profile entry. If the given ProfileEntry
is
explicit, then the same ProfileEntry
is returned.profileEntryId
- a profile entry ProfileEntry
NotFoundException
- profileEntryId
is
not foundNullArgumentException
- profileEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProfileEntryList getProfileEntries() throws OperationFailedException, PermissionDeniedException
ProfileEntries.
In plenary mode, the returned list contains all known profile entries
or an error results. Otherwise, the returned list may contain only
those profile ebtries that are accessible through this session.
In effective mode, profile entries are returned that are currently
effective. In any effective mode, effective profile entries and those
currently expired are returned. ProfileEntries
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.