Package de.elo.ix.client
Class DocMaskDetails
java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.DocMaskDetails
- All Implemented Interfaces:
Serializable
This class contains a member of a
DocMask
object.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected int
Archiving mode.protected boolean
IfDocMask.index
is defined, this option effects that the resulting archieve path is created, if it does not exist.protected boolean
IfDocMask.index
is defined including reference paths, this option effects that the resulting reference paths are created, if they do not exist.protected boolean
Folders indexed with this mask get the flagSordDetails.documentContainer
set accordingly.protected boolean
Mask can be used to edit indexing information of a document.protected boolean
Usage depends on the keywording form of the parent entry.protected int
Encryption set number.protected boolean
Mask can be used to edit indexing information of a folderprotected boolean
Document is or should be containted in the fultext database.protected boolean
Do not inherit permissions from parent Sords.protected boolean
Mask can be referenced from a DocMaskLine of typeDocMaskLineC.TYPE_RELATION
.
If this mask has a data organisationDocMaskC.DATA_ORGANISATION_ASPECT
the value determines if it can be referenced by an AspectLine of typeAspectLineC.TYPE_RELATION
.protected boolean
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.protected boolean
Documents using this mask may be used as release notesprotected boolean
Mask can be used to search for indexing information.protected int
Sort order of child entries.protected boolean
Iftrue
translate the sord's short description into or from the user language.Fields inherited from class byps.BValueClass
bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
int
int
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isRegion()
boolean
boolean
boolean
void
setArchivingMode
(int archivingMode) void
setCreateIndexPath
(boolean createIndexPath) void
setCreateIndexReferencesPaths
(boolean createIndexReferencesPaths) void
setDocumentContainer
(boolean documentContainer) void
setDocumentMask
(boolean documentMask) void
setEnabledByParent
(boolean v) void
setEncryptionSet
(int encryptionSet) void
setFolderMask
(boolean folderMask) void
setFulltext
(boolean fulltext) void
setInheritAclDisabled
(boolean inheritPermissionsDisabled) void
setKeywordingRelationAllowed
(boolean keywordingRelationAllowed) void
setRegion
(boolean isRegion) void
setReleaseDocument
(boolean releaseDocument) void
setSearchMask
(boolean searchMask) void
setSortOrder
(int sortOrder) void
setTranslateSordName
(boolean translateSordName) Methods inherited from class byps.BValueClass
getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper
-
Field Details
-
archivingMode
protected int archivingModeArchiving mode. Sort order and archiving mode share the same database column. If the mask is used for documents, setsortOrder=SordOrderC.NONE
. ELO 7.0: This value is only valid for document masks,documentMask=true
.- See Also:
-
encryptionSet
protected int encryptionSetEncryption set number. -
fulltext
protected boolean fulltextDocument is or should be containted in the fultext database. -
sortOrder
protected int sortOrderSort order of child entries. Sort order and archiving mode share the same database column. If the mask is used for folders, setarchivingMode=ArchivingModeC.NONE
. If bothsortOrder
andarchivingMode
are set,sortOrder
has precedence andarchivingMode
is ignored. ELO 7.0: This value is only valid for folder masks,folderMask=true
.- See Also:
-
documentMask
protected boolean documentMaskMask can be used to edit indexing information of a document. -
searchMask
protected boolean searchMaskMask can be used to search for indexing information. -
folderMask
protected boolean folderMaskMask can be used to edit indexing information of a folder- Since:
- 7.00.000.000
-
createIndexPath
protected boolean createIndexPathIfDocMask.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 createIndexReferencesPathsIfDocMask.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 releaseDocumentDocuments using this mask may be used as release notes- Since:
- 8.00.032.007
-
documentContainer
protected boolean documentContainerFolders indexed with this mask get the flagSordDetails.documentContainer
set accordingly.- Since:
- 9.00.018.004
-
translateSordName
protected boolean translateSordNameIftrue
translate the sord's short description into or from the user language.- Since:
- 9.00.030.013
-
enabledByParent
protected boolean enabledByParentUsage 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 memberDocMask.maskIdsForChildEntries
.- Since:
- 11.00.000.020
-
inheritAclDisabled
protected boolean inheritAclDisabledDo not inherit permissions from parent Sords.- Since:
- 11.00.000.055
-
keywordingRelationAllowed
protected boolean keywordingRelationAllowedMask can be referenced from a DocMaskLine of typeDocMaskLineC.TYPE_RELATION
.
If this mask has a data organisationDocMaskC.DATA_ORGANISATION_ASPECT
the value determines if it can be referenced by an AspectLine of typeAspectLineC.TYPE_RELATION
.- Since:
- 12.00.000.023
- See Also:
-
region
protected boolean regionSords 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
-
-
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)
-