Interface LogEntryLookupSession

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

This session provides methods for retrieving premade LogEntries . The LogEntry represents a set of efforts.

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 front office view: All log entry methods in this session operate, retrieve and pertain to log entries defined explicitly in the current front office. Using an isolated view is useful for managing LogEntries with the LogEntryAdminSession .
  • federated front office view: All log entry methods in this session operate, retrieve and pertain to all log entries defined in this front office and any other log entries implicitly available in this front office through front office 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 useFederatedFrontOfficeView() and useIsolatedFrontOfficeView() behave as a radio group and one should be selected before invoking the methods in this session.

  • Method Details

    • getFrontOfficeId

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

    • getFrontOffice

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

    • canLookupLogEntries

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

    • useComparativeLogEntryView

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

    • usePlenaryLogEntryView

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

    • useFederatedFrontOfficeView

      void useFederatedFrontOfficeView()
      Federates the view for methods in this session. A federated view will include log entries in front offices which are children of this front office in the front office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFrontOfficeView

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

    • getLogEntry

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

    • getLogEntriesByIds

      LogEntryList getLogEntriesByIds(IdList logEntryIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a LogEntryList corresponding to the given IdList . In plenary mode, the returned list contains all of the log entries 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 LogEntries may be omitted from the list.
      Parameters:
      logEntryIds - the list of Ids to retrieve
      Returns:
      the returned LogEntry list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - logEntryIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntriesByGenusType

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

    • getLogEntriesByParentGenusType

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

    • getLogEntriesByRecordType

      LogEntryList getLogEntriesByRecordType(Type logEntryRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a LogEntryList containing the given log entry record Type . In plenary mode, the returned list contains all known log entries or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.
      Parameters:
      logEntryRecordType - a log entry record type
      Returns:
      the returned LogEntry list
      Throws:
      NullArgumentException - logEntryRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntriesByDate

      LogEntryList getLogEntriesByDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of log entries logged in the date range. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned LogEntry list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntriesForQueue

      LogEntryList getLogEntriesForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
      Gets a LogEntryList in the given Queue . In plenary mode, the returned list contains all of the log entries, or an error results if a log entry connected to the issue is not found or inaccessible. Otherwise, inaccessible LogEntries may be omitted from the list.
      Parameters:
      queueId - a queue Id
      Returns:
      the returned LogEntry list
      Throws:
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntriesByDateForQueue

      LogEntryList getLogEntriesByDateForQueue(Id queueId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of log entries logged in the date range in the given queue. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.
      Parameters:
      queueId - a queue Id
      from - start of date range
      to - end of date range
      Returns:
      the returned LogEntry list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - queueId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntriesForIssue

      LogEntryList getLogEntriesForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
      Gets a LogEntryList connected to the given Issue . In plenary mode, the returned list contains all of the log entries, or an error results if a log entry connected to the issue is not found or inaccessible. Otherwise, inaccessible LogEntries may be omitted from the list.
      Parameters:
      issueId - an issue Id
      Returns:
      the returned LogEntry list
      Throws:
      NullArgumentException - issueId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntriesByDateForIssue

      LogEntryList getLogEntriesByDateForIssue(Id issueId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a list of log entries logged in the date range in the given issue. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those log entries that are accessible through this session.
      Parameters:
      issueId - an issue Id
      from - start of date range
      to - end of date range
      Returns:
      the returned LogEntry list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - issueId, from or to is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getLogEntries

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