Interface SequenceRuleLookupSession

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

This session provides methods for retrieving SequenceRules .

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 bank view: All sequence rule methods in this session operate, retrieve and pertain to sequence rule defined explicitly in the current bank. Using an isolated view is useful for managing SequenceRules with the SequenceRuleAdminSession .
  • federated bank view: All sequence rule methods in this session operate, retrieve and pertain to all sequence rule defined in this bank and any other sequence rule implicitly available in this bank through bank inheritence.
  • active sequence rule view: All sequence rule lookup methods return active sequence rules.
  • any status sequence rule view: sequence rules 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 useFederatedBankView() and useIsolatedBankView() behave as a radio group and one should be selected before invoking the methods in this session.

  • Method Details

    • getBankId

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

    • getBank

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

    • canLookupSequenceRules

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

    • useComparativeSequenceRuleView

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

    • usePlenarySequenceRuleView

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

    • useFederatedBankView

      void useFederatedBankView()
      Federates the view for methods in this session. A federated view will include sequence rule in banks which are children of this bank in the bank hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBankView

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

    • useActiveSequenceRuleView

      void useActiveSequenceRuleView()
      Only active sequence rules are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusSequenceRuleView

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

    • getSequenceRule

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

    • getSequenceRulesByIds

      SequenceRuleList getSequenceRulesByIds(IdList sequenceRuleIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a SequenceRuleList corresponding to the given IdList . In plenary mode, the returned list contains all of the sequence rule specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible SequenceRules may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.
      Parameters:
      sequenceRuleIds - the list of Ids to retrieve
      Returns:
      the returned SequenceRule list
      Throws:
      NotFoundException - a Id was not found
      NullArgumentException - sequenceRuleIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRulesByGenusType

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

    • getSequenceRulesByParentGenusType

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

    • getSequenceRulesByRecordType

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

    • getSequenceRulesForAssessmentPart

      SequenceRuleList getSequenceRulesForAssessmentPart(Id assessmentPartId) throws OperationFailedException, PermissionDeniedException
      Gets a SequenceRuleList for the given source assessment part. In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session. In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.
      Parameters:
      assessmentPartId - an assessment part Id
      Returns:
      the returned SequenceRule list
      Throws:
      NullArgumentException - assessmentPartId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRulesForNextAssessmentPart

      SequenceRuleList getSequenceRulesForNextAssessmentPart(Id nextAssessmentPartId) throws OperationFailedException, PermissionDeniedException
      Gets a SequenceRuleList for the given target assessment part. In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session. In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.
      Parameters:
      nextAssessmentPartId - an assessment part Id
      Returns:
      the returned SequenceRule list
      Throws:
      NullArgumentException - nextAssessmentPartId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRulesForAssessmentParts

      SequenceRuleList getSequenceRulesForAssessmentParts(Id assessmentPartId, Id nextAssessmentPartId) throws OperationFailedException, PermissionDeniedException
      Gets a SequenceRuleList for the given source and target assessment parts. In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session. In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.
      Parameters:
      assessmentPartId - source assessment part Id
      nextAssessmentPartId - target assessment part Id
      Returns:
      the returned SequenceRule list
      Throws:
      NullArgumentException - assessmentPartId or nextAssessmentPartId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRulesForAssessment

      SequenceRuleList getSequenceRulesForAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
      Gets a SequenceRuleList for an entire assessment. In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session. In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.
      Parameters:
      assessmentId - an assessment Id
      Returns:
      the returned SequenceRule list
      Throws:
      NullArgumentException - assessmentId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRules

      SequenceRuleList getSequenceRules() throws OperationFailedException, PermissionDeniedException
      Gets all SequenceRules . In plenary mode, the returned list contains all known sequence rule or an error results. Otherwise, the returned list may contain only those sequence rule that are accessible through this session. In active mode, sequence rules are returned that are currently active. In any status mode, active and inactive sequence rules are returned.
      Returns:
      the returned SequenceRule list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.