Package de.elo.ix.client

Class DocMaskLine

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.DocMaskLine
All Implemented Interfaces:
Serializable
public class DocMaskLine extends ValueClass implements Serializable
This class contains data for a line in the document mask.
See Also:

  • Field Details

    • comment

      protected String comment
      Quickinfo text for the attribute.

    • id

      protected int id
      The ID of the line information.

    • key

      protected String key
      The attribute group name. This member corresponds to ObjKey.name.
      See Also:

    • maskId

      protected int maskId
      This line information belongs to a storage mask with the ID MaskId.

    • max

      protected int max
      The maximum value of this attribute.

    • min

      protected int min
      The minimum value of this attribute.

    • name

      protected String name
      The name of the attribute. This value is displayed in the lable before the edit field. It can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.
      See Also:

    • aclItems

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

    • canEdit

      protected boolean canEdit
      Determines whether the index line can be modified. Read-only.

    • editCol

      protected int editCol
      Column position of edit control

    • editRow

      protected int editRow
      Row postion of edit control

    • editWidth

      protected int editWidth
      With of edit control

    • hidden

      protected boolean hidden
      This value should not be displayed to the user.

    • labelCol

      protected int labelCol
      Column position of label control

    • labelRow

      protected int labelRow
      Row position of label control

    • nextTab

      protected boolean nextTab
      Creates a new tab in the keywording dialogue.

    • onlyBuzzwords

      protected boolean onlyBuzzwords
      The index line can only contain buzzwords.

    • postfixAsterix

      protected boolean postfixAsterix
      Add "*" after index value in search operation.

    • prefixAsterix

      protected boolean prefixAsterix
      Add "*" before index value in search operation.

    • readOnly

      protected boolean readOnly
      This value should not be edited in a user interface (convention). Scripts are allowed to edit the value.

    • tabOrder

      protected int tabOrder
      Tabulator order of edit control

    • type

      protected int type
      The type of the line information. This can be one of the DocMaskLineC.TYPE_* constants.
      See Also:

    • externalData

      protected String externalData
      External data. Can be used to store an arbitary string.
      Since:
      7.00.000.000

    • important

      protected boolean important
      Display index value next to the objects short description. This element has to be interpreted by the client application. Indexserver ignores this value.
      Since:
      7.00.000.004

    • notTokenized

      protected boolean notTokenized
      Defines whether a index value should be searchable as TOKENIZED or UN_TOKENIZED
      Since:
      9.00.022.000

    • excludeFromISearch

      protected boolean excludeFromISearch
      If true a index value will not be searchable via iSearch. Does not affect the index search.
      Since:
      10.00.020.023

    • version

      protected boolean version
      Display index value in version information dialog when checking in a document. This element has to be interpreted by the client application. Indexserver ignores this value.
      Since:
      7.00.000.004

    • translate

      protected boolean translate
      Translate index values into or from the users language.
      Since:
      7.00.000.004
      See Also:

    • acl

      protected String acl
      Access control for mask line.

    • access

      protected int access
      Bitset of AccessC.LUR_* constants. It contains the access bits for the current user. Only AccessC.LUR_READ and AccessC.LUR_WRITE are used.
      Since:
      7.00.000.047

    • disableWordWheel

      protected boolean disableWordWheel
      Disable word wheel. Clients should not provide a function to list all existing values for this index vlaue. The Indexserver does not set or test this value.
      Since:
      7.00.040.015

    • defaultValue

      protected String defaultValue
      This value is assigned to the ObjKey.data element for a new Sord object.
      Since:
      7.00.040.016

    • tabIndex

      protected int tabIndex
      This value represents the number of the tab, this line has to appear on. The first tab's index value is 0. It is on the client's hand to set valid values when checking in document masks.
      Since:
      9.00.000.000

    • serverScriptName

      protected String serverScriptName
      A script or plugin at the server can serve as the data source of a dynamic keyword list. This value represents the name of that script or plugin. If the value is not empty, the client can request a list of available input values by calling the function IXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo). In case of a plugin, this value starts with the Bundle-SymbolicName and can be optionally appended by a path. E.g. serverScriptName="com.partner.dkeywords/invoice-solution". The path has to start with a forward slash and is passed to DynamicKeywordEventsFactory.create(de.elo.ix.client.IXServerEventsContext, java.lang.String).
      Since:
      9.00.000.001

    • inherit

      protected boolean inherit
      Inherit this keywording field to subordinated entries.

      This option is used to make sure, that all entries in an archive sub-tree have the same value for this keywording field. Thereby the field is identified by its group name (key and ObjKey.name).

      The option corresponds to inheritFromParent. As far as inheritFromParent is also true in the keywording forms definition of all sub-items, the option inherit effects the following:
      • The value of the keywording field can only be changed in the parent entry of the sub-tree. This is the uppermost entry that has the field, which means that the parent's parent does not have this field.
      • All sub-items of the parent inherit this value during a background process. The value is forwarded recursively to the entire sub-tree under the parent. The recursion stops at items that are assigned to a keywording form without this field.
      • When a child entry under the parent is updated, this field is always corrected to the parent's value.
      • For an object moved into a parent, the object and all sub-items inherit the keywording field.

      If inheritFromParent is false in the keywording form definition of a sub-item, inheritance stops for the sub-item. Thus, the index field is treated as a different field although it has the same group name.

      Since:
      9.00.016.011

    • inheritFromParent

      protected boolean inheritFromParent
      Do not inherit the parent's value.
      Since:
      9.00.030.019
      See Also:

    • nameTranslationKey

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

    • commentTranslationKey

      protected String commentTranslationKey
      Translation-keyword for comment.
      Since:
      9.00.018.005

    • valueArray

      protected boolean valueArray
      Allows multiple values for keywording tables. For keywording forms organized as tables, see DocMaskC.DATA_ORGANISATION_TABLE, index lines must be explicitly declared for storing multiple values. If this member is true, the index line is able to store an arbitrary number of values. For keywording forms organized as name-value pairs, see DocMaskC.DATA_ORGANISATION_OBJKEYS, index lines can store multiple values by default and this member has to be ignored.
      Since:
      9.00.039.001

    • validateExpression

      protected String validateExpression
      RegEx to validate user input for entry.
      Since:
      10.00.020.010

    • required

      protected boolean required
      Entry is required.
      Since:
      10.00.020.010

    • allowedMaskIdsForKeywordingRelation

      protected List<Integer> allowedMaskIdsForKeywordingRelation
      Specifies the DocMask.id allowed in a DocMaskLineC.TYPE_RELATION. Mandatory if DocMaskLine is of type DocMaskLineC.TYPE_RELATION. Only Sords with the specified DocMask.id can be referenced in this DocMaskLine.
      Since:
      12.00.000.023
      See Also:

  • Constructor Details

  • Method Details

    • getComment

      public String getComment()

    • setComment

      public void setComment(String comment)

    • getId

      public int getId()

    • setId

      public void setId(int id)

    • getKey

      public String getKey()

    • setKey

      public void setKey(String key)

    • getMaskId

      public int getMaskId()

    • setMaskId

      public void setMaskId(int maskId)

    • getMax

      public int getMax()

    • setMax

      public void setMax(int max)

    • getMin

      public int getMin()

    • setMin

      public void setMin(int min)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getAcl

      public String getAcl()

    • setAcl

      public void setAcl(String acl)

    • getAclItems

      public AclItem[] getAclItems()

    • setAclItems

      public void setAclItems(AclItem[] aclItems)

    • isCanEdit

      public boolean isCanEdit()

    • setCanEdit

      public void setCanEdit(boolean canEdit)

    • getEditCol

      public int getEditCol()

    • setEditCol

      public void setEditCol(int editCol)

    • getEditRow

      public int getEditRow()

    • setEditRow

      public void setEditRow(int editRow)

    • getEditWidth

      public int getEditWidth()

    • setEditWidth

      public void setEditWidth(int editWidth)

    • isHidden

      public boolean isHidden()

    • setHidden

      public void setHidden(boolean hidden)

    • getLabelCol

      public int getLabelCol()

    • setLabelCol

      public void setLabelCol(int labelCol)

    • getLabelRow

      public int getLabelRow()

    • setLabelRow

      public void setLabelRow(int labelRow)

    • isNextTab

      public boolean isNextTab()

    • setNextTab

      public void setNextTab(boolean nextTab)

    • isOnlyBuzzwords

      public boolean isOnlyBuzzwords()

    • setOnlyBuzzwords

      public void setOnlyBuzzwords(boolean onlyBuzzwords)

    • isPostfixAsterix

      public boolean isPostfixAsterix()

    • setPostfixAsterix

      public void setPostfixAsterix(boolean postfixAsterix)

    • isPrefixAsterix

      public boolean isPrefixAsterix()

    • setPrefixAsterix

      public void setPrefixAsterix(boolean prefixAsterix)

    • isReadOnly

      public boolean isReadOnly()

    • setReadOnly

      public void setReadOnly(boolean readOnly)

    • getTabOrder

      public int getTabOrder()

    • setTabOrder

      public void setTabOrder(int tabOrder)

    • getType

      public int getType()

    • setType

      public void setType(int type)

    • getExternalData

      public String getExternalData()

    • setExternalData

      public void setExternalData(String externalData)

    • isTranslate

      public boolean isTranslate()

    • setTranslate

      public void setTranslate(boolean translateValue)

    • isImportant

      public boolean isImportant()

    • setImportant

      public void setImportant(boolean important)

    • isNotTokenized

      public boolean isNotTokenized()

    • setNotTokenized

      public void setNotTokenized(boolean notTokenized)

    • isExcludeFromISearch

      public boolean isExcludeFromISearch()

    • setExcludeFromISearch

      public void setExcludeFromISearch(boolean excludeFromISearch)

    • isVersion

      public boolean isVersion()

    • setVersion

      public void setVersion(boolean version)

    • getAccess

      public int getAccess()

    • setAccess

      public void setAccess(int access)

    • isDisableWordWheel

      public boolean isDisableWordWheel()

    • setDisableWordWheel

      public void setDisableWordWheel(boolean disableWordWheel)

    • getDefaultValue

      public String getDefaultValue()

    • setDefaultValue

      public void setDefaultValue(String defaultValue)

    • getTabIndex

      public int getTabIndex()

    • setTabIndex

      public void setTabIndex(int tabIndex)

    • getServerScriptName

      public final String getServerScriptName()

    • setServerScriptName

      public final void setServerScriptName(String serverScriptName)

    • isInherit

      public boolean isInherit()

    • setInherit

      public void setInherit(boolean inherit)

    • getNameTranslationKey

      public String getNameTranslationKey()

    • setNameTranslationKey

      public void setNameTranslationKey(String nameTranslationKey)

    • getCommentTranslationKey

      public String getCommentTranslationKey()

    • setCommentTranslationKey

      public void setCommentTranslationKey(String commentTranslationKey)

    • isInheritFromParent

      public boolean isInheritFromParent()

    • setInheritFromParent

      public void setInheritFromParent(boolean inheritFromParent)

    • isValueArray

      public boolean isValueArray()

    • setValueArray

      public void setValueArray(boolean valueArray)

    • getValidateExpression

      public String getValidateExpression()

    • setValidateExpression

      public void setValidateExpression(String validateExpression)

    • isRequired

      public boolean isRequired()

    • setRequired

      public void setRequired(boolean required)

    • getAllowedMaskIdsForKeywordingRelation

      public List<Integer> getAllowedMaskIdsForKeywordingRelation()

    • setAllowedMaskIdsForKeywordingRelation

      public void setAllowedMaskIdsForKeywordingRelation(List<Integer> v)

    • toString

      public String toString()
      Overrides:
      toString in class Object