Interface ActivityLookupSession

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

This session provides methods for retrieving Activities . The Activity is a cost object.

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 business view: All activity methods in this session operate, retrieve and pertain to activities defined explicitly in the current business. Using an isolated view is useful for managing Activities with the ActivityAdminSession .
  • federated business view: All activity methods in this session operate, retrieve and pertain to all activities defined in this business and any other activities implicitly available in this business through business inheritence.
  • effective activity view: All activity lookup methods return activities where the current date falls in between the effective dates inclusive.
  • any effective activity view: Activities of any effective date 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 useFederatedBusinessView() and useIsolatedBusinessView() behave as a radio group and one should be selected before invoking any lookup methods.

  • 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.

    • canLookupActivities

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

    • useComparativeActivityView

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

    • usePlenaryActivityView

      void usePlenaryActivityView()
      A complete view of the Activity 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 activities in businesses which are children of this business 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 lookups to this business only.
      Compliance:
      mandatory - This method is must be implemented.

    • useEffectiveActivityView

      void useEffectiveActivityView()
      Only activities whose effective dates are current are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyEffectiveActivityView

      void useAnyEffectiveActivityView()
      All activities of any effective dates are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getActivity

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

    • getActivitiesByIds

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

    • getActivitiesByGenusType

      ActivityList getActivitiesByGenusType(Type activityGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an ActivityList corresponding to the given activity genus Type which does not include activities of genus types derived from the specified Type . In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned.
      Parameters:
      activityGenusType - an activity genus type
      Returns:
      the returned Activity list
      Throws:
      NullArgumentException - activityGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivitiesByParentGenusType

      ActivityList getActivitiesByParentGenusType(Type activityGenusType) throws OperationFailedException, PermissionDeniedException
      Gets an ActivityList corresponding to the given activity genus Type and include any additional activities with genus types derived from the specified Type . In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned.
      Parameters:
      activityGenusType - an activity genus type
      Returns:
      the returned Activity list
      Throws:
      NullArgumentException - activityGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivitiesByRecordType

      ActivityList getActivitiesByRecordType(Type activityRecordType) throws OperationFailedException, PermissionDeniedException
      Gets an ActivityList containing the given activity record Type . In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned.
      Parameters:
      activityRecordType - an activity record type
      Returns:
      the returned Activity list
      Throws:
      NullArgumentException - activityRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivitiesOnDate

      ActivityList getActivitiesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an ActivityList effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned.
      Parameters:
      from - start of date range
      to - end of date range
      Returns:
      the returned Activity list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - activityRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivitiesByOrganization

      ActivityList getActivitiesByOrganization(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets an ActivityList for the given organization. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Activity list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivitiesByOrganizationOnDate

      ActivityList getActivitiesByOrganizationOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
      Gets an ActivityList for the given organization effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned.
      Parameters:
      resourceId - a resource Id
      from - start of date range
      to - end of date range
      Returns:
      the returned Activity list
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - resourceId or activityRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivitiesByCode

      ActivityList getActivitiesByCode(String code) throws OperationFailedException, PermissionDeniedException
      Gets an ActivityList containing the given activity code. In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned.
      Parameters:
      code - an activity code
      Returns:
      the returned Activity list
      Throws:
      NullArgumentException - code is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActivities

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