Interface CyclicTimePeriodLookupSession

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

This session provides methods for retrieving CyclicTimePeriods .

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 calendar view: All cyclic time period methods in this session operate, retrieve and pertain to cyclic time periods defined explicitly in the current calendar. Using an isolated view is useful for managing cyclic time periods with the CyclicTimePeriodAdminSession .
  • federated calendar view: All cyclic time period methods in this session operate, retrieve and pertain to all cyclic time periods defined in this calendar and any other calendars implicitly available in this calendar through calendar inheritence.

Cyclic time periods may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the CyclicTimePeriod .

  • Method Details

    • getCalendarId

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

    • getCalendar

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

    • canLookupCyclicTimePeriods

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

    • useComparativeCyclicTimePeriodView

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

    • usePlenaryCyclicTimePeriodView

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

    • useFederatedCalendarView

      void useFederatedCalendarView()
      Federates the view for methods in this session. A federated view will include cyclic time periods in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCalendarView

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

    • getCyclicTimePeriod

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

    • getCyclicTimePeriodsByIds

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

    • getCyclicTimePeriodsByGenusType

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

    • getCyclicTimePeriodsByParentGenusType

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

    • getCyclicTimePeriodsByRecordType

      CyclicTimePeriodList getCyclicTimePeriodsByRecordType(Type cyclicTimePeriodRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CyclicTimePeriodList containing the given cyclic time period record Type . In plenary mode, the returned list contains all known cyclic time periods or an error results. Otherwise, the returned list may contain only those cyclic time periods that are accessible through this session.
      Parameters:
      cyclicTimePeriodRecordType - a cyclic time period record type
      Returns:
      the returned CyclicTimePeriod list
      Throws:
      NullArgumentException - cyclicTimePeriodRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getCyclicTimePeriods

      CyclicTimePeriodList getCyclicTimePeriods() throws OperationFailedException, PermissionDeniedException
      Gets all CyclicTimePeriods . In plenary mode, the returned list contains all known cyclic time periods or an error results. Otherwise, the returned list may contain only those cyclic time periods that are accessible through this session. In both cases, the order of the set is not specified.
      Returns:
      a CyclicTimePeriodList
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.