public interface RelationshipEnablerLookupSession extends OsidSession
This session provides methods for retrieving
RelationshipEnablers.
This session defines views that offer differing behaviors when retrieving multiple objects.
RelationshipEnablers
with the
RelationshipEnablerAdminSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRelationshipEnablers()
Tests if this user can perform
RelationshipEnablers
lookups. |
Family |
getFamily()
Gets the
Family associated with this session. |
Id |
getFamilyId()
Gets the
Family Id associated with this
session. |
RelationshipEnabler |
getRelationshipEnabler(Id relationshipEnablerId)
Gets the
RelationshipEnabler specified by its
Id. |
RelationshipEnablerList |
getRelationshipEnablers()
Gets all
RelationshipEnablers. |
RelationshipEnablerList |
getRelationshipEnablersByGenusType(Type relationshipEnablerGenusType)
Gets a
RelationshipEnablerList corresponding to the
given relationship enabler genus Type which does not
include relationship enablers of genus types derived from the
specified Type. |
RelationshipEnablerList |
getRelationshipEnablersByIds(IdList relationshipEnablerIds)
Gets a
RelationshipEnablerList corresponding to the
given IdList. |
RelationshipEnablerList |
getRelationshipEnablersByParentGenusType(Type relationshipEnablerGenusType)
Gets a
RelationshipEnablerList corresponding to the
given relationship enabler genus Type and include any
additional relationship enablers with genus types derived from the
specified Type. |
RelationshipEnablerList |
getRelationshipEnablersByRecordType(Type relationshipEnablerRecordType)
Gets a
RelationshipEnablerList containing the given
relationship enabler record Type. |
RelationshipEnablerList |
getRelationshipEnablersOnDate(DateTime from,
DateTime to)
Gets a
RelationshipEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range for any agent. |
RelationshipEnablerList |
getRelationshipEnablersOnDateWithAgent(Id agentId,
DateTime from,
DateTime to)
Gets a
RelationshipEnablerList that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent. |
void |
useActiveRelationshipEnablerView()
Only active relationship enablers are returned by methods in this
session.
|
void |
useAnyStatusRelationshipEnablerView()
All active and insactive relationship enablers are returned by methods
in this session.
|
void |
useComparativeRelationshipEnablerView()
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 |
useFederatedFamilyView()
Federates the view for methods in this session.
|
void |
useIsolatedFamilyView()
Isolates the view for methods in this session.
|
void |
usePlenaryRelationshipEnablerView()
A complete view of the
RelationshipEnabler returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFamilyId()
Family
Id
associated with this
session. Family Id
associated with this sessionmandatory
- This method must be implemented. Family getFamily() throws OperationFailedException, PermissionDeniedException
Family
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRelationshipEnablers()
RelationshipEnablers
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all methods in this
session will result in a 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 useComparativeRelationshipEnablerView()
mandatory
- This method is must be implemented. void usePlenaryRelationshipEnablerView()
RelationshipEnabler
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 useFederatedFamilyView()
mandatory
- This method is must be implemented. void useIsolatedFamilyView()
mandatory
- This method is must be implemented. void useActiveRelationshipEnablerView()
mandatory
- This method is must be implemented. void useAnyStatusRelationshipEnablerView()
mandatory
- This method is must be implemented. RelationshipEnabler getRelationshipEnabler(Id relationshipEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelationshipEnabler
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
RelationshipEnabler
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a RelationshipEnabler
and retained for
compatibility.
In active mode, relationship enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive relationship
enablers are returned.relationshipEnablerId
- Id
of the
RelationshipEnabler
NotFoundException
- relationshipEnablerId
not foundNullArgumentException
- relationshipEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. RelationshipEnablerList getRelationshipEnablersByIds(IdList relationshipEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RelationshipEnablerList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
relationship enablers 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 RelationshipEnablers
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, relationship enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive relationship
enablers are returned.relationshipEnablerIds
- the list of Ids
to
retrieve RelationshipEnabler
listNotFoundException
- an Id was
not foundNullArgumentException
- relationshipEnablerIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablersByGenusType(Type relationshipEnablerGenusType) throws OperationFailedException, PermissionDeniedException
RelationshipEnablerList
corresponding to the
given relationship enabler genus Type
which does not
include relationship enablers of genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
relationship enablers or an error results. Otherwise, the returned
list may contain only those relationship enablers that are accessible
through this session.
In active mode, relationship enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive relationship
enablers are returned.relationshipEnablerGenusType
- a relationship enabler genus type RelationshipEnabler
listNullArgumentException
-
relationshipEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablersByParentGenusType(Type relationshipEnablerGenusType) throws OperationFailedException, PermissionDeniedException
RelationshipEnablerList
corresponding to the
given relationship enabler genus Type
and include any
additional relationship enablers with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
relationship enablers or an error results. Otherwise, the returned
list may contain only those relationship enablers that are accessible
through this session.
In active mode, relationship enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive relationship
enablers are returned.relationshipEnablerGenusType
- a relationship enabler genus type RelationshipEnabler
listNullArgumentException
-
relationshipEnablerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablersByRecordType(Type relationshipEnablerRecordType) throws OperationFailedException, PermissionDeniedException
RelationshipEnablerList
containing the given
relationship enabler record Type.
In plenary mode, the returned list contains all known
relationship enablers or an error results. Otherwise, the returned
list may contain only those relationship enablers that are accessible
through this session.
In active mode, relationship enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive relationship
enablers are returned.relationshipEnablerRecordType
- a relationship enabler record
type RelationshipEnabler
listNullArgumentException
-
relationshipEnablerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelationshipEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range for any agent.
In plenary mode, the returned list contains all known
relationship enablers or an error results. Otherwise, the returned
list may contain only those relationship enablers that are accessible
through this session.
In active mode, relationship enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive relationship
enablers are returned.from
- a start dateto
- an end date RelationshipEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
RelationshipEnablerList
that are effective for
the entire given date range inclusive but not confined to the date
range and evaluated against the given agent.
In plenary mode, the returned list contains all known
relationship enablers or an error results. Otherwise, the returned
list may contain only those relationship enablers that are accessible
through this session.
In active mode, relationship enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive relationship
enablers are returned.agentId
- an agent Id
from
- a start dateto
- an end date RelationshipEnabler
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- agentId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RelationshipEnablerList getRelationshipEnablers() throws OperationFailedException, PermissionDeniedException
RelationshipEnablers.
In plenary mode, the returned list contains all known
relationship enablers or an error results. Otherwise, the returned
list may contain only those relationship enablers that are accessible
through this session.
In active mode, relationship enablers are returned that are currently
active in addition to being effective ib the given date range for the
given agent. In any status mode, active and inactive relationship
enablers are returned. RelationshipEnabler
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.