Package com.simplicite.bpm

Class ActivityFile

  • All Implemented Interfaces:
    java.io.Serializable
    public class ActivityFile
extends java.lang.Object
implements java.io.Serializable
    Activity file for storing instantiated process data
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DataFile addDataFile​(Data d)
      Add data.
      DataFile addDataFile​(java.lang.String group, java.lang.String name)
      Add dynamic data.
      DataFile addDataFile​(java.lang.String group, java.lang.String name, java.lang.String value)
      Add dynamic data with a value.
      java.util.Map<java.lang.String,​java.util.List<DataFile>> dataFiles()
      Get data files.
      Activity getActivity()
      Get activity.
      java.lang.String getAID()
      Get instance number of activity (AID).
      DataFile getDataFile​(java.lang.String group, java.lang.String name, boolean traceMissing)
      Retrieve context data from its path.
      java.util.List<DataFile> getDataFiles()
      Retrieve all context data.
      java.util.List<DataFile> getDataFiles​(java.lang.String group)
      Retrieve context data for a group.
      java.lang.String getDataValue​(java.lang.String group, java.lang.String name)
      Retrieve context (first) value from its path.
      java.io.InputStream getDataValueContent​(java.lang.String group, java.lang.String name, boolean deleteOnClose)
      Retrieve context file content part from its path.
      java.lang.String getDataValueName​(java.lang.String group, java.lang.String name)
      Retrieve context file name part from its path.
      java.lang.String getDeadline()
      Get planned end date.
      java.lang.String getEndDate()
      Get actual end date.
      java.lang.String getExternalURL()
      Prepare URL of external activity (Page.Name).
      java.lang.String getOwnerId()
      Get owner user ID, may be null if nobody uses the activity.
      java.lang.String getPID()
      get instance number of process (PID).
      java.lang.String getPlanDate()
      Get planned start date.
      Processus getProcessus()
      Get business process.
      java.lang.String getStartDate()
      Get actual start date.
      char getStatus()
      Get status.
      java.lang.String getUsageInfo()
      Get usage info (markdown syntax)
      java.lang.Long getWaitingTime()
      Get waiting time from the previous activity (long process only).
      boolean isReadOnly()
      Is read only?
      java.util.List<ObjectFieldSearch> loadFilters​(ObjectDB obj, Processus p)
      Load filters.
      void removeDataFile​(java.lang.String group, java.lang.String name)
      Remove dynamic data.
      void setAID​(java.lang.String aid)
      Set instance number of activity (AID).
      void setDataFile​(java.lang.String group, java.lang.String name, java.lang.String value)
      Update mono value context data.
      void setDataFile​(java.lang.String group, java.lang.String name, java.lang.String[] values)
      Update multi values context data.
      void setDataFile​(java.lang.String group, java.lang.String name, java.lang.String path, byte[] data)
      Update binary context data.
      void setDataFile​(java.lang.String group, java.lang.String name, java.lang.String path, java.io.File file)
      Update file context data.
      void setDataFile​(java.lang.String group, java.lang.String name, java.util.List<java.lang.String> values)
      Update multi-values context data.
      void setDeadline​(java.lang.String d)
      Set planned end date.
      void setEndDate​(java.lang.String d)
      Set actual end date.
      void setNextStep​(java.lang.String nextStep)
      Force the next step.
      void setOwnerId​(int userId)
      Set owner user ID.
      void setOwnerId​(java.lang.String userId)
      Set owner user ID.
      void setPID​(java.lang.String id)
      Set instance number of process (PID).
      void setPlanDate​(java.lang.String d)
      Set planned start date.
      void setReadOnly​(boolean b)
      Set read only.
      void setStartDate​(java.lang.String d)
      Set actual start date.
      void setStartDate​(java.lang.String d, boolean waitingTime)
      Set actual start date.
      void setStatus​(char s)
      Set status.
      void setUsageInfo​(java.lang.String info)
      Set usage info.
      void setWaitingTime​(java.lang.Long wt)
      Set waiting time frm the previous activity (long process only).
      java.lang.String toJSON()
      Generates a JSON string representation of the activity file.
      java.lang.String toJSON​(ObjectDB obj, boolean metadata)
      Generates a JSON string representation of the activity file.
      org.json.JSONObject toJSONObject()
      Generates a JSON object representation of the activity file.
      java.lang.String toString()
      Generates a JSON string representation of the activity file.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • ActivityFile

        public ActivityFile​(Activity a,
                    java.lang.String aid)
        Constructor.
        Parameters:
        a - Activity
        aid - Instance number of activity (AID)

      • ActivityFile

        public ActivityFile​(ActivityFile af)
        Copy constructor
        Parameters:
        af - activity file

    • Method Detail

      • getActivity

        public Activity getActivity()
        Get activity.
        Returns:
        Activity

      • getProcessus

        public Processus getProcessus()
        Get business process.
        Returns:
        Processus

      • getAID

        public java.lang.String getAID()
        Get instance number of activity (AID).
        Returns:
        AID

      • setAID

        public void setAID​(java.lang.String aid)
        Set instance number of activity (AID).
        Parameters:
        aid - AID

      • getPID

        public java.lang.String getPID()
        get instance number of process (PID).
        Returns:
        PID

      • setPID

        public void setPID​(java.lang.String id)
        Set instance number of process (PID).
        Parameters:
        id - PID

      • isReadOnly

        public boolean isReadOnly()
        Is read only?
        Returns:
        True if read only

      • setReadOnly

        public void setReadOnly​(boolean b)
        Set read only.
        Parameters:
        b - Read only?

      • getStatus

        public char getStatus()
        Get status.
        Returns:
        Status (one of STATE_* constants)

      • setStatus

        public void setStatus​(char s)
        Set status.
        Parameters:
        s - Status (one of STATE_* constants)

      • getUsageInfo

        public java.lang.String getUsageInfo()
        Get usage info (markdown syntax)
        Returns:
        Activity context

      • setUsageInfo

        public void setUsageInfo​(java.lang.String info)
        Set usage info.
        Parameters:
        info - (markdown syntax)

      • getOwnerId

        public java.lang.String getOwnerId()
        Get owner user ID, may be null if nobody uses the activity.
        Returns:
        Owner user ID or null

      • setOwnerId

        public void setOwnerId​(int userId)
        Set owner user ID.
        Parameters:
        userId - Owner user ID

      • setOwnerId

        public void setOwnerId​(java.lang.String userId)
        Set owner user ID.
        Parameters:
        userId - Owner user ID

      • getPlanDate

        public java.lang.String getPlanDate()
        Get planned start date.
        Returns:
        Planned start date

      • setPlanDate

        public void setPlanDate​(java.lang.String d)
        Set planned start date.
        Parameters:
        d - Planned start date

      • getDeadline

        public java.lang.String getDeadline()
        Get planned end date.
        Returns:
        Deadline

      • setDeadline

        public void setDeadline​(java.lang.String d)
        Set planned end date.
        Parameters:
        d - Planned end date

      • getStartDate

        public java.lang.String getStartDate()
        Get actual start date.
        Returns:
        Start Date

      • setStartDate

        public void setStartDate​(java.lang.String d)
        Set actual start date.
        Parameters:
        d - Actual start Date

      • setStartDate

        public void setStartDate​(java.lang.String d,
                         boolean waitingTime)
        Set actual start date.
        Parameters:
        d - Actual start Date
        waitingTime - Waiting time in seconds

      • getWaitingTime

        public java.lang.Long getWaitingTime()
        Get waiting time from the previous activity (long process only).
        Returns:
        Waiting Time in seconds

      • setWaitingTime

        public void setWaitingTime​(java.lang.Long wt)
        Set waiting time frm the previous activity (long process only).
        Parameters:
        wt - Waiting time in seconds

      • getEndDate

        public java.lang.String getEndDate()
        Get actual end date.
        Returns:
        End Date

      • setEndDate

        public void setEndDate​(java.lang.String d)
        Set actual end date.
        Parameters:
        d - End Date

      • addDataFile

        public DataFile addDataFile​(java.lang.String group,
                            java.lang.String name)
        Add dynamic data.
        Parameters:
        group - Group
        name - Name
        Returns:
        DataFile

      • addDataFile

        public DataFile addDataFile​(java.lang.String group,
                            java.lang.String name,
                            java.lang.String value)
        Add dynamic data with a value.
        Parameters:
        group - Group
        name - Name
        value - Value
        Returns:
        DataFile

      • removeDataFile

        public void removeDataFile​(java.lang.String group,
                           java.lang.String name)
        Remove dynamic data.
        Parameters:
        group - Group
        name - Name

      • addDataFile

        public DataFile addDataFile​(Data d)
        Add data.
        Parameters:
        d - Data
        Returns:
        DataFile

      • getDataFile

        public DataFile getDataFile​(java.lang.String group,
                            java.lang.String name,
                            boolean traceMissing)
        Retrieve context data from its path.
        Parameters:
        group - Group
        name - Name
        traceMissing - traceMissing ?
        Returns:
        context data

      • getDataValue

        public java.lang.String getDataValue​(java.lang.String group,
                                     java.lang.String name)
        Retrieve context (first) value from its path.
        Parameters:
        group - Group
        name - Name
        Returns:
        context value

      • getDataValueName

        public java.lang.String getDataValueName​(java.lang.String group,
                                         java.lang.String name)
        Retrieve context file name part from its path.
        Parameters:
        group - Group
        name - Name
        Returns:
        file name

      • getDataValueContent

        public java.io.InputStream getDataValueContent​(java.lang.String group,
                                               java.lang.String name,
                                               boolean deleteOnClose)
        Retrieve context file content part from its path.
        Parameters:
        group - Group of data
        name - Data name
        deleteOnClose - delete file after reading?
        Returns:
        data stream

      • getDataFiles

        public java.util.List<DataFile> getDataFiles​(java.lang.String group)
        Retrieve context data for a group.
        Parameters:
        group - Group
        Returns:
        List of DataFile

      • getDataFiles

        public java.util.List<DataFile> getDataFiles()
        Retrieve all context data.
        Returns:
        List of DataFile

      • dataFiles

        public java.util.Map<java.lang.String,​java.util.List<DataFile>> dataFiles()
        Get data files.
        Returns:
        Data files

      • setDataFile

        public void setDataFile​(java.lang.String group,
                        java.lang.String name,
                        java.lang.String value)
        Update mono value context data.
        Parameters:
        group - Group
        name - Name
        value - Value

      • setDataFile

        public void setDataFile​(java.lang.String group,
                        java.lang.String name,
                        java.lang.String path,
                        byte[] data)
        Update binary context data.
        Parameters:
        group - Group
        name - Name
        path - Path
        data - Data

      • setDataFile

        public void setDataFile​(java.lang.String group,
                        java.lang.String name,
                        java.lang.String path,
                        java.io.File file)
        Update file context data.
        Parameters:
        group - Group
        name - Name
        path - Path
        file - File

      • setDataFile

        public void setDataFile​(java.lang.String group,
                        java.lang.String name,
                        java.util.List<java.lang.String> values)
        Update multi-values context data.
        Parameters:
        group - Group
        name - Name
        values - Values

      • setDataFile

        public void setDataFile​(java.lang.String group,
                        java.lang.String name,
                        java.lang.String[] values)
        Update multi values context data.
        Parameters:
        group - Group
        name - Name
        values - Values

      • setNextStep

        public void setNextStep​(java.lang.String nextStep)
        Force the next step.
        Parameters:
        nextStep - Next step name

      • loadFilters

        public java.util.List<ObjectFieldSearch> loadFilters​(ObjectDB obj,
                                                     Processus p)
        Load filters.
        Parameters:
        obj - Object
        p - Processus
        Returns:
        Filters

      • getExternalURL

        public java.lang.String getExternalURL()
        Prepare URL of external activity (Page.Name).
        Returns:
        Prepared URL

      • toJSON

        public java.lang.String toJSON()
        Generates a JSON string representation of the activity file.
        Returns:
        JSON string

      • toJSON

        public java.lang.String toJSON​(ObjectDB obj,
                               boolean metadata)
        Generates a JSON string representation of the activity file.
        Parameters:
        obj - Object
        metadata - Metadata?
        Returns:
        JSON string

      • toJSONObject

        public org.json.JSONObject toJSONObject()
        Generates a JSON object representation of the activity file.
        Returns:
        activity file as a JSON object

      • toString

        public java.lang.String toString()
        Generates a JSON string representation of the activity file.
        Overrides:
        toString in class java.lang.Object
        Returns:
        activity file as a JSON string