public interface ProcedureLookupSession extends OsidSession
This session defines methods for retrieving procedures.
This lookup session defines several views:
ProcedureAdminSession.
The methods useFederatedCookbookView()
and
useIsolatedCookbookView()
behave as a radio group and one should
be selected before invoking any lookup methods.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupProcedures()
Tests if this user can lookup procedures.
|
Cookbook |
getCookbook()
Gets the
Cookbook associated with this session. |
Id |
getCookbookId()
Gets the
Cookbook Id associated with
this session. |
Procedure |
getProcedure(Id procedureId)
Gets the
Procedure specified by its Id. |
ProcedureList |
getProcedures()
Gets all procedures.
|
ProcedureList |
getProceduresByGenusType(Type procedureGenusType)
Gets a
ProcedureList corresponding to the given
procedure genus Type which does not include procedures
of genus types derived from the specified Type. |
ProcedureList |
getProceduresByIds(IdList procedureIds)
Gets a
ProcedureList corresponding to the given
IdList. |
ProcedureList |
getProceduresByParentGenusType(Type procedureGenusType)
Gets a
ProcedureList corresponding to the given
procedure genus Type and include any additional
procedures with genus types derived from the specified Type. |
ProcedureList |
getProceduresByRecordType(Type procedureRecordType)
Gets a
ProcedureList containing the given procedure
record Type. |
void |
useComparativeProcedureView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedCookbookView()
Federates the view for methods in this session.
|
void |
useIsolatedCookbookView()
Isolates the view for methods in this session.
|
void |
usePlenaryProcedureView()
A complete view of the
Procedure returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCookbookId()
Cookbook
Id
associated with
this session. Cookbook Id
associated with this sessionmandatory
- This method must be implemented. Cookbook getCookbook() throws OperationFailedException, PermissionDeniedException
Cookbook
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupProcedures()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer these operations. false
if procedure lookup methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useComparativeProcedureView()
mandatory
- This method is must be implemented. void usePlenaryProcedureView()
Procedure
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedCookbookView()
mandatory
- This method is must be implemented. void useIsolatedCookbookView()
mandatory
- This method is must be implemented. Procedure getProcedure(Id procedureId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Procedure
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Procedure
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Procedure
and retained for compatibility.procedureId
- the Id
of the Procedure
to retrieve Procedure
NotFoundException
- no Procedure
found
with the given Id
NullArgumentException
- procedureId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcedureList getProceduresByIds(IdList procedureIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProcedureList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
procedures specified in the Id
list, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible procedures may be omitted from the list and may present
the elements in any order including returning a unique set.procedureIds
- the list of Ids
to retrieve Procedure list
NotFoundException
- an Id was
not foundNullArgumentException
- procedureIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcedureList getProceduresByGenusType(Type procedureGenusType) throws OperationFailedException, PermissionDeniedException
ProcedureList
corresponding to the given
procedure genus Type
which does not include procedures
of genus types derived from the specified Type.
In
plenary mode, the returned list contains all known procedures or an
error results. Otherwise, the returned list may contain only those
procedures that are accessible through this session.procedureGenusType
- a procedure genus type Procedure
listNullArgumentException
- procedureGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcedureList getProceduresByParentGenusType(Type procedureGenusType) throws OperationFailedException, PermissionDeniedException
ProcedureList
corresponding to the given
procedure genus Type
and include any additional
procedures with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
procedures or an error results. Otherwise, the returned list may
contain only those procedures that are accessible through this
session.procedureGenusType
- a procedure genus type Procedure
listNullArgumentException
- procedureGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcedureList getProceduresByRecordType(Type procedureRecordType) throws OperationFailedException, PermissionDeniedException
ProcedureList
containing the given procedure
record Type.
In plenary mode, the returned list
contains all known procedures or an error results. Otherwise, the
returned list may contain only those procedures that are accessible
through this session.procedureRecordType
- a procedure record type Procedure
listNullArgumentException
- procedureRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProcedureList getProcedures() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.