Interface CatalogEnablerLookupSession

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

This session provides methods for retrieving CatalogEnablers . A CatalogEnabler enables a catalog node in a federated hierarchy.

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 catalog view: All catalog enabler methods in this session operate, retrieve and pertain to catalog enablers defined explicitly in the current catalog. Using an isolated view is useful for managing CatalogEnablers with the CatalogEnablerAdminSession .
  • federated catalog view: All catalog enabler methods in this session operate, retrieve and pertain to all catalog enablers defined in this catalog and any other catalog enablers implicitly available in this catalog through catalog inheritence.
  • active catalog enabler view: All catalog enabler lookup methods return active catalog enablers.
  • any status catalog enabler view: Catalog 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

    • getCatalogId

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

    • getCatalog

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

    • canLookupCatalogEnablers

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

    • useComparativeCatalogEnablerView

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

    • usePlenaryCatalogEnablerView

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

    • useFederatedCatalogView

      void useFederatedCatalogView()
      Federates the view for methods in this session. A federated view will include catalog enablers in catalogs which are children of this catalog in the catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCatalogView

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

    • useActiveCatalogEnablerView

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

    • useAnyStatusCatalogEnablerView

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

    • getCatalogEnabler

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

    • getCatalogEnablersByIds

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

    • getCatalogEnablersByGenusType

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

    • getCatalogEnablersByParentGenusType

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

    • getCatalogEnablersByRecordType

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

    • getCatalogEnablersOnDate

      CatalogEnablerList getCatalogEnablersOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CatalogEnablerList effective for the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
      Parameters:
      from - a start date
      to - an end date
      Returns:
      the returned CatalogEnabler 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.

    • getCatalogEnablersOnDateWithAgent

      CatalogEnablerList getCatalogEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a CatalogEnablerList effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
      Parameters:
      agentId - an agent Id
      from - a start date
      to - an end date
      Returns:
      the returned CatalogEnabler 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.

    • getCatalogEnablers

      CatalogEnablerList getCatalogEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all CatalogEnablers . In plenary mode, the returned list contains all known catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In both cases, the order of the set is not specified. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
      Returns:
      the returned CatalogEnabler list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.