Class ContributionTrackingEvent

    • Constructor Detail

      • ContributionTrackingEvent

        protected ContributionTrackingEvent()
      • ContributionTrackingEvent

        public ContributionTrackingEvent​(TrackedAction action,
                                         ContributionIdentifier contributionId)
        Constructs a new tracking event about the specified action being performed against the given contribution.
        Parameters:
        action - the action that has been done.
        contributionId - the unique identifier of the contribution on which the action has be done.
    • Method Detail

      • getContext

        public String getContext()
        Gets a description about the context on the modification that was operated on the underlying contribution.
        Returns:
        a short description of the modification context or an empty string if no description was provided about it.
      • setContext

        public ContributionTrackingEvent setContext​(String context)
        Sets a short text explaining the context under which the tracked modification of the underlying contribution was operated.
        Parameters:
        context -
        Returns:
      • getAction

        public TrackedAction getAction()
        Gets the action that is reported by this event.
        Returns:
        the tracked action on the contribution related by this event.
      • getContributionId

        public ContributionIdentifier getContributionId()
        Gets the identifier of the contribution that is related by this event.
        Returns:
        the identifier of a contribution in Silverpeas.
      • save

        public ContributionTrackingEvent save()
        Saves the specified event into the modification history of the related contribution.