public interface ResourceRelationshipQuerySession extends OsidSession
This session provides methods for searching ResourceRelationship
objects. The search query is constructed using the
ResourceRelationshipQuery.
The resource relationship record
Type
also specifies the record for the relationship query.
This session defines views that offer differing behaviors for searching.
Relationships may have a query record indicated by their respective
record types. The query record is accessed via the
ResourceRelationshipQuery.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchResourceRelationships()
Tests if this user can perform
ResourceRelationship
searches. |
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
ResourceRelationshipQuery |
getResourceRelationshipQuery()
Gets a relationship query.
|
ResourceRelationshipList |
getResourceRelationshipsByQuery(ResourceRelationshipQuery resourceRelationshipQuery)
Gets a list of
ResourceRelationship matching the given
resource relationship query. |
void |
useFederatedBinView()
Federates the view for methods in this session.
|
void |
useIsolatedBinView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBinId()
Bin
Id
associated with this
session. Bin Id
associated with this sessionmandatory
- This method must be implemented. Bin getBin() throws OperationFailedException, PermissionDeniedException
Bin
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSearchResourceRelationships()
ResourceRelationship
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. void useFederatedBinView()
mandatory
- This method is must be implemented. void useIsolatedBinView()
mandatory
- This method is must be implemented. ResourceRelationshipQuery getResourceRelationshipQuery()
mandatory
- This method must be implemented. ResourceRelationshipList getResourceRelationshipsByQuery(ResourceRelationshipQuery resourceRelationshipQuery) throws OperationFailedException, PermissionDeniedException
ResourceRelationship
matching the given
resource relationship query.resourceRelationshipQuery
- the resource relationship query ResourceRelationshipList
NullArgumentException
-
resourceRelationshipQuery is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- resourceRelationshipQuery
is not of this servicemandatory
- This method must be implemented.