Interface CompositionEnablerLookupSession

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

This session provides methods for retrieving CompositionEnablers .

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

  • Method Details

    • getRepositoryId

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

    • getRepository

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

    • canLookupCompositionEnablers

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

    • useComparativeCompositionEnablerView

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

    • usePlenaryCompositionEnablerView

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

    • useFederatedRepositoryView

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

    • useIsolatedRepositoryView

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

    • useActiveCompositionEnablerView

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

    • useAnyStatusCompositionEnablerView

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

    • getCompositionEnabler

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

    • getCompositionEnablersByIds

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

    • getCompositionEnablersByGenusType

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

    • getCompositionEnablersByParentGenusType

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

    • getCompositionEnablersByRecordType

      CompositionEnablerList getCompositionEnablersByRecordType(Type compositionEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CompositionEnablerList containing the given composition enabler record Type . In plenary mode, the returned list contains all known composition enablers or an error results. Otherwise, the returned list may contain only those composition enablers that are accessible through this session. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
      Parameters:
      compositionEnablerRecordType - a composition enabler record type
      Returns:
      the returned CompositionEnabler list
      Throws:
      NullArgumentException - compositionEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCompositionEnablersOnDate

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

    • getCompositionEnablersOnDateWithAgent

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

    • getCompositionEnablers

      CompositionEnablerList getCompositionEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all CompositionEnablers . In plenary mode, the returned list contains all known composition enablers or an error results. Otherwise, the returned list may contain only those composition enablers that are accessible through this session. In active mode, composition enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive composition enablers are returned.
      Returns:
      the returned CompositionEnabler list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.