Interface CanonicalUnitProcessorEnablerLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface CanonicalUnitProcessorEnablerLookupSession extends OsidSession

This session provides methods for retrieving CanonicalUnitProcessorEnablers .

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 catalogue view: All canonical unit processor enabler methods in this session operate, retrieve and pertain to canonical unit processor enablers defined explicitly in the current catalogue. Using an isolated view is useful for managing CanonicalUnitProcessorEnablers with the CanonicalUnitProcessorEnablerAdminSession .
  • federated catalogue view: All canonical unit processor enabler methods in this session operate, retrieve and pertain to all canonical unit processor enablers defined in this catalogue and any other canonical unit processor enablers implicitly available in this catalogue through catalogue inheritence.
  • active canonical unit processor enabler view: All canonical unit processor enabler lookup methods return active canonical unit processor enablers.
  • any status canonical unit processor enabler view: CanonicalUnit processor enablers of any active or inactive status are returned from methods.

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 useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

  • Method Details

    • getCatalogueId

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

    • getCatalogue

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

    • canLookupCanonicalUnitProcessorEnablers

      boolean canLookupCanonicalUnitProcessorEnablers()
      Tests if this user can perform CanonicalUnitProcessorEnablers 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.

    • useComparativeCanonicalUnitProcessorEnablerView

      void useComparativeCanonicalUnitProcessorEnablerView()
      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.

    • usePlenaryCanonicalUnitProcessorEnablerView

      void usePlenaryCanonicalUnitProcessorEnablerView()
      A complete view of the CanonicalUnitProcessorEnabler 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.

    • useFederatedCatalogueView

      void useFederatedCatalogueView()
      Federates the view for methods in this session. A federated view will include canonical unit processor enablers in catalogues which are children of this catalogue in the catalogue hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCatalogueView

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

    • useActiveCanonicalUnitProcessorEnablerView

      void useActiveCanonicalUnitProcessorEnablerView()
      Only active canonical unit processor enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusCanonicalUnitProcessorEnablerView

      void useAnyStatusCanonicalUnitProcessorEnablerView()
      All active and inactive canonical unit processor enablers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getCanonicalUnitProcessorEnabler

      CanonicalUnitProcessorEnabler getCanonicalUnitProcessorEnabler(Id canonicalUnitProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the CanonicalUnitProcessorEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned CanonicalUnitProcessorEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a CanonicalUnitProcessorEnabler and retained for compatibility. In active mode, canonical unit processor enablers are returned that are currently active. In any status mode, active and inactive canonical unit processor enablers are returned.
      Parameters:
      canonicalUnitProcessorEnablerId - Id of the CanonicalUnitProcessorEnabler
      Returns:
      the canonical unit processor enabler
      Throws:
      NotFoundException - canonicalUnitProcessorEnablerId not found
      NullArgumentException - canonicalUnitProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getCanonicalUnitProcessorEnablersByIds

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByIds(IdList canonicalUnitProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CanonicalUnitProcessorEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the canonical unit processor enablers 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 CanonicalUnitProcessorEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, canonical unit processor enablers are returned that are currently active. In any status mode, active and inactive canonical unit processor enablers are returned.
      Parameters:
      canonicalUnitProcessorEnablerIds - the list of Ids to retrieve
      Returns:
      the returned CanonicalUnitProcessorEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - canonicalUnitProcessorEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablersByGenusType

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByGenusType(Type canonicalUnitProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CanonicalUnitProcessorEnablerList corresponding to the given canonical unit processor enabler genus Type which does not include canonical unit processor enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known canonical unit processor enablers or an error results. Otherwise, the returned list may contain only those canonical unit processor enablers that are accessible through this session. In active mode, canonical unit processor enablers are returned that are currently active. In any status mode, active and inactive canonical unit processor enablers are returned.
      Parameters:
      canonicalUnitProcessorEnablerGenusType - a canonical unit processor enabler genus type
      Returns:
      the returned CanonicalUnitProcessorEnabler list
      Throws:
      NullArgumentException - canonicalUnitProcessorEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablersByParentGenusType

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByParentGenusType(Type canonicalUnitProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CanonicalUnitProcessorEnablerList corresponding to the given canonical unit processor enabler genus Type and include any additional canonical unit processor enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known canonical unit processor enablers or an error results. Otherwise, the returned list may contain only those canonical unit processor enablers that are accessible through this session. In active mode, canonical unit processor enablers are returned that are currently active. In any status mode, active and inactive canonical unit processor enablers are returned.
      Parameters:
      canonicalUnitProcessorEnablerGenusType - a canonical unit processor enabler genus type
      Returns:
      the returned CanonicalUnitProcessorEnabler list
      Throws:
      NullArgumentException - canonicalUnitProcessorEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablersByRecordType

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersByRecordType(Type canonicalUnitProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CanonicalUnitProcessorEnablerList containing the given canonical unit processor enabler record Type . In plenary mode, the returned list contains all known canonical unit processor enablers or an error results. Otherwise, the returned list may contain only those canonical unit processor enablers that are accessible through this session. In active mode, canonical unit processor enablers are returned that are currently active. In any status mode, active and inactive canonical unit processor enablers are returned.
      Parameters:
      canonicalUnitProcessorEnablerRecordType - a canonical unit processor enabler record type
      Returns:
      the returned CanonicalUnitProcessorEnabler list
      Throws:
      NullArgumentException - canonicalUnitProcessorEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablersOnDate

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CanonicalUnitProcessorEnablerList effective within the given date range. In plenary mode, the returned list contains all known canonical unit processor enablers or an error results. Otherwise, the returned list may contain only those canonical unit processor enablers that are accessible through this session. In active mode, canonical unit processor enablers are returned that are currently active. In any status mode, active and inactive canonical unit processor enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned CanonicalUnitProcessorEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablersOnDateWithAgent

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CanonicalUnitProcessorEnablerList effective during the entire given date range but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known canonical unit processor enablers or an error results. Otherwise, the returned list may contain only those canonical unit processor enablers that are accessible through this session. In active mode, canonical unit processor enablers are returned that are currently active. In any status mode, active and inactive canonical unit processor enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned CanonicalUnitProcessorEnabler list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - agentId, from , or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorEnablers

      CanonicalUnitProcessorEnablerList getCanonicalUnitProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all CanonicalUnitProcessorEnablers . In plenary mode, the returned list contains all known canonical unit processor enablers or an error results. Otherwise, the returned list may contain only those canonical unit processor enablers that are accessible through this session. In active mode, canonical unit processor enablers are returned that are currently active. In any status mode, active and inactive canonical unit processor enablers are returned.
      Returns:
      the returned CanonicalUnitProcessorEnabler list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.