Interface ControllerLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
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.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated system view: All controller methods in this session operate, retrieve and pertain to controllers defined explicitly in the current system. Using an isolated view is useful for managing Controllers with the ControllerAdminSession .
  • federated system view: All controller methods in this session operate, retrieve and pertain to all controllers defined in this system and any other controllers implicitly available in this system through system inheritence.
  • active controller view: active controllers are returned from methods in this session
  • any status controller view: active and inactive controllers are returned from methods in this session

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.

  • Method Details

    • getSystemId

      Id getSystemId()
      Gets the System Id associated with this session.
      Returns:
      the System Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getSystem

      System getSystem() throws OperationFailedException, PermissionDeniedException
      Gets the System associated with this session.
      Returns:
      the system
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupControllers

      boolean canLookupControllers()
      Tests if this user can perform 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.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeControllerView

      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. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryControllerView

      void usePlenaryControllerView()
      A complete view of the 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.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include controller constrainers in systems which are children of this system in the system hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedSystemView

      void useIsolatedSystemView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this system only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveControllerView

      void useActiveControllerView()
      Only active controllers are returned from methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusControllerView

      void useAnyStatusControllerView()
      Borth active and inactive controllers are returned from methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getController

      Controller getController(Id controllerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the 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.
      Parameters:
      controllerId - Id of the Controller
      Returns:
      the controller
      Throws:
      NotFoundException - controllerId not found
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getControllersByIds

      ControllerList getControllersByIds(IdList controllerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      controllerIds - the list of Ids to retrieve
      Returns:
      the returned Controller list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - controllerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getControllersByGenusType

      ControllerList getControllersByGenusType(Type controllerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      controllerGenusType - a controller genus type
      Returns:
      the returned Controller list
      Throws:
      NullArgumentException - controllerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getControllersByParentGenusType

      ControllerList getControllersByParentGenusType(Type controllerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      controllerGenusType - a controller genus type
      Returns:
      the returned Controller list
      Throws:
      NullArgumentException - controllerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getControllersByRecordType

      ControllerList getControllersByRecordType(Type controllerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      controllerRecordType - a controller record type
      Returns:
      the returned Controller list
      Throws:
      NullArgumentException - controllerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getControllersByAddress

      ControllerList getControllersByAddress(String address) throws OperationFailedException, PermissionDeniedException
      Gets a 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.
      Parameters:
      address - a controller address
      Returns:
      the returned Controller list
      Throws:
      NullArgumentException - address is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getControllers

      ControllerList getControllers() throws OperationFailedException, PermissionDeniedException
      Gets all 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.
      Returns:
      a list of Controllers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.