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:
java.io.Serializable
public class DocMask
extends ValueClass
implements java.io.Serializable

Contains the data for a storage mask.

Copyright: Copyright (c) 2004

Organisation: ELO Digital Office GmbH

See Also:
Serialized Form

  • Field Details

    • DAcl

      protected java.lang.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 java.lang.String TStamp
      Last update time of the storage mask data.

    • barcode

      protected java.lang.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:
      flowId2, SessionOptionsC.START_DOCMASK_WORKFLOWS

    • id

      protected int id
      Storage mask ID.

    • index

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

    • lifetime

      protected java.lang.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 java.lang.String lockName
      Name of the user that has locked th storage mask. Read-only, ignored in checkinDocMask.
      Since:
      7.00.026.002

    • name

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

    • text

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

    • acl

      protected java.lang.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:
      aspectAssocs

    • guid

      protected java.lang.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:
      SessionOptionsC.START_DOCMASK_WORKFLOWS, flowId

    • TStampSync

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

    • textTranslationKey

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

    • nameTranslationKey

      protected java.lang.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:
      DocMaskC.DATA_ORGANISATION_OBJKEYS, DocMaskC.DATA_ORGANISATION_TABLE

    • 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 java.util.List<java.lang.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:
      DocMaskDetails.enabledByParent

    • packageName

      protected java.lang.String packageName
      Package name of DocMask
      Since:
      20.00.000.009

    • inheritFromMasks

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

    • aspectAssocs

      protected java.util.Map<java.lang.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 java.util.Map<java.lang.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 java.lang.String deletionDeadline
      Deletion deadline for new objects.
      Since:
      20.00.000.110

  • Constructor Details

  • Method Details