Package com.saperion.ws.wrapper

Class SaWsFieldDescription

  • public class SaWsFieldDescription
extends java.lang.Object
    This class wraps the SaFieldDescription class.
    Author:
    Daniel Manzke

    • Constructor Summary

      Constructors 
      Constructor Description
      SaWsFieldDescription()
      Creates a new instance of SaWsFieldDescription.
      SaWsFieldDescription​(com.saperion.intf.SaFieldDescription desc)
      Creates a new instance of SaWsFieldDescription and wraps the original.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDbName()
      Reads the real database name of this field.
      int getFieldType()
      Reads the fieldtype.
      int getLength()
      Reads the length if this field.
      java.lang.String getLookupTableDef()
      Reads the definition of lookup table.
      java.lang.String getLookupTableField()
      Reads the field in the lookup table.
      java.lang.String getMultiValueSeparators()
      Reads the multivalue separators.
      java.lang.String getName()
      Reads the name of this field.
      boolean isHasLookupTable()
      Test, if this field has a lookup table.
      boolean isIndex()
      Tests, if this field is an index field.
      boolean isLookupTableIsDirect()
      Reads the value for lookupTableIsDirect.
      boolean isMandatory()
      Checks, if this field is mandatory.
      boolean isMultiValue()
      Checks, if this field is multivalued.
      boolean isNonSystemField()
      Checks whether this object's name is a non-system DDC field name.
      boolean isStringFieldType()
      Checks if this object is a string type.
      boolean isUnique()
      Checks, if this field is unique.
      void setDbName​(java.lang.String dbname)
      Sets the real database name of this field.
      void setFieldType​(int ftype)
      Sets the fieldtype.
      void setHasLookupTable​(boolean bHasLookupTable)
      Sets, if this field has a lookup table.
      void setIndex​(boolean isIndex)
      Sets, if this field is an index field.
      void setLength​(int iLength)
      Sets the length if this field.
      void setLookupTableDef​(java.lang.String def)
      Sets the definition of lookup table.
      void setLookupTableField​(java.lang.String field)
      Sets the field in the lookup table.
      void setLookupTableIsDirect​(boolean isDirect)
      Sets the value for lookupTableIsDirect.
      void setMandatory​(boolean isMandatory)
      Sets, if this field is mandatory.
      void setMultiValue​(boolean isMultiValue)
      Sets, if this field is multivalued.
      void setMultiValueSeparators​(java.lang.String separators)
      Sets the multivalue separators.
      void setName​(java.lang.String sName)
      Sets the name of this field.
      void setNonSystemField​(boolean isNonSystemField)
      Sets his object's name is a non-system DDC field name.
      void setStringFieldType​(boolean isStringFieldType)
      Sets if this object is a string type.
      void setUnique​(boolean isUnique)
      Sets, if this field is unique.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SaWsFieldDescription

        public SaWsFieldDescription()
        Creates a new instance of SaWsFieldDescription.

      • SaWsFieldDescription

        public SaWsFieldDescription​(com.saperion.intf.SaFieldDescription desc)
        Creates a new instance of SaWsFieldDescription and wraps the original.
        Parameters:
        desc - Field description

    • Method Detail

      • isHasLookupTable

        public boolean isHasLookupTable()
        Test, if this field has a lookup table.
        Returns:
        Returns the hasLookupTable.

      • setHasLookupTable

        public void setHasLookupTable​(boolean bHasLookupTable)
        Sets, if this field has a lookup table.
        Parameters:
        bHasLookupTable - Has lookup table

      • isMandatory

        public boolean isMandatory()
        Checks, if this field is mandatory.
        Returns:
        Returns the isMandatory.

      • setMandatory

        public void setMandatory​(boolean isMandatory)
        Sets, if this field is mandatory.
        Parameters:
        isMandatory - Is mandatory

      • isIndex

        public boolean isIndex()
        Tests, if this field is an index field.
        Returns:
        Returns the isIndex.

      • setIndex

        public void setIndex​(boolean isIndex)
        Sets, if this field is an index field.
        Parameters:
        isIndex - Is index field

      • isMultiValue

        public boolean isMultiValue()
        Checks, if this field is multivalued.
        Returns:
        Returns the isMultiValue.

      • setMultiValue

        public void setMultiValue​(boolean isMultiValue)
        Sets, if this field is multivalued.
        Parameters:
        isMultiValue - Is multivalue

      • isUnique

        public boolean isUnique()
        Checks, if this field is unique.
        Returns:
        Returns the isUnique.

      • setUnique

        public void setUnique​(boolean isUnique)
        Sets, if this field is unique.
        Parameters:
        isUnique - Is unique

      • getLength

        public int getLength()
        Reads the length if this field.
        Returns:
        Returns the length.

      • setLength

        public void setLength​(int iLength)
        Sets the length if this field.
        Parameters:
        iLength - Field length

      • getLookupTableDef

        public java.lang.String getLookupTableDef()
        Reads the definition of lookup table.
        Returns:
        Returns the lookupTableDef.

      • setLookupTableDef

        public void setLookupTableDef​(java.lang.String def)
        Sets the definition of lookup table.
        Parameters:
        def - Lookup table definition

      • getLookupTableField

        public java.lang.String getLookupTableField()
        Reads the field in the lookup table.
        Returns:
        Returns the lookupTableField.

      • setLookupTableField

        public void setLookupTableField​(java.lang.String field)
        Sets the field in the lookup table.
        Parameters:
        field - Lookup field

      • isLookupTableIsDirect

        public boolean isLookupTableIsDirect()
        Reads the value for lookupTableIsDirect.
        Returns:
        Returns the lookupTableIsDirect.

      • setLookupTableIsDirect

        public void setLookupTableIsDirect​(boolean isDirect)
        Sets the value for lookupTableIsDirect.
        Parameters:
        isDirect - Lookup is direct

      • getMultiValueSeparators

        public java.lang.String getMultiValueSeparators()
        Reads the multivalue separators.
        Returns:
        Returns the multiValueSeparators.

      • setMultiValueSeparators

        public void setMultiValueSeparators​(java.lang.String separators)
        Sets the multivalue separators.
        Parameters:
        separators - Multivalue separators

      • getName

        public java.lang.String getName()
        Reads the name of this field.
        Returns:
        Returns the name.

      • setName

        public void setName​(java.lang.String sName)
        Sets the name of this field.
        Parameters:
        sName - Field name

      • getDbName

        public java.lang.String getDbName()
        Reads the real database name of this field.
        Returns:
        the dbName

      • setDbName

        public void setDbName​(java.lang.String dbname)
        Sets the real database name of this field.
        Parameters:
        dbname - Database name

      • getFieldType

        public int getFieldType()
        Reads the fieldtype.
        Returns:
        Returns the fieldType.

      • setFieldType

        public void setFieldType​(int ftype)
        Sets the fieldtype.
        Parameters:
        ftype - Field type

      • isNonSystemField

        public boolean isNonSystemField()
        Checks whether this object's name is a non-system DDC field name.
        Returns:
        True if name denotes a non-system field

      • setNonSystemField

        public void setNonSystemField​(boolean isNonSystemField)
        Sets his object's name is a non-system DDC field name.
        Parameters:
        isNonSystemField - Is non system field

      • isStringFieldType

        public boolean isStringFieldType()
        Checks if this object is a string type.
        Returns:
        True if fieldType is a string type

      • setStringFieldType

        public void setStringFieldType​(boolean isStringFieldType)
        Sets if this object is a string type.
        Parameters:
        isStringFieldType - Is string field