Package de.elo.ix.client

Class AspectLine

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.AspectLine
All Implemented Interfaces:
Serializable
public class AspectLine extends ValueClass implements Serializable
This class contains data for a line in a document mask, if DocMask.dataOrganisation = DocMaskC.DATA_ORGANISATION_ASPECT. AspectLines are contained in keywording Aspects.
Since:
20.00.000.100
See Also:

  • Field Details

    • aspectId

      protected int aspectId
      This line information belongs to an aspect with the ID AspectId.

    • type

      protected int type
      The type of the line information.
      This can be one of the AspectLineC.TYPE_* constants but none of the DocMaskLineC.TYPE_* constants.

    • displayName

      protected String displayName
      The display 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:

    • key

      protected String key
      The attribute identifier.

    • externalData

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

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

    • defaultValue

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

    • nameTranslationKey

      protected String nameTranslationKey
      Translation-keyword for displayName.

    • allowedMaskIdsForKeywordingRelation

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

    • postfixAsterix

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

    • prefixAsterix

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

    • important

      protected boolean important
      Display index value next to the objects short description. This element has to be interpreted by the client application. Further it is used while generating dynamic keywords.

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

    • translate

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

    • dynamicKeywordReference

      protected String dynamicKeywordReference
      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:
      21.00.000.004

    • subType

      protected String subType
      This field can be used by clients to determine a subtype of the given type. For the purpose of properly displaying a value there are subtypes defined at client side.
      The server does not evaluate the subtype.
      Since:
      21.00.000.008

    • comment

      protected String comment
      Quickinfo text for the attribute.
      Since:
      21.00.000.012

    • commentTranslationKey

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

    • keywordListId

      protected String keywordListId
      Keyword List ID.
      Since:
      21.03.000.002

    • canBeFoundViaKeywordingRelation

      protected boolean canBeFoundViaKeywordingRelation
      If the sord is referenced by keywording-relation, this flag must be true if this index value should be available for search in iSearch within the referencing sord.
      Since:
      21.00.000.019

  • Constructor Details

    • AspectLine

      public AspectLine()

    • AspectLine

      public AspectLine(AspectLine rhs)

  • Method Details

    • getAspectId

      public int getAspectId()

    • setAspectId

      public void setAspectId(int aspectId)

    • getType

      public int getType()

    • setType

      public void setType(int type)

    • getDisplayName

      public String getDisplayName()

    • setDisplayName

      public void setDisplayName(String displayName)

    • getKey

      public String getKey()

    • setKey

      public void setKey(String key)

    • getExternalData

      public String getExternalData()

    • setExternalData

      public void setExternalData(String externalData)

    • getAccess

      public int getAccess()

    • setAccess

      public void setAccess(int access)

    • getDefaultValue

      public String getDefaultValue()

    • setDefaultValue

      public void setDefaultValue(String defaultValue)

    • getNameTranslationKey

      public String getNameTranslationKey()

    • setNameTranslationKey

      public void setNameTranslationKey(String nameTranslationKey)

    • getAllowedMaskIdsForKeywordingRelation

      public List<Integer> getAllowedMaskIdsForKeywordingRelation()

    • setAllowedMaskIdsForKeywordingRelation

      public void setAllowedMaskIdsForKeywordingRelation(List<Integer> v)

    • isPostfixAsterix

      public boolean isPostfixAsterix()

    • setPostfixAsterix

      public void setPostfixAsterix(boolean postfixAsterix)

    • isPrefixAsterix

      public boolean isPrefixAsterix()

    • setPrefixAsterix

      public void setPrefixAsterix(boolean prefixAsterix)

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

    • isTranslate

      public boolean isTranslate()

    • setTranslate

      public void setTranslate(boolean translateValue)

    • getDynamicKeywordReference

      public String getDynamicKeywordReference()

    • setDynamicKeywordReference

      public void setDynamicKeywordReference(String dynamicKeywordReference)

    • getSubType

      public String getSubType()

    • setSubType

      public void setSubType(String subType)

    • getComment

      public String getComment()

    • setComment

      public void setComment(String comment)

    • getCommentTranslationKey

      public String getCommentTranslationKey()

    • setCommentTranslationKey

      public void setCommentTranslationKey(String commentTranslationKey)

    • canBeFoundViaKeywordingRelation

      public boolean canBeFoundViaKeywordingRelation()

    • setCanBeFoundViaKeywordingRelation

      public void setCanBeFoundViaKeywordingRelation(boolean canBeFoundViaKeywordingRelation)

    • getKeywordListId

      public String getKeywordListId()

    • setKeywordListId

      public void setKeywordListId(String keywordListId)

    • toString

      public String toString()
      Overrides:
      toString in class Object