public interface IssueSmartOublietteSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. An IssueQuery
can be retrieved from this session
and oublietteped to this Oubliette
to create a virtual
collection of Issues.
The issues may be sequenced using the
IssueSearchOrder
from this session.
This Oubliette
has a default query that matches any
issue and a default search order that specifies no sequencing. The queries
may be examined using an IssueQueryInspector.
The query may
be modified by converting the inspector back to an IssueQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyIssueQuery(IssueQuery issueQuery)
Applies an issue query to this oubliette.
|
void |
applyIssueSequencing(IssueSearchOrder issueSearchOrder)
Applies an issue search order to this oubliette.
|
boolean |
canManageSmartOubliettes()
Tests if this user can manage smart oubliettes.
|
IssueQuery |
getIssueQuery()
Gets an issue query.
|
IssueQuery |
getIssueQueryFromInspector(IssueQueryInspector issueQueryInspector)
Gets an issue query from an inspector.
|
IssueSearchOrder |
getIssueSearchOrder()
Gets an issue search order.
|
Oubliette |
getOubliette()
Gets the
Oubliette associated with this session. |
Id |
getOublietteId()
Gets the
Oubliette Id associated with
this session. |
IssueQueryInspector |
inspecIssueQuery()
Gets an issue query inspector for this oubliette.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteId()
Oubliette
Id
associated with
this session. Oubliette Id
associated with this sessionmandatory
- This method must be implemented. Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
Oubliette
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartOubliettes()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart oubliette management is not
authorized, true
otherwisemandatory
- This method must be implemented. IssueQuery getIssueQuery()
mandatory
- This method must be implemented. IssueSearchOrder getIssueSearchOrder()
mandatory
- This method must be implemented. void applyIssueQuery(IssueQuery issueQuery) throws OperationFailedException, PermissionDeniedException
issueQuery
- the issue queryNullArgumentException
- issueQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- issueQuery
not of
this servicemandatory
- This method must be implemented. IssueQueryInspector inspecIssueQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyIssueSequencing(IssueSearchOrder issueSearchOrder) throws OperationFailedException, PermissionDeniedException
issueSearchOrder
- the issue search orderNullArgumentException
- issueSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- issueSearchOrder
not of this servicemandatory
- This method must be implemented. IssueQuery getIssueQueryFromInspector(IssueQueryInspector issueQueryInspector)
issueQueryInspector
- an issue query inspectorNullArgumentException
- issueQueryInspector
is null
UnsupportedException
- issueQueryInspector
is not of this servicemandatory
- This method must be implemented.