Interface IssueProcessorEnablerLookupSession

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

This session provides methods for retrieving IssueProcessorEnablers .

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 oubliette view: All issue processor enabler methods in this session operate, retrieve and pertain to issue processor enablers defined explicitly in the current oubliette Using an isolated view is useful for managing IssueProcessorEnablers with the IssueProcessorEnablerAdminSession .
  • federated oubliette view: All issue processor enabler methods in this session operate, retrieve and pertain to all issue processor enablers defined in this oubliette and any other issue processor enablers implicitly available in this oubliette through oubliette inheritence.

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 useFederatedOublietteView() and useIsolatedOublietteView() beha ve as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getOublietteId

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

    • getOubliette

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

    • canLookupIssueProcessorEnablers

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

    • useComparativeIssueProcessorEnablerView

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

    • usePlenaryIssueProcessorEnablerView

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

    • useFederatedOublietteView

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

    • useIsolatedOublietteView

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

    • getIssueProcessorEnabler

      IssueProcessorEnabler getIssueProcessorEnabler(Id issueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the IssueProcessorEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned IssueProcessorEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to an IssueProcessorEnabler and reta ined for compatibility.
      Parameters:
      issueProcessorEnablerId - Id of the IssueProcessorEnabler
      Returns:
      the issue processor enabler
      Throws:
      NotFoundException - issueProcessorEnablerId not found
      NullArgumentException - issueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getIssueProcessorEnablersByIds

      IssueProcessorEnablerList getIssueProcessorEnablersByIds(IdList issueProcessorEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets an IssueProcessorEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the issue 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 IssueProcessorEnablers may be om itted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      issueProcessorEnablerIds - the list of Ids to retrieve
      Returns:
      the returned IssueProcessorEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - issueProcessorEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablersByGenusType

      IssueProcessorEnablerList getIssueProcessorEnablersByGenusType(Type issueProcessorEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an IssueProcessorEnablerList corresponding to the given issue processor enabler genus Type which does not include issue processor enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known issue processor enablers or an error results. Otherwise, the returned list may contain only those issue processor enablers that are accessible through this session.
      Parameters:
      issueProcessorEnablerGenusType - an issue processor enabler genus type
      Returns:
      the returned IssueProcessorEnabler list
      Throws:
      NullArgumentException - issueProcessorEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablersByParentGenusType

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

    • getIssueProcessorEnablersByRecordType

      IssueProcessorEnablerList getIssueProcessorEnablersByRecordType(Type issueProcessorEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an IssueProcessorEnablerList containing the given issue processor enabler record Type . In plenary mode, the returned list contains all known issue processor enablers or an error results. Otherwise, the returned list may contain only those issue processor enablers that are accessible through this session.
      Parameters:
      issueProcessorEnablerRecordType - an issue processor enabler record type
      Returns:
      the returned IssueProcessorEnabler list
      Throws:
      NullArgumentException - issueProcessorEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getIssueProcessorEnablers

      IssueProcessorEnablerList getIssueProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all IssueProcessorEnablers . In plenary mode, the returned list contains all known issue processor enablers or an error results. Otherwise, the returned list may contain only those issue processor enablers that are accessible through this session.
      Returns:
      a list of IssueProcessorEnablers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.