Interface IssueConstrainerEnablerLookupSession

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

This session provides methods for retrieving IssueConstrainerEnablers .

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 cosntrainer enabler methods in this session operate, retrieve and pertain to issue constrainer enablers defined explicitly in the current oubliette Using an isolated view is useful for managing IssueConstrainerEnablers with the IssueConstrainerEnablerAdminSession .
  • federated oubliette view: All issue constrainer enabler methods in this session operate, retrieve and pertain to all issue constrainer enablers defined in this oubliette and any other issue constrainer 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.

    • canLookupIssueConstrainerEnablers

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

    • useComparativeIssueConstrainerEnablerView

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

    • usePlenaryIssueConstrainerEnablerView

      void usePlenaryIssueConstrainerEnablerView()
      A complete view of the IssueConstrainerEnabler 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 constrainer 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.

    • getIssueConstrainerEnabler

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

    • getIssueConstrainerEnablersByIds

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

    • getIssueConstrainerEnablersByGenusType

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

    • getIssueConstrainerEnablersByParentGenusType

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

    • getIssueConstrainerEnablersByRecordType

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

    • getIssueConstrainerEnablers

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