public interface FamilyQuerySession extends OsidSession
This session provides methods for searching Family
objects. The search query is constructed using the FamilyQuery.
The family record Type
also specifies the record
for the family query.
Families may have a query record indicated by their respective record
types. The query record is accessed via the FamilyQuery.
The returns in this session may not be cast directly to these interfaces.
Modifier and Type | Method and Description |
---|---|
boolean |
canSearchFamilies()
Tests if this user can perform
Family searches. |
FamilyList |
getFamiliesByQuery(FamilyQuery familyQuery)
Gets a list of
Family objects matching the given family
query. |
FamilyQuery |
getFamilyQuery()
Gets a family query.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canSearchFamilies()
Family
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. FamilyQuery getFamilyQuery()
mandatory
- This method must be implemented. FamilyList getFamiliesByQuery(FamilyQuery familyQuery) throws OperationFailedException, PermissionDeniedException
Family
objects matching the given family
query.familyQuery
- the family query FamilyList
NullArgumentException
- familyQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- familyQuery
is
not of this servicemandatory
- This method must be implemented.