Class WFNote

All Implemented Interfaces:
DBData, JcmsConstants, ImportConstants, MashupConstants, RelatedData<Publication>, Storable, JaliosConstants, LangPropertyArgument, Serializable, Cloneable, Comparable<BasicStorable>

public class WFNote extends Data implements DBData, RelatedData<Publication>
This class represents a small note about a state change in the workflow.
Since:
jcms-2.1
Author:
Olivier Dedieu
See Also:
  • Field Details

    • publicationId

      @Deprecated protected String publicationId
      Deprecated.
    • prevPstatus

      protected int prevPstatus
    • newPstatus

      protected int newPstatus
    • note

      protected String note
    • finalVote

      protected boolean finalVote
  • Constructor Details

    • WFNote

      public WFNote()
    • WFNote

      public WFNote(Publication targetData, int prevPstatus, int newPstatus, String comment, Member author)
    • WFNote

      public WFNote(WFNote other)
  • Method Details

    • getPrevStateLabel

      public String getPrevStateLabel(String userLang)
      Returns the label of the previous state.
      Parameters:
      userLang - the user language.
      Returns:
      the label of the previous state.
      Since:
      jcms-5.7.0
    • getNewStateLabel

      public String getNewStateLabel(String userLang)
      Returns the label of the previous state.
      Parameters:
      userLang - the user language.
      Returns:
      the label of the previous state.
      Since:
      jcms-5.7.0
    • getFinalVote

      public boolean getFinalVote()
      Returns true if the WFNote is the final in a vote.
      Returns:
      true if the WFNote is the final in a vote.
      Since:
      jcms-6.0.0
    • setFinalVote

      public void setFinalVote(boolean finalVote)
      Sets this WFNote as final vote.
      Parameters:
      finalVote - the boolean value.
      Since:
      jcms-6.0.0
    • getPublication

      @Deprecated public Publication getPublication()
      Deprecated.
      Retrieve the publication associated to this WFNote.
      Returns:
      the Publication associated to this WFNote.
      Since:
      jcms-2.1
    • setPublication

      @Deprecated public void setPublication(Publication pub)
      Deprecated.
      Set the publication associated to this WFNote.
      Parameters:
      pub - a Publication.
      Since:
      jcms-2.1
    • getPublicationId

      @Deprecated public String getPublicationId()
      Deprecated.
      Returns the JStore ID of the publication.
      Returns:
      the JStore ID of the publication
      Since:
      jcms-6.0.0
    • setPublicationId

      @Deprecated public void setPublicationId(String v)
      Deprecated.
      Sets the JStore ID of the publication.
      Parameters:
      v - the JStore publication id
      Since:
      jcms-6.0.0
    • getTargetData

      public Publication getTargetData()
      Specified by:
      getTargetData in interface RelatedData<Publication>
    • setTargetData

      public void setTargetData(Publication targetData)
      Specified by:
      setTargetData in interface RelatedData<Publication>
    • getTargetDataId

      public String getTargetDataId()
      Specified by:
      getTargetDataId in interface RelatedData<Publication>
    • setTargetDataId

      public void setTargetDataId(String targetDataId)
      Specified by:
      setTargetDataId in interface RelatedData<Publication>
    • getPrevPstatus

      public int getPrevPstatus()
      Retrieve the pstatus in which the Publication was prior to the change associated to this WFNote.
      Returns:
      the previous pstatus.
      Since:
      jcms-2.1
    • setPrevPstatus

      public void setPrevPstatus(int pstatus)
      Set the pstatus in which the Publication was prior to the update associated with this WFNote.
      Parameters:
      pstatus - the previous pstatus.
      Since:
      jcms-2.1
    • getNewPstatus

      public int getNewPstatus()
      Retrieve the pstatus in which the Publication is after the update associated with this WFNote.
      Returns:
      the new pstatus.
      Since:
      jcms-2.1
    • setNewPstatus

      public void setNewPstatus(int pstatus)
      Set the pstatus in which the Publication is after the update associated with this WFNote.
      Parameters:
      pstatus - the new pstatus.
      Since:
      jcms-2.1
    • getNote

      public String getNote()
      Retrieve the note text of this WFNote.
      Returns:
      the text.
      Since:
      jcms-6.0.0
    • setNote

      public void setNote(String note)
      Set the note text of this WFNote.
      Parameters:
      note - the text of this WFNote.
      Since:
      jcms-6.0.0
    • toString

      public String toString()
      Overrides:
      toString in class Data
      Since:
      jcms-4.1
    • toFullString

      public String toFullString()
      Overrides:
      toFullString in class Data
      Since:
      jcms-9.0.3
      See Also: