Interface TriggerLookupSession

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

This session provides methods for retrieving Triggers .

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 system view: All trigger methods in this session operate, retrieve and pertain to triggers defined explicitly in the current system. Using an isolated view is useful for managing Triggers with the TriggerAdminSession .
  • federated system view: All trigger methods in this session operate, retrieve and pertain to all triggers defined in this system and any other triggers implicitly available in this system through system inheritence.
  • active trigger view: active triggers are returned from methods in this session
  • any status trigger view: active and inactive triggers are returned from methods in this session

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 useFederatedSystemView() and useIsolatedSystemView() behave as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canLookupTriggers

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

    • useComparativeTriggerView

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

    • usePlenaryTriggerView

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

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include triggers in systems which are children of this system in the system hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedSystemView

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

    • useActiveTriggerView

      void useActiveTriggerView()
      Only active triggers are returned from methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusTriggerView

      void useAnyStatusTriggerView()
      Borth active and inactive triggers are returned from methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getTrigger

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

    • getTriggersByIds

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

    • getTriggersByGenusType

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

    • getTriggersByParentGenusType

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

    • getTriggersByRecordType

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

    • getTriggersForController

      TriggerList getTriggersForController(Id controllerId) throws OperationFailedException, PermissionDeniedException
      Gets a list of triggers for the given controller. In plenary mode, the returned list contains all known triggers or an error results. Otherwise, the returned list may contain only those triggers that are accessible through this session. In active mode, triggers are returned that are currently active. In any status mode, active and inactive triggers are returned.
      Parameters:
      controllerId - a controller Id
      Returns:
      the returned Trigger list
      Throws:
      NullArgumentException - controllerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getTriggers

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