Interface PostLookupSession

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

This session defines methods for retrieving posts. A Post is a scheduled payer listed in a business. A Post is derived from a Payer and maps to an offering time and registered students.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated business view: All post methods in this session operate, retrieve and pertain to posts defined explicitly in the current business. Using an isolated view is useful for managing Posts with the PostAdminSession .
  • federated business view: All post lookup methods in this session operate, retrieve and pertain to all posts defined in this business and any other payers implicitly available in this business through business inheritence.

The methods useFederatedBusinessView() and useIsolatedBusinessView() behave as a radio group and one should be selected before invoking any lookup methods.

Payers may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Payer .

  • Method Details

    • getBusinessId

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

    • getBusiness

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

    • canLookupPosts

      boolean canLookupPosts()
      Tests if this user can perform Post 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 not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativePostView

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

    • usePlenaryPostView

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

    • useFederatedBusinessView

      void useFederatedBusinessView()
      Federates the view for methods in this session. A federated view will include posts in catalogs which are children of this catalog in the business hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBusinessView

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

    • getPost

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

    • getPostsByIds

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

    • getPostsByGenusType

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

    • getPostsByParentGenusType

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

    • getPostsByRecordType

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

    • getPostsByFiscalPeriod

      PostList getPostsByFiscalPeriod(Id fiscalPeriodId) throws OperationFailedException, PermissionDeniedException
      Gets a PostList for the given fiscal period. In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those posts that are accessible through this session.
      Parameters:
      fiscalPeriodId - a post record type
      Returns:
      the returned Post list
      Throws:
      NullArgumentException - fiscalPeriodId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getPostsByDate

      PostList getPostsByDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets a PostList posted between the given date range inclusive. In plenary mode, the returned list contains all known payers or an error results. Otherwise, the returned list may contain only those posts that are accessible through this session.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned Post 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.

    • getPosts

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