Package de.elo.ix.client

Class DocMask

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.DocMask
All Implemented Interfaces:
Serializable
public class DocMask extends ValueClass implements Serializable

Contains the data for a storage mask.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:

  • Field Details

    • DAcl

      protected String DAcl
      New objects are created with these ACL permission settings.

    • DKind

      protected int DKind
      The marker color ID for new objects created with this mask.

    • DPath

      protected int DPath
      Document storage path name where the documents of this mask should be stored.

    • TStamp

      protected String TStamp
      Last update time of the storage mask data.

    • barcode

      protected String barcode
      Barcode string.

    • flowId

      protected int flowId
      The ID of a workflow that is started if a new object with this mask is created. If the SessionOption START_DOCMASK_WORKFLOWS is set, the Indexserver starts this workflow, if an associated document is created. Otherwise the client application is responsible for starting the workflow.
      See Also:

    • id

      protected int id
      Storage mask ID.

    • index

      protected String index
      This control string provides a way of storing new storage mask objects automatically in a particular archive path.

    • lifetime

      protected String lifetime
      New objects are valid for this length of time.

    • lockId

      protected int lockId
      User ID of the user that has locked the storage mask. If -1, no lock is held.

    • lockName

      protected String lockName
      Name of the user that has locked th storage mask. Read-only, ignored in checkinDocMask.
      Since:
      7.00.026.002

    • name

      protected String name
      Storage mask name. It can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.
      See Also:

    • text

      protected String text
      Tab captions. List of tab captions separated by pipe char |.

    • acl

      protected String acl
      Access control for the mask line

    • aclItems

      protected AclItem[] aclItems
      Access control to mask line. Currently this can only be null or one item representing a key.

    • details

      protected DocMaskDetails details
      Detailed properties for the DocMask object.

    • docAclItems

      protected AclItem[] docAclItems
      These access control items are the initial values for new documents inserted with this mask.

    • lines

      protected DocMaskLine[] lines
      Array of index value definitions. Only valid for dataOrganisation = DocMaskC.DATA_ORGANISATION_OBJKEYS or DocMaskC.DATA_ORGANISATION_TABLE.
      See Also:

    • guid

      protected String guid
      GUID
      Since:
      7.00.000.001

    • deleted

      protected boolean deleted
      Deleted status.
      Since:
      7.00.000.001

    • flowId2

      protected int flowId2
      The ID of a workflow that is to be started if a new version of an associated document is checked in. If the SessionOption START_DOCMASK_WORKFLOWS is set, the Indexserver starts this workflow, if an associated document is checked in. Otherwise the client application is responsible for starting the workflow.
      Since:
      7.00.040.016
      See Also:

    • TStampSync

      protected String TStampSync
      Timestamp of this object's last export by the replication.
      Since:
      9.99.009.001

    • textTranslationKey

      protected String textTranslationKey
      Translation-keyword for text.
      Since:
      9.00.018.005

    • nameTranslationKey

      protected String nameTranslationKey
      Translation-keyword for name.
      Since:
      9.00.018.005

    • dataOrganisation

      protected int dataOrganisation
      This member specifies how the index values are stored in database.
      Since:
      9.00.039.001
      See Also:

    • sordType

      protected int sordType
      Prepare this type for a new Sord object.

      If this value is 0, the Sord type is SordC.LBT_DOCUMENT for a new document. For a new folder, the default sord type is set as the parent's sord type plus 1. If the parent is undefined, the default type is 1.

      If this value is not 0, it must be given between 1 and SordC.LBT_DOCUMENT-1 for folder types and between SordC.LBT_DOCUMENT and SordC.LBT_DOCUMENT_MAX for document types.

      Since:
      11.00.000.002

    • maskIdsForChildEntries

      protected List<Integer> maskIdsForChildEntries
      Child entries in the archive hierarchy should only use this keywording forms. If this element is null or empty, child entries can use any keywording form. Otherwise, new child entries have to be assigned to one of the listed form. This rule only applies to physical and not to logical references. The maximum number of keywording forms is defined by DocMaskC.MAX_MASK_IDS_FOR_CHILD_ENTRIES.
      Since:
      11.00.000.003
      See Also:

    • packageName

      protected String packageName
      Package name of DocMask
      Since:
      20.00.000.009

    • inheritFromMasks

      protected List<DocMaskInherit> inheritFromMasks
      Inherit aspects from this keywording forms. Only valid for dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
      Since:
      20.00.000.100

    • aspectAssocs

      protected Map<String,AspectAssoc> aspectAssocs
      Keywording aspect associations. These are the effective aspect associations inluding locally defined associations and inherited associations. Only valid for dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
      Since:
      20.00.000.100

    • localAspectAssocs

      protected Map<String,AspectAssoc> localAspectAssocs
      Keywording aspect associations which are defined locally in this mask. Only valid for dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT.
      Since:
      20.00.000.102

    • deletionDeadline

      protected String deletionDeadline
      Deletion deadline for new objects.
      Since:
      20.00.000.110

    • transitiveChildren

      protected List<Integer> transitiveChildren
      Transitive children of the mask.
      Since:
      21.02.000.010

  • Constructor Details

    • DocMask

      public DocMask()
      Default constructor.

    • DocMask

      public DocMask(DocMask rhs)

  • Method Details

    • getDAcl

      public String getDAcl()

    • setDAcl

      public void setDAcl(String DAcl)

    • getDKind

      public int getDKind()

    • setDKind

      public void setDKind(int DKind)

    • getDPath

      public int getDPath()

    • setDPath

      public void setDPath(int DPath)

    • getTStamp

      public String getTStamp()

    • setTStamp

      public void setTStamp(String TStamp)

    • getBarcode

      public String getBarcode()

    • setBarcode

      public void setBarcode(String barcode)

    • getFlowId

      public int getFlowId()

    • setFlowId

      public void setFlowId(int flowId)

    • getId

      public int getId()

    • setId

      public void setId(int id)

    • getIndex

      public String getIndex()

    • setIndex

      public void setIndex(String index)

    • getLifetime

      public String getLifetime()

    • setLifetime

      public void setLifetime(String lifetime)

    • getLockId

      public int getLockId()

    • setLockId

      public void setLockId(int lockId)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getText

      public String getText()

    • setText

      public void setText(String text)

    • getAcl

      public String getAcl()

    • setAcl

      public void setAcl(String acl)

    • getAclItems

      public AclItem[] getAclItems()

    • setAclItems

      public void setAclItems(AclItem[] aclItems)

    • getDetails

      public DocMaskDetails getDetails()

    • setDetails

      public void setDetails(DocMaskDetails details)

    • getDocAclItems

      public AclItem[] getDocAclItems()

    • setDocAclItems

      public void setDocAclItems(AclItem[] docAclItems)

    • getLines

      public DocMaskLine[] getLines()

    • setLines

      public void setLines(DocMaskLine[] lines)

    • getGuid

      public String getGuid()

    • setGuid

      public void setGuid(String guid)

    • isDeleted

      public boolean isDeleted()

    • setDeleted

      public void setDeleted(boolean v)

    • getLockName

      public String getLockName()

    • setLockName

      public void setLockName(String lockName)

    • getFlowId2

      public int getFlowId2()

    • setFlowId2

      public void setFlowId2(int flowId2)

    • getTStampSync

      public String getTStampSync()

    • setTStampSync

      public void setTStampSync(String TStampSync)

    • getTextTranslationKey

      public String getTextTranslationKey()

    • setTextTranslationKey

      public void setTextTranslationKey(String textTranslationKey)

    • getNameTranslationKey

      public String getNameTranslationKey()

    • setNameTranslationKey

      public void setNameTranslationKey(String nameTranslationKey)

    • getDataOrganisation

      public int getDataOrganisation()

    • setDataOrganisation

      public void setDataOrganisation(int dataOrganisation)

    • getSordType

      public int getSordType()

    • setSordType

      public void setSordType(int sordType)

    • getPackageName

      public String getPackageName()

    • setPackageName

      public void setPackageName(String packageName)

    • getMaskIdsForChildEntries

      public List<Integer> getMaskIdsForChildEntries()

    • setMaskIdsForChildEntries

      public void setMaskIdsForChildEntries(List<Integer> maskIdsForChildEntries)

    • getInheritFromMasks

      public List<DocMaskInherit> getInheritFromMasks()

    • setInheritFromMasks

      public void setInheritFromMasks(List<DocMaskInherit> inheritFromMasks)

    • getAspectAssocs

      public Map<String,AspectAssoc> getAspectAssocs()

    • setAspectAssocs

      public void setAspectAssocs(Map<String,AspectAssoc> aspectAssocs)

    • getLocalAspectAssocs

      public Map<String,AspectAssoc> getLocalAspectAssocs()

    • setLocalAspectAssocs

      public void setLocalAspectAssocs(Map<String,AspectAssoc> aspectAssocs)

    • getDeletionDeadline

      public String getDeletionDeadline()

    • setDeletionDeadline

      public void setDeletionDeadline(String deletionDeadline)

    • getTransitiveChildren

      public List<Integer> getTransitiveChildren()

    • setTransitiveChildren

      public void setTransitiveChildren(List<Integer> transitiveChildren)

    • toString

      public String toString()
      Overrides:
      toString in class Object