public interface ControllerLookupSession extends OsidSession
This session provides methods for retrieving Controllers.
The Controller
represents a set of actions .
This session defines views that offer differing behaviors when retrieving multiple objects.
Controllers
with the ControllerAdminSession.
Generally, the comparative view should be used for most applications
as it permits operation even if there is data that cannot be accessed. The
methods useFederatedSystemView()
and
useIsolatedSystemView()
behave as a radio group and one should be
selected before invoking the methods in this session.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupControllers()
Tests if this user can perform
Controller lookups. |
Controller |
getController(Id controllerId)
Gets the
Controller specified by its Id. |
ControllerList |
getControllers()
Gets all
Controllers. |
ControllerList |
getControllersByAddress(java.lang.String address)
Gets a
ControllerList with the given address. |
ControllerList |
getControllersByGenusType(Type controllerGenusType)
Gets a
ControllerList corresponding to the given
controller genus Type which does not include
controllers of genus types derived from the specified Type. |
ControllerList |
getControllersByIds(IdList controllerIds)
Gets a
ControllerList corresponding to the given
IdList. |
ControllerList |
getControllersByParentGenusType(Type controllerGenusType)
Gets a
ControllerList corresponding to the given
controller genus Type and include any additional
controllers with genus types derived from the specified Type. |
ControllerList |
getControllersByRecordType(Type controllerRecordType)
Gets a
ControllerList containing the given controller
record Type. |
System |
getSystem()
Gets the
System associated with this session. |
Id |
getSystemId()
Gets the
System Id associated with this
session. |
void |
useActiveControllerView()
Only active controllers are returned from methods in this session.
|
void |
useAnyStatusControllerView()
Borth active and inactive controllers are returned from methods in
this session.
|
void |
useComparativeControllerView()
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 |
useFederatedSystemView()
Federates the view for methods in this session.
|
void |
useIsolatedSystemView()
Isolates the view for methods in this session.
|
void |
usePlenaryControllerView()
A complete view of the
ControllerConstrainer returns is
desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getSystemId()
System
Id
associated with this
session. System Id
associated with this sessionmandatory
- This method must be implemented. System getSystem() throws OperationFailedException, PermissionDeniedException
System
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupControllers()
Controller
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 to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeControllerView()
mandatory
- This method is must be implemented. void usePlenaryControllerView()
ControllerConstrainer
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 useFederatedSystemView()
mandatory
- This method is must be implemented. void useIsolatedSystemView()
mandatory
- This method is must be implemented. void useActiveControllerView()
mandatory
- This method is must be implemented. void useAnyStatusControllerView()
mandatory
- This method is must be implemented. Controller getController(Id controllerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Controller
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Controller
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Controller
and retained for
compatibility.
In active mode, controllers are returned that are currently active. In
any status mode, active and inactive controllers are returned.controllerId
- Id
of the Controller
NotFoundException
- controllerId
not
foundNullArgumentException
- controllerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. ControllerList getControllersByIds(IdList controllerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ControllerList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
controllers 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 Controllers
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, controllers are returned that are currently active. In
any status mode, active and inactive controllers are returned.controllerIds
- the list of Ids
to retrieve Controller
listNotFoundException
- an Id
was not foundNullArgumentException
- controllerIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ControllerList getControllersByGenusType(Type controllerGenusType) throws OperationFailedException, PermissionDeniedException
ControllerList
corresponding to the given
controller genus Type
which does not include
controllers of genus types derived from the specified Type.
In plenary mode, the returned list contains all known
controllers or an error results. Otherwise, the returned list may
contain only those controllers that are accessible through this
session.
In active mode, controllers are returned that are currently active. In
any status mode, active and inactive controllers are returned.controllerGenusType
- a controller genus type Controller
listNullArgumentException
- controllerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ControllerList getControllersByParentGenusType(Type controllerGenusType) throws OperationFailedException, PermissionDeniedException
ControllerList
corresponding to the given
controller genus Type
and include any additional
controllers with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
controllers or an error results. Otherwise, the returned list may
contain only those controllers that are accessible through this
session.
In active mode, controllers are returned that are currently active. In
any status mode, active and inactive controllers are returned.controllerGenusType
- a controller genus type Controller
listNullArgumentException
- controllerGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ControllerList getControllersByRecordType(Type controllerRecordType) throws OperationFailedException, PermissionDeniedException
ControllerList
containing the given controller
record Type.
In plenary mode, the returned list contains all known
controllers or an error results. Otherwise, the returned list may
contain only those controllers that are accessible through this
session.
In active mode, controllers are returned that are currently active. In
any status mode, active and inactive controllers are returned.controllerRecordType
- a controller record type Controller
listNullArgumentException
- controllerRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ControllerList getControllersByAddress(java.lang.String address) throws OperationFailedException, PermissionDeniedException
ControllerList
with the given address.
In plenary mode, the returned list contains all known
controllers or an error results. Otherwise, the returned list may
contain only those controllers that are accessible through this
session.
In active mode, controllers are returned that are currently active. In
any status mode, active and inactive controllers are returned.address
- a controller address Controller
listNullArgumentException
- address
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ControllerList getControllers() throws OperationFailedException, PermissionDeniedException
Controllers.
In plenary mode, the returned list contains all known controllers or
an error results. Otherwise, the returned list may contain only those
controllers that are accessible through this session.
In active mode, controllers are returned that are currently active. In
any status mode, active and inactive controllers are returned. Controllers
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.