public interface FunctionLookupSession extends OsidSession
This session provides methods for retrieving Function
objects.
This session defines two sets of views which offer differing behaviors when retrieving multiple objects.
FunctionAdminSession.
Generally, the comparative view should be used for most applications as it permits operation even if there a particular element is inaccessible. For example, a hierarchy output can be plugged into a lookup method to retrieve all objects known to a hierarchy, but it may not be necessary to break execution if a node from the hierarchy no longer exists. However, some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision.
Functions may have an additional records indicated by their respective record types.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupFunctions()
Tests if this user can perform
Function lookups. |
Function |
getFunction(Id functionId)
Gets the
Function specified by its Id. |
FunctionList |
getFunctions()
Gets all
Functions. |
FunctionList |
getFunctionsByGenusType(Type functionGenusType)
Gets a
FunctionList corresponding to the given function
genus Type which does not include functions of genus
types derived from the specified Type. |
FunctionList |
getFunctionsByIds(IdList functionIds)
Gets a
FunctionList corresponding to the given
IdList. |
FunctionList |
getFunctionsByParentGenusType(Type functionGenusType)
Gets a
FunctionList corresponding to the given function
genus Type and include any additional functions with
genus types derived from the specified Type. |
FunctionList |
getFunctionsByRecordType(Type functionRecordType)
Gets a
FunctionList containing the given function
record Type. |
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
useActiveFunctionView()
Only active functions are returned by methods in this session.
|
void |
useAnyStatusFunctionView()
Active and inactive functions are returned by methods in this session.
|
void |
useComparativeFunctionView()
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 |
useFederatedVaultView()
Federates the view for methods in this session.
|
void |
useIsolatedVaultView()
Isolates the view for methods in this session.
|
void |
usePlenaryFunctionView()
A complete view of the
Function returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session. Vault
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupFunctions()
Function
lookups. 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 lookup operations. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeFunctionView()
mandatory
- This method is must be implemented. void usePlenaryFunctionView()
Function
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 useFederatedVaultView()
mandatory
- This method is must be implemented. void useIsolatedVaultView()
mandatory
- This method is must be implemented. void useActiveFunctionView()
mandatory
- This method is must be implemented. void useAnyStatusFunctionView()
mandatory
- This method is must be implemented. Function getFunction(Id functionId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Function
specified by its Id.
In plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Function
may have a different Id
than requested, such as
the case where a duplicate Id
was assigned to a
Function
and retained for compatibility.functionId
- the Id
of the Function
to retrieve Function
NotFoundException
- no Function
found
with the given Id
NullArgumentException
- functionId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FunctionList getFunctionsByIds(IdList functionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
FunctionList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
functions 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 Functions
may be omitted from the list and
may present the elements in any order including returning a unique
set.functionIds
- the list of Ids
to retrieve Function
listNotFoundException
- an Id was
not foundNullArgumentException
- functionIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FunctionList getFunctionsByGenusType(Type functionGenusType) throws OperationFailedException, PermissionDeniedException
FunctionList
corresponding to the given function
genus Type
which does not include functions of genus
types derived from the specified Type.
In plenary mode,
the returned list contains all known functions or an error results.
Otherwise, the returned list may contain only those functions that are
accessible through this session.functionGenusType
- a function genus type Function
listNullArgumentException
- functionGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FunctionList getFunctionsByParentGenusType(Type functionGenusType) throws OperationFailedException, PermissionDeniedException
FunctionList
corresponding to the given function
genus Type
and include any additional functions with
genus types derived from the specified Type.
In plenary
mode, the returned list contains all known functions or an error
results. Otherwise, the returned list may contain only those functions
that are accessible through this session.functionGenusType
- a function genus type Function
listNullArgumentException
- functionGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FunctionList getFunctionsByRecordType(Type functionRecordType) throws OperationFailedException, PermissionDeniedException
FunctionList
containing the given function
record Type.
In plenary mode, the returned list
contains all known functions or an error results. Otherwise, the
returned list may contain only those functions that are accessible
through this session.functionRecordType
- a function record type Function
listNullArgumentException
- functionRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. FunctionList getFunctions() throws OperationFailedException, PermissionDeniedException
Functions.
In plenary mode, the returned list
contains all known functions or an error results. Otherwise, the
returned list may contain only those functions that are accessible
through this session. Functions
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.