Package de.elo.ix.client

Class DocMaskLineTemplate

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

  • Field Details

    • TStamp

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

    • TStampSync

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

    • lockId

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

    • 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:

    • 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.

    • hidden

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

    • 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.

    • 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.

    • 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.

    • notTokenized

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

    • 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.

    • translate

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

    • acl

      protected String acl
      Access control for mask line.

    • 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.

    • defaultValue

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

    • serverScriptName

      protected String serverScriptName
      A script at the server can serve as the data source of a dynamic keyword list. This value represents the name of that script. If the value is not empty, the client can request a list of available input values by calling the function IXServicePortIF.checkoutKeywordsDynamic(ClientInfo, KeywordsDynamicInfo).

    • 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 (DocMaskLine.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.

    • inheritFromParent

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

    • nameTranslationKey

      protected String nameTranslationKey
      Translation-keyword for DocMaskLine.name.

    • commentTranslationKey

      protected String commentTranslationKey
      Translation-keyword for DocMaskLine.comment.

    • lockName

      protected String lockName
      Name of the user that has locked the mask line template. Read-only, ignored in checkinDocMaskLineTemplate.

    • 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.020

  • Constructor Details

    • DocMaskLineTemplate

      public DocMaskLineTemplate()

    • DocMaskLineTemplate

      public DocMaskLineTemplate(DocMaskLineTemplate rhs)

  • Method Details

    • getLockId

      public int getLockId()

    • setLockId

      public void setLockId(int lockId)

    • getTStamp

      public String getTStamp()

    • setTStamp

      public void setTStamp(String tStamp)

    • getTStampSync

      public String getTStampSync()

    • setTStampSync

      public void setTStampSync(String tStampSync)

    • 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)

    • 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)

    • getAclItems

      public AclItem[] getAclItems()

    • setAclItems

      public void setAclItems(AclItem[] aclItems)

    • isHidden

      public boolean isHidden()

    • setHidden

      public void setHidden(boolean hidden)

    • 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)

    • getType

      public int getType()

    • setType

      public void setType(int type)

    • getExternalData

      public String getExternalData()

    • setExternalData

      public void setExternalData(String externalData)

    • 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)

    • isTranslate

      public boolean isTranslate()

    • setTranslate

      public void setTranslate(boolean translate)

    • getAcl

      public String getAcl()

    • setAcl

      public void setAcl(String acl)

    • isDisableWordWheel

      public boolean isDisableWordWheel()

    • setDisableWordWheel

      public void setDisableWordWheel(boolean disableWordWheel)

    • getDefaultValue

      public String getDefaultValue()

    • setDefaultValue

      public void setDefaultValue(String defaultValue)

    • getServerScriptName

      public String getServerScriptName()

    • setServerScriptName

      public void setServerScriptName(String serverScriptName)

    • isInherit

      public boolean isInherit()

    • setInherit

      public void setInherit(boolean inherit)

    • isInheritFromParent

      public boolean isInheritFromParent()

    • setInheritFromParent

      public void setInheritFromParent(boolean inheritFromParent)

    • getNameTranslationKey

      public String getNameTranslationKey()

    • setNameTranslationKey

      public void setNameTranslationKey(String nameTranslationKey)

    • getCommentTranslationKey

      public String getCommentTranslationKey()

    • setCommentTranslationKey

      public void setCommentTranslationKey(String commentTranslationKey)

    • getLockName

      public String getLockName()

    • setLockName

      public void setLockName(String lockName)

    • 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> allowedDocMaskIds)

    • toString

      public String toString()
      Overrides:
      toString in class Object