public interface ResourceRelationshipSmartBinSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A ResourceRelationshipQuery
can be retrieved from
this session and mapped to this Bin
to create a virtual
collection of ResourceRelationships.
The resource
relationships may be sequenced using the
ResourceRelationshipSearchOrder
from this session.
This Bin
has a default query that matches any resource
and a default search order that specifies no sequencing. The queries may
be examined using a ResourceRelationshipQueryInspector.
The
query may be modified by converting the inspector back to a
ResourceRelationshipQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyResourceRelationshipQuery(ResourceRelationshipQuery resourceQuery)
Applies a resource relationship query to this bin.
|
void |
applyResourceRelationshipSequencing(ResourceRelationshipSearchOrder resourceRelationshipSearchOrder)
Applies a resource relationship search order to this bin.
|
boolean |
canManageSmartBins()
Tests if this user can manage smart bins.
|
Bin |
getBin()
Gets the
Bin associated with this session. |
Id |
getBinId()
Gets the
Bin Id associated with this
session. |
ResourceRelationshipQuery |
getResourceRelationshipQuery()
Gets a resource relationship query.
|
ResourceQuery |
getResourceRelationshipQueryFromInspector(ResourceRelationshipQueryInspector resourceRelationshipQueryInspector)
Gets a resource relationship query from an inspector.
|
ResourceRelationshipSearchOrder |
getResourceRelationshipSearchOrder()
Gets a resource relationship search order.
|
ResourceRelationshipQueryInspector |
inspectResourceRelationshipQuery()
Gets a resource relationship query inspector for this bin.
|
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. Bin
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartBins()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart bin management is not
authorized, true
otherwisemandatory
- This method must be implemented. ResourceRelationshipQuery getResourceRelationshipQuery()
mandatory
- This method must be implemented. ResourceRelationshipSearchOrder getResourceRelationshipSearchOrder()
mandatory
- This method must be implemented. void applyResourceRelationshipQuery(ResourceRelationshipQuery resourceQuery) throws OperationFailedException, PermissionDeniedException
resourceQuery
- the resource relationship queryNullArgumentException
-
resourceRelationshipQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- resourceRelationshipQuery
not of this servicemandatory
- This method must be implemented. ResourceRelationshipQueryInspector inspectResourceRelationshipQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyResourceRelationshipSequencing(ResourceRelationshipSearchOrder resourceRelationshipSearchOrder) throws OperationFailedException, PermissionDeniedException
resourceRelationshipSearchOrder
- the resource relationship
search orderNullArgumentException
-
resourceRelationshipSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
resourceRelationshipSearchOrder
not of this servicemandatory
- This method must be implemented. ResourceQuery getResourceRelationshipQueryFromInspector(ResourceRelationshipQueryInspector resourceRelationshipQueryInspector)
resourceRelationshipQueryInspector
- a resource relationship
query inspectorNullArgumentException
-
resourceRelationshipQueryInspector
is null
UnsupportedException
-
resourceRelationshipQueryInspector
is not of this
servicemandatory
- This method must be implemented.