Class DocMaskDetails

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

public class DocMaskDetails extends ValueClass implements Serializable
This class contains a member of a DocMask object.
See Also:
  • Field Details

    • archivingMode

      protected int archivingMode
      Archiving mode. Sort order and archiving mode share the same database column. If the mask is used for documents, set sortOrder=SordOrderC.NONE. ELO 7.0: This value is only valid for document masks, documentMask=true.
      See Also:
    • encryptionSet

      protected int encryptionSet
      Encryption set number.
    • fulltext

      protected boolean fulltext
      Document is or should be containted in the fultext database.
    • sortOrder

      protected int sortOrder
      Sort order of child entries. Sort order and archiving mode share the same database column. If the mask is used for folders, set archivingMode=ArchivingModeC.NONE. If both sortOrder and archivingMode are set, sortOrder has precedence and archivingMode is ignored. ELO 7.0: This value is only valid for folder masks, folderMask=true.
      See Also:
    • documentMask

      protected boolean documentMask
      Mask can be used to edit indexing information of a document.
    • searchMask

      protected boolean searchMask
      Mask can be used to search for indexing information.
    • folderMask

      protected boolean folderMask
      Mask can be used to edit indexing information of a folder
      Since:
      7.00.000.000
    • createIndexPath

      protected boolean createIndexPath
      If DocMask.index is defined, this option effects that the resulting archieve path is created, if it does not exist.
      Since:
      6.00.098
    • createIndexReferencesPaths

      protected boolean createIndexReferencesPaths
      If DocMask.index is defined including reference paths, this option effects that the resulting reference paths are created, if they do not exist.
      Since:
      6.00.098
    • releaseDocument

      protected boolean releaseDocument
      Documents using this mask may be used as release notes
      Since:
      8.00.032.007
    • documentContainer

      protected boolean documentContainer
      Folders indexed with this mask get the flag SordDetails.documentContainer set accordingly.
      Since:
      9.00.018.004
    • translateSordName

      protected boolean translateSordName
      If true translate the sord's short description into or from the user language.
      Since:
      9.00.030.013
    • enabledByParent

      protected boolean enabledByParent
      Usage depends on the keywording form of the parent entry. This keywording form should only be used for a Sord, if the keywording form of the parent Sord explicitly allows that in it's member DocMask.maskIdsForChildEntries.
      Since:
      11.00.000.020
    • inheritAclDisabled

      protected boolean inheritAclDisabled
      Do not inherit permissions from parent Sords.
      Since:
      11.00.000.055
    • keywordingRelationAllowed

      protected boolean keywordingRelationAllowed
      Mask can be referenced from a DocMaskLine of type DocMaskLineC.TYPE_RELATION.
      If this mask has a data organisation DocMaskC.DATA_ORGANISATION_ASPECT the value determines if it can be referenced by an AspectLine of type AspectLineC.TYPE_RELATION.
      Since:
      12.00.000.023
      See Also:
    • region

      protected boolean region
      Sords of this mask, in case they are a folder, establish a region within the repository tree.
      This flag is only valid for masks of data organisation. DocMaskC.DATA_ORGANISATION_ASPECT.
      Since:
      21.04.000.003
  • Constructor Details

    • DocMaskDetails

      public DocMaskDetails()
    • DocMaskDetails

      public DocMaskDetails(DocMaskDetails rhs)
  • Method Details

    • getArchivingMode

      public int getArchivingMode()
    • setArchivingMode

      public void setArchivingMode(int archivingMode)
    • getEncryptionSet

      public int getEncryptionSet()
    • setEncryptionSet

      public void setEncryptionSet(int encryptionSet)
    • isFulltext

      public boolean isFulltext()
    • setFulltext

      public void setFulltext(boolean fulltext)
    • getSortOrder

      public int getSortOrder()
    • setSortOrder

      public void setSortOrder(int sortOrder)
    • isDocumentMask

      public boolean isDocumentMask()
    • setDocumentMask

      public void setDocumentMask(boolean documentMask)
    • isSearchMask

      public boolean isSearchMask()
    • setSearchMask

      public void setSearchMask(boolean searchMask)
    • isCreateIndexPath

      public boolean isCreateIndexPath()
    • setCreateIndexPath

      public void setCreateIndexPath(boolean createIndexPath)
    • isCreateIndexReferencesPaths

      public boolean isCreateIndexReferencesPaths()
    • setCreateIndexReferencesPaths

      public void setCreateIndexReferencesPaths(boolean createIndexReferencesPaths)
    • isFolderMask

      public boolean isFolderMask()
    • isDocumentContainer

      public boolean isDocumentContainer()
    • setDocumentContainer

      public void setDocumentContainer(boolean documentContainer)
    • setFolderMask

      public void setFolderMask(boolean folderMask)
    • isReleaseDocument

      public boolean isReleaseDocument()
    • setReleaseDocument

      public void setReleaseDocument(boolean releaseDocument)
    • isTranslateSordName

      public boolean isTranslateSordName()
    • setTranslateSordName

      public void setTranslateSordName(boolean translateSordName)
    • isEnabledByParent

      public boolean isEnabledByParent()
    • setEnabledByParent

      public void setEnabledByParent(boolean v)
    • isInheritAclDisabled

      public boolean isInheritAclDisabled()
    • setInheritAclDisabled

      public void setInheritAclDisabled(boolean inheritPermissionsDisabled)
    • isKeywordingRelationAllowed

      public boolean isKeywordingRelationAllowed()
    • setKeywordingRelationAllowed

      public void setKeywordingRelationAllowed(boolean keywordingRelationAllowed)
    • isRegion

      public boolean isRegion()
    • setRegion

      public void setRegion(boolean isRegion)