Package org.sakaiproject.signup.logic.messages

Interface SignupEventTrackingInfo

  • All Known Implementing Classes:
    SignupEventTrackingInfoImpl
    public interface SignupEventTrackingInfo

    This interface provides the necessary access methods to retrieve all related information caused by an user action inside the Signup tool

    • Method Detail

      • getAttendeeTransferInfos

        List<SignupTrackingItem> getAttendeeTransferInfos()
        get a list of SignupTrackingItem objects which contains all related information caused by an user action inside the Signup tool
        Returns:
        a list of SignupTrackingItem object

      • addOrUpdateAttendeeAllocationInfo

        void addOrUpdateAttendeeAllocationInfo​(SignupAttendee attendee,
                                       SignupTimeslot timeslot,
                                       String messageType,
                                       boolean isInitiator)
        add a new/updated user action information triggered by an user
        Parameters:
        attendee - an SignupAttendee object
        timeslot - an SignupTimeslot object
        messageType - a message type which defines what type of an action caused by the an user
        isInitiator - boolean value

      • addOrUpdateAttendeeAllocationInfo

        void addOrUpdateAttendeeAllocationInfo​(SignupAttendee attendee,
                                       SignupTimeslot timeslot,
                                       String messageType,
                                       boolean isInitiator,
                                       SignupAttendee replacedAttendee)
        add a new/updated user action information triggered by an user
        Parameters:
        attendee - an SignupAttendee object
        timeslot - an SignupTimeslot object
        messageType - a message type which defines what type of an action caused by the an user
        isInitiator - boolean value
        replacedAttendee - an SignupAttendee object

      • getMeeting

        SignupMeeting getMeeting()
        get the SignupMeeting object
        Returns:
        the SignupMeeting object

      • getInitiatorAllocationInfo

        SignupTrackingItem getInitiatorAllocationInfo()
        get the Initiator's SignupTrackingItem object
        Returns:
        the Initiator's SignupTrackingItem object

      • setMeeting

        void setMeeting​(SignupMeeting meeting)
        set the SignupMeeting object
        Parameters:
        meeting - a SignupMeeting object

      • getAllAttendeeTransferLogInfo

        String getAllAttendeeTransferLogInfo()
        get the Transfer Logger Info for all users. It's for Logger purpose
        Returns:
        a string value.

      • setAttendeeComment

        void setAttendeeComment​(AttendeeComment attendeeComment)
        set the attendeeComment object
        Parameters:
        attendeeComment - an AttendeeComment object

      • getAttendeeComment

        AttendeeComment getAttendeeComment()
        get the AttendeeComment object
        Returns:
        the AttendeeComment object