Interface IssueConstrainerLookupSession

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

This session provides methods for retrieving IssueConstrai ners.

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

    • canLookupIssueConstrainers

      boolean canLookupIssueConstrainers()
      Tests if this user can perform IssueConstrai ner 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.

    • useComparativeIssueConstrainerView

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

    • usePlenaryIssueConstrainerView

      void usePlenaryIssueConstrainerView()
      A complete view of the IssueConstrainer 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 constrainers 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.

    • getIssueConstrainer

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

    • getIssueConstrainersByIds

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

    • getIssueConstrainersByGenusType

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

    • getIssueConstrainersByParentGenusType

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

    • getIssueConstrainersByRecordType

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

    • getIssueConstrainers

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