public interface RelationshipQuerySession extends OsidSession
This session provides methods for searching among Relationship
objects. The search query is constructed using the
Relationship.
Relationships may have a query record indicated by their respective
record types. The query record is accessed via the
RelationshipQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchRelationships()
Tests if this user can perform
Relationship searches. |
Family |
getFamily()
Gets the
Family associated with this session. |
Id |
getFamilyId()
Gets the
Family Id associated with this
session. |
RelationshipQuery |
getRelationshipQuery()
Gets a relationship query.
|
RelationshipList |
getRelationshipsByQuery(RelationshipQuery relationshipQuery)
Gets a list of
Relationships matching the given
relationship query. |
void |
useFederatedFamilyView()
Federates the view for methods in this session.
|
void |
useIsolatedFamilyView()
Isolates the view for methods in this session.
|
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. void useFederatedFamilyView()
mandatory
- This method is must be implemented. void useIsolatedFamilyView()
mandatory
- This method is must be implemented. boolean canSearchRelationships()
Relationship
searches. 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 search operations to
unauthorized users. false
if search methods are not authorized,
true
otherwisemandatory
- This method must be implemented. RelationshipQuery getRelationshipQuery()
mandatory
- This method must be implemented. RelationshipList getRelationshipsByQuery(RelationshipQuery relationshipQuery) throws OperationFailedException, PermissionDeniedException
Relationships
matching the given
relationship query.relationshipQuery
- the relationship query RelationshipList
NullArgumentException
- relationshipQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- relationshipQuery
is not of this servicemandatory
- This method must be implemented.