Class ProcessInfo

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.ProcessInfo
All Implemented Interfaces:
Serializable

public class ProcessInfo extends ValueClass implements Serializable
Specific processing information for each node of processTrees(...) or processFindResults(...). The operations will be for existence (not null) in order of their appearance in ProcessInfo. Some of the underlying structures may allow toggling between prefix and postfix processing when used with processTrees.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:
  • Field Details

    • delStatus

      protected int delStatus
      pass 0 for valid (undeleted) nodes, >0 otherwise.
    • desc

      protected String desc
      Holds the user defined description of a specific call. This member must not be null or empty.
    • errorMode

      protected int errorMode
      From ProcessInfoC: ERRORMODE_ALL, ERRORMODE_SKIP_SUBTREE, ERRORMODE_SKIP_PROCINFO or ERRORMODE_CRITICAL_ONLY.
    • ignoreDocuments

      protected boolean ignoreDocuments
      processing flag for documents.
    • ignoreStructures

      protected boolean ignoreStructures
      processing flag for structure elements.
    • lockZ

      protected LockZ lockZ
      Use this parameter to access potentially locked nodes.
    • procAcl

      protected ProcessAcl procAcl
      Prefix processing, valid ProcessAcl data.
    • procFulltext

      protected ProcessFulltext procFulltext
      Prefix processing, valid ProcessFulltext data.
      Since:
      6.00.099
    • procCountElem

      protected ProcessCountElements procCountElem
      Prefix processing count all elements
      Since:
      7.00.000.000
    • procMoveDocumentsToStoragePath

      protected ProcessMoveDocumentsToStoragePath procMoveDocumentsToStoragePath
      Move documents to storage path.
      Since:
      7.00.000.045
    • procCopyElements

      protected ProcessCopyElements procCopyElements
      Copy the elements into other archive location.
      Since:
      7.00.020.001
    • procMsgMax

      protected int procMsgMax
      Maximum amount of recorded errors in procMsgs; from ProcessInfoC: PROCMSGMAX.
    • procMsgs

      protected String[] procMsgs
      Recorded error messages; specify their amount using procMsgMax.
    • procReplSet

      protected ProcessReplSet procReplSet
      Prefix processing, valid ProcessReplSet data.
    • procSpaceGuid

      protected ProcessSpaceGuid procSpaceGuid
      Workspace GUID processing.
      Since:
      21.00.000.016
    • procScript

      protected ProcessScript procScript
      Either prefix or postfix processing.
    • forceOperation

      protected boolean forceOperation
      Defines, if the data allways have to be written
      Since:
      7.00.000.038
    • inclReferences

      protected boolean inclReferences
      Process references (logical copies) too.
      Since:
      8.00.000.004
    • procReleaseLock

      protected ProcessReleaseLock procReleaseLock
      Release the locks on processed elements.
      Since:
      9.00.000.031
    • procInheritKeywording

      protected ProcessInheritKeywording procInheritKeywording
      Inherit keywording.
      Since:
      10.17.040.001
    • procRegion

      protected ProcessRegion procRegion
      Process region of sub-trees.
      Since:
      21.04.000.012
  • Constructor Details

    • ProcessInfo

      public ProcessInfo()
    • ProcessInfo

      public ProcessInfo(ProcessInfo rhs)
  • Method Details

    • getDelStatus

      public int getDelStatus()
    • setDelStatus

      public void setDelStatus(int delStatus)
    • getDesc

      public String getDesc()
    • setDesc

      public void setDesc(String desc)
    • getErrorMode

      public int getErrorMode()
    • setErrorMode

      public void setErrorMode(int errorMode)
    • isIgnoreDocuments

      public boolean isIgnoreDocuments()
    • setIgnoreDocuments

      public void setIgnoreDocuments(boolean ignoreDocuments)
    • isIgnoreStructures

      public boolean isIgnoreStructures()
    • setIgnoreStructures

      public void setIgnoreStructures(boolean ignoreStructures)
    • getLockZ

      public LockZ getLockZ()
    • setLockZ

      public void setLockZ(LockZ lockZ)
    • getProcAcl

      public ProcessAcl getProcAcl()
    • getProcFulltext

      public ProcessFulltext getProcFulltext()
    • getProcCountElem

      public ProcessCountElements getProcCountElem()
    • getProcCopyElements

      public ProcessCopyElements getProcCopyElements()
    • getForceOperation

      public boolean getForceOperation()
    • setProcAcl

      public void setProcAcl(ProcessAcl procAcl)
    • setProcFulltext

      public void setProcFulltext(ProcessFulltext procFulltext)
    • setProcCountElem

      public void setProcCountElem(ProcessCountElements procCountElem)
    • setProcCopyElements

      public void setProcCopyElements(ProcessCopyElements procCopyElements)
    • getProcMsgMax

      public int getProcMsgMax()
    • setProcMsgMax

      public void setProcMsgMax(int procMsgMax)
    • getProcMsgs

      public String[] getProcMsgs()
    • setProcMsgs

      public void setProcMsgs(String[] procMsgs)
    • getProcReplSet

      public ProcessReplSet getProcReplSet()
    • setProcReplSet

      public void setProcReplSet(ProcessReplSet procReplSet)
    • getProcSpaceGuid

      public ProcessSpaceGuid getProcSpaceGuid()
    • setProcSpaceGuid

      public void setProcSpaceGuid(ProcessSpaceGuid procSpaceGuid)
    • getProcScript

      public ProcessScript getProcScript()
    • setProcScript

      public void setProcScript(ProcessScript procScript)
    • setForceOperation

      public void setForceOperation(boolean forceOperation)
    • getProcRegion

      public ProcessRegion getProcRegion()
    • setProcRegion

      public void setProcRegion(ProcessRegion procRegion)
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • getProcMoveDocumentsToStoragePath

      public ProcessMoveDocumentsToStoragePath getProcMoveDocumentsToStoragePath()
    • setProcMoveDocumentsToStoragePath

      public void setProcMoveDocumentsToStoragePath(ProcessMoveDocumentsToStoragePath procMoveDocumentsToStoragePath)
    • isInclReferences

      public boolean isInclReferences()
    • setInclReferences

      public void setInclReferences(boolean inclReferences)
    • getProcReleaseLock

      public ProcessReleaseLock getProcReleaseLock()
    • setProcLockRelease

      public void setProcLockRelease(ProcessReleaseLock procLockRelease)
    • setProcReleaseLock

      public void setProcReleaseLock(ProcessReleaseLock procReleaseLock)
    • setProcInheritKeywording

      public void setProcInheritKeywording(ProcessInheritKeywording procInheritKeywording)
    • getProcInheritKeywording

      public ProcessInheritKeywording getProcInheritKeywording()