com.sap.mdm.schema
Class FieldProperties

java.lang.Object
  extended bycom.sap.mdm.schema.FieldProperties
All Implemented Interfaces:
Cloneable, NamedRepositoryItem, RepositoryItem
Direct Known Subclasses:
AutoIdFieldProperties, BooleanFieldProperties, CodeFieldProperties, CrcFieldProperties, CreateStampFieldProperties, CropFieldProperties, CurrencyFieldProperties, DataGroupFieldProperties, DataLocationFieldProperties, ExpressionFieldProperties, FixedWidthTextFieldProperties, GMTimeFieldProperties, ImageFormatFieldProperties, IntegerFieldProperties, LargeTextFieldProperties, LayoutHeightFieldProperties, LiteralDateFieldProperties, LiteralTimeFieldProperties, LogFieldProperties, LookupFieldProperties, MaskFieldProperties, MeasurementFieldProperties, NameFieldProperties, NormalizedTextFieldProperties, RealFieldProperties, RotationFieldProperties, TableIdFieldProperties, TimeStampFieldProperties, TupleFieldProperties, UserStampFieldProperties

public class FieldProperties
extends Object
implements NamedRepositoryItem

This class represents a MDM field.

See Also:
CreateFieldCommand, TableProperties

Field Summary
static int AUTOID_FIELD
           
static int BOOLEAN_FIELD
           
static int CODE_FIELD
           
static int COPY_BLOCK_FIELD
           
static int CRC_FIELD
           
static int CREATESTAMP_FIELD
           
static int CROP_TYPE_FIELD
           
static int CURRENCY_FIELD
           
static int DATAGROUP_FIELD
           
static int DATAID_FIELD
           
static int DATE_FIELD
           
static int EXPRESSION_FIELD
           
static int EXTERNAL_OBJECT_FIELD
           
static int EXTERNAL_SOURCE_FIELD
           
static int FIXED_WIDTH_TEXT_FIELD
           
static int FLAT_LOOKUP_FIELD
           
static int FLAT_MULTIVALUE_LOOKUP_FIELD
           
static int GM_TIME_FIELD
           
static int HIER_LOOKUP_FIELD
           
static int HIER_MULTIVALUE_LOOKUP_FIELD
           
static int HTML_OBJECT_FIELD
           
static int IMAGE_FIELD
           
static int INTEGER_FIELD
           
static int INTERNAL_TREE_FIELD
           
static int KEYWORD_FIELD
           
static int LARGE_TEXT_FIELD
           
static int LAYOUT_HEIGHT_FIELD
           
static int LOG_FIELD
           
static int MAIN_LOOKUP_FIELD
           
static int MASK_FIELD
           
static int MEASUREMENT_FIELD
           
static int MULTIVALUE_COPY_BLOCK_FIELD
           
static int MULTIVALUE_EXTERNAL_OBJECT_FIELD
           
static int MULTIVALUE_HTML_OBJECT_FIELD
           
static int MULTIVALUE_IMAGE_FIELD
           
static int MULTIVALUE_MAIN_LOOKUP_FIELD
           
static int MULTIVALUE_MEASUREMENT_FIELD
           
static int MULTIVALUE_PDF_OBJECT_FIELD
           
static int MULTIVALUE_SOUND_FIELD
           
static int MULTIVALUE_TEXT_FIELD
           
static int MULTIVALUE_TUPLE_FIELD
           
static int MULTIVALUE_VIDEO_FIELD
           
static int NAME_FIELD
           
static int NORMALIZED_TEXT_FIELD
           
static int ORIGINAL_LOCATION_FIELD
           
static int PDF_OBJECT_FIELD
           
static int QUALIFIED_FLAT_LOOKUP_FIELD
           
static int QUALIFIED_HIER_LOOKUP_FIELD
          Deprecated. It was never supported.
static int QUALIFIED_TAXONOMY_LOOKUP_FIELD
          Deprecated. It was never supported.
static int RC_FIELD
           
static int REAL4_FIELD
           
static int ROTATION_TYPE_FIELD
           
static int SOUND_FIELD
           
static int TABLE_ID_FIELD
           
static int TAXONOMY_LOOKUP_FIELD
           
static int TEXT_FIELD
           
static int TIME_FIELD
           
static int TIMESTAMP_FIELD
           
static int TUPLE_FIELD
           
static int USERSTAMP_FIELD
           
static int VIDEO_FIELD
           
static int WORKFLOW_FIELD
           
 
Constructor Summary
FieldProperties(FieldProperties other)
          Copy c'tor.
FieldProperties(int type)
          Creates a new instance of FieldProperties.
 
Method Summary
 Object clone()
           
 boolean equals(Object obj)
           
 RecordId getCalculationId()
           
 String getCode()
          Returns a string identifier for a named repository object.
 Id getContainerId()
          Returns the container the field belongs to.
 String getDescription()
          Returns the field description.
 FieldId getId()
          Get field ID
 MultilingualString getName()
          Returns the field name.
 int getPosition()
          Returns the position of the field in the table.
 int getSortIndex()
          Returns the sort index.
 TableId getTableId()
          Returns the table ID the field belongs to.
 int getType()
          Returns the field type.
 String getTypeName()
          Returns the field type as a string.
 int hashCode()
           
 boolean isCalculated()
          Returns whether the field is calculated based upon an expression.
 boolean isEditable()
          Returns whether the field value is editable
 boolean isFreeFormSearchable()
          Returns whether the field is free-form searchable.
 boolean isHierarchyLookup()
          Returns whether the field is a hierarchy lookup field.
 boolean isKeywordIndexable()
          Returns whether the field is keyword indexed.
 boolean isLargeObjectLookup()
          Returns whether the field is a large object lookup field.
 boolean isLookup()
          Returns whether the field is a lookup field.
 boolean isModifyOnce()
          Returns whether the field value can only be set once.
 boolean isMultiLingual()
          Returns whether the field is a multi-lingual field.
 boolean isMultiValued()
          Returns whether the field is a multi-valued field.
 boolean isPicklistSearchable()
          Returns true if a pick list can be retrieve for this field, otherwise false.
 boolean isQualified()
          Returns whether the field is a qualified field.
 boolean isQualifier()
          Returns whether the field is a qualifier field.
 boolean isQualifierCached()
          Returns whether the qualifier field is cached.
 boolean isRequired()
          Returns whether the field always require a field value.
 boolean isSearchable()
          Deprecated. replaced by isPicklistSearchable(); it wasn't clear what is meant by searchable.
 boolean isShowInSearchTab()
          Returns whether the field should show in the search tab.
 boolean isSortable()
          Returns whether the field is a sortable field.
 boolean isTaxonomyLookup()
          Returns whether the field is a taxonomy lookup field.
 boolean isTuple()
          Returns whether the field is a tuple field.
 void setCalculated(boolean calculated)
          Deprecated. It never did work and it's not possible to support it at the current time.
 void setCalculationId(RecordId calculationId)
          Deprecated. It never did work and it's not possible to support it at the current time.
 void setCode(String name)
          Sets the field code name.
 void setContainerId(Id containerId)
          Sets the container the field belongs to.
 void setDescription(String description)
          Sets the field description.
 void setId(FieldId fieldId)
          For internal use only.
 void setModifyOnce(boolean modifyOnce)
          Sets whether the field value can only be set once.
 void setMultiLingual(boolean isMultiLingual)
          Deprecated. use the same method from derived class instead, for example, FixedWidthTextFieldProperties
 void setName(MultilingualString name)
          Sets the field name.
 void setPosition(int position)
          Sets the position of the field in the table.
 void setQualifier(boolean qualifier)
          Sets whether the field is a qualifier field.
 void setQualifierCached(boolean qualifierCached)
          Sets whether the qualifier field is cached.
 void setRequired(boolean required)
          Sets whether the field always require a field value.
 void setShowInSearchTab(boolean searchTab)
          Sets whether the field should show in the search tab.
 void setSortIndex(int sortIndex)
          Sets the sort index.
 void setTableId(TableId tableId)
          Sets the table ID the field belongs to.
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

INTEGER_FIELD

public static final int INTEGER_FIELD
See Also:
Constant Field Values

REAL4_FIELD

public static final int REAL4_FIELD
See Also:
Constant Field Values

CURRENCY_FIELD

public static final int CURRENCY_FIELD
See Also:
Constant Field Values

DATE_FIELD

public static final int DATE_FIELD
See Also:
Constant Field Values

TIME_FIELD

public static final int TIME_FIELD
See Also:
Constant Field Values

GM_TIME_FIELD

public static final int GM_TIME_FIELD
See Also:
Constant Field Values

BOOLEAN_FIELD

public static final int BOOLEAN_FIELD
See Also:
Constant Field Values

FIXED_WIDTH_TEXT_FIELD

public static final int FIXED_WIDTH_TEXT_FIELD
See Also:
Constant Field Values

FLAT_LOOKUP_FIELD

public static final int FLAT_LOOKUP_FIELD
See Also:
Constant Field Values

HIER_LOOKUP_FIELD

public static final int HIER_LOOKUP_FIELD
See Also:
Constant Field Values

TAXONOMY_LOOKUP_FIELD

public static final int TAXONOMY_LOOKUP_FIELD
See Also:
Constant Field Values

FLAT_MULTIVALUE_LOOKUP_FIELD

public static final int FLAT_MULTIVALUE_LOOKUP_FIELD
See Also:
Constant Field Values

TEXT_FIELD

public static final int TEXT_FIELD
See Also:
Constant Field Values

MULTIVALUE_TEXT_FIELD

public static final int MULTIVALUE_TEXT_FIELD
See Also:
Constant Field Values

IMAGE_FIELD

public static final int IMAGE_FIELD
See Also:
Constant Field Values

MULTIVALUE_IMAGE_FIELD

public static final int MULTIVALUE_IMAGE_FIELD
See Also:
Constant Field Values

SOUND_FIELD

public static final int SOUND_FIELD
See Also:
Constant Field Values

MULTIVALUE_SOUND_FIELD

public static final int MULTIVALUE_SOUND_FIELD
See Also:
Constant Field Values

VIDEO_FIELD

public static final int VIDEO_FIELD
See Also:
Constant Field Values

MULTIVALUE_VIDEO_FIELD

public static final int MULTIVALUE_VIDEO_FIELD
See Also:
Constant Field Values

EXTERNAL_OBJECT_FIELD

public static final int EXTERNAL_OBJECT_FIELD
See Also:
Constant Field Values

MULTIVALUE_EXTERNAL_OBJECT_FIELD

public static final int MULTIVALUE_EXTERNAL_OBJECT_FIELD
See Also:
Constant Field Values

NAME_FIELD

public static final int NAME_FIELD
See Also:
Constant Field Values

MEASUREMENT_FIELD

public static final int MEASUREMENT_FIELD
See Also:
Constant Field Values

TIMESTAMP_FIELD

public static final int TIMESTAMP_FIELD
See Also:
Constant Field Values

NORMALIZED_TEXT_FIELD

public static final int NORMALIZED_TEXT_FIELD
See Also:
Constant Field Values

HIER_MULTIVALUE_LOOKUP_FIELD

public static final int HIER_MULTIVALUE_LOOKUP_FIELD
See Also:
Constant Field Values

MASK_FIELD

public static final int MASK_FIELD
See Also:
Constant Field Values

PDF_OBJECT_FIELD

public static final int PDF_OBJECT_FIELD
See Also:
Constant Field Values

MULTIVALUE_PDF_OBJECT_FIELD

public static final int MULTIVALUE_PDF_OBJECT_FIELD
See Also:
Constant Field Values

AUTOID_FIELD

public static final int AUTOID_FIELD
See Also:
Constant Field Values

LARGE_TEXT_FIELD

public static final int LARGE_TEXT_FIELD
See Also:
Constant Field Values

LOG_FIELD

public static final int LOG_FIELD
See Also:
Constant Field Values

MULTIVALUE_MEASUREMENT_FIELD

public static final int MULTIVALUE_MEASUREMENT_FIELD
See Also:
Constant Field Values

EXTERNAL_SOURCE_FIELD

public static final int EXTERNAL_SOURCE_FIELD
See Also:
Constant Field Values

HTML_OBJECT_FIELD

public static final int HTML_OBJECT_FIELD
See Also:
Constant Field Values

MULTIVALUE_HTML_OBJECT_FIELD

public static final int MULTIVALUE_HTML_OBJECT_FIELD
See Also:
Constant Field Values

CRC_FIELD

public static final int CRC_FIELD
See Also:
Constant Field Values

QUALIFIED_FLAT_LOOKUP_FIELD

public static final int QUALIFIED_FLAT_LOOKUP_FIELD
See Also:
Constant Field Values

USERSTAMP_FIELD

public static final int USERSTAMP_FIELD
See Also:
Constant Field Values

CREATESTAMP_FIELD

public static final int CREATESTAMP_FIELD
See Also:
Constant Field Values

COPY_BLOCK_FIELD

public static final int COPY_BLOCK_FIELD
Since:
7.1
See Also:
Constant Field Values

MULTIVALUE_COPY_BLOCK_FIELD

public static final int MULTIVALUE_COPY_BLOCK_FIELD
Since:
7.1
See Also:
Constant Field Values

TUPLE_FIELD

public static final int TUPLE_FIELD
Since:
7.1
See Also:
Constant Field Values

MULTIVALUE_TUPLE_FIELD

public static final int MULTIVALUE_TUPLE_FIELD
Since:
7.1
See Also:
Constant Field Values

MAIN_LOOKUP_FIELD

public static final int MAIN_LOOKUP_FIELD
Since:
7.1
See Also:
Constant Field Values

MULTIVALUE_MAIN_LOOKUP_FIELD

public static final int MULTIVALUE_MAIN_LOOKUP_FIELD
Since:
7.1
See Also:
Constant Field Values

QUALIFIED_HIER_LOOKUP_FIELD

public static final int QUALIFIED_HIER_LOOKUP_FIELD
Deprecated. It was never supported.

See Also:
Constant Field Values

QUALIFIED_TAXONOMY_LOOKUP_FIELD

public static final int QUALIFIED_TAXONOMY_LOOKUP_FIELD
Deprecated. It was never supported.

See Also:
Constant Field Values

DATAID_FIELD

public static final int DATAID_FIELD
See Also:
Constant Field Values

ORIGINAL_LOCATION_FIELD

public static final int ORIGINAL_LOCATION_FIELD
See Also:
Constant Field Values

DATAGROUP_FIELD

public static final int DATAGROUP_FIELD
See Also:
Constant Field Values

LAYOUT_HEIGHT_FIELD

public static final int LAYOUT_HEIGHT_FIELD
See Also:
Constant Field Values

ROTATION_TYPE_FIELD

public static final int ROTATION_TYPE_FIELD
See Also:
Constant Field Values

CROP_TYPE_FIELD

public static final int CROP_TYPE_FIELD
See Also:
Constant Field Values

TABLE_ID_FIELD

public static final int TABLE_ID_FIELD
See Also:
Constant Field Values

CODE_FIELD

public static final int CODE_FIELD
See Also:
Constant Field Values

KEYWORD_FIELD

public static final int KEYWORD_FIELD
See Also:
Constant Field Values

INTERNAL_TREE_FIELD

public static final int INTERNAL_TREE_FIELD
See Also:
Constant Field Values

WORKFLOW_FIELD

public static final int WORKFLOW_FIELD
See Also:
Constant Field Values

EXPRESSION_FIELD

public static final int EXPRESSION_FIELD
See Also:
Constant Field Values

RC_FIELD

public static final int RC_FIELD
See Also:
Constant Field Values
Constructor Detail

FieldProperties

public FieldProperties(int type)
Creates a new instance of FieldProperties.

Parameters:
type - the field type.

FieldProperties

public FieldProperties(FieldProperties other)
Copy c'tor. Create deep copy of FieldProperties object.

Parameters:
other - Object to copy
Since:
7.2
Method Detail

getType

public int getType()
Returns the field type.

Returns:
the field type.

getId

public FieldId getId()
Get field ID

Returns:
field ID

setId

public void setId(FieldId fieldId)
For internal use only. Sets the field ID.

Parameters:
fieldId - the field ID.

getTableId

public TableId getTableId()
Returns the table ID the field belongs to.

Returns:
the table ID.
See Also:
getContainerId()

setTableId

public void setTableId(TableId tableId)
Sets the table ID the field belongs to.

Parameters:
tableId - the table ID.

getContainerId

public Id getContainerId()
Returns the container the field belongs to.

Returns:
a Id
Since:
7.1

setContainerId

public void setContainerId(Id containerId)
Sets the container the field belongs to.

Parameters:
containerId - an Id
Since:
7.1

getCode

public String getCode()
Description copied from interface: NamedRepositoryItem
Returns a string identifier for a named repository object.

Specified by:
getCode in interface NamedRepositoryItem
Returns:
the code name

setCode

public void setCode(String name)
Sets the field code name.

Parameters:
name - the coding name.

getName

public MultilingualString getName()
Returns the field name.

Returns:
the field name.

setName

public void setName(MultilingualString name)
Sets the field name.

Parameters:
name - the field name.

getDescription

public String getDescription()
Returns the field description.

Returns:
a field description

setDescription

public void setDescription(String description)
Sets the field description.

Parameters:
description - a field description

isModifyOnce

public boolean isModifyOnce()
Returns whether the field value can only be set once.

Returns:
True if the field can only be set once, otherwise false.

isEditable

public boolean isEditable()
Returns whether the field value is editable

Returns:
True if the field is editable, otherwise false.

setModifyOnce

public void setModifyOnce(boolean modifyOnce)
Sets whether the field value can only be set once.

Parameters:
modifyOnce - whether the field value an only be set once. The modifyOnce to set.

isRequired

public boolean isRequired()
Returns whether the field always require a field value.

Returns:
whether the field always require a field value.

setRequired

public void setRequired(boolean required)
Sets whether the field always require a field value.

Parameters:
required - whether the field always require a field value.

isQualifier

public boolean isQualifier()
Returns whether the field is a qualifier field.

Returns:
whether the field is a qualifier field.

setQualifier

public void setQualifier(boolean qualifier)
Sets whether the field is a qualifier field.

Parameters:
qualifier - whether the field is a qualifier field.

isQualifierCached

public boolean isQualifierCached()
Returns whether the qualifier field is cached.

Returns:
whether the qualifier field is cached.

setQualifierCached

public void setQualifierCached(boolean qualifierCached)
Sets whether the qualifier field is cached.

Parameters:
qualifierCached - whether the qualifier field is cached.

isLookup

public boolean isLookup()
Returns whether the field is a lookup field.

Returns:
whether the field is a lookup field.

isSortable

public boolean isSortable()
Returns whether the field is a sortable field.

Returns:
whether the field is a sortable field.

isSearchable

public boolean isSearchable()
Deprecated. replaced by isPicklistSearchable(); it wasn't clear what is meant by searchable.

Returns whether the field is a searchable field.

Returns:
whether the field is a searchable field.

isPicklistSearchable

public boolean isPicklistSearchable()
Returns true if a pick list can be retrieve for this field, otherwise false.

Returns:
true if a pick list can be retrieve for this field, otherwise false
Since:
5.5 SP 6 Patch 04

isFreeFormSearchable

public boolean isFreeFormSearchable()
Returns whether the field is free-form searchable.

Returns:
whether the field is free-form searchable.

isMultiValued

public boolean isMultiValued()
Returns whether the field is a multi-valued field.

Returns:
whether the field is a multi-valued field.

isMultiLingual

public boolean isMultiLingual()
Returns whether the field is a multi-lingual field.

Returns:
whether the field is a multi-lingual field.

setMultiLingual

public void setMultiLingual(boolean isMultiLingual)
Deprecated. use the same method from derived class instead, for example, FixedWidthTextFieldProperties

Set whether the field is a multi-lingual field.

Parameters:
isMultiLingual - whether the field is a multi-lingual field.

isTaxonomyLookup

public boolean isTaxonomyLookup()
Returns whether the field is a taxonomy lookup field.

Returns:
whether the field is a taxonomy lookup field.

isHierarchyLookup

public boolean isHierarchyLookup()
Returns whether the field is a hierarchy lookup field.

Returns:
whether the field is a hierarchy lookup field.

isLargeObjectLookup

public boolean isLargeObjectLookup()
Returns whether the field is a large object lookup field.

Returns:
whether the field is a large object lookup field.

isKeywordIndexable

public boolean isKeywordIndexable()
Returns whether the field is keyword indexed.

Returns:
whether the field is keyword indexed.

isQualified

public boolean isQualified()
Returns whether the field is a qualified field.

Returns:
whether the field is a qualified field.

isTuple

public boolean isTuple()
Returns whether the field is a tuple field.

Returns:
true if a tuple field, otherwise false
Since:
7.1

getTypeName

public String getTypeName()
Returns the field type as a string.

Returns:
the field type.

toString

public String toString()

hashCode

public int hashCode()

equals

public boolean equals(Object obj)

isCalculated

public boolean isCalculated()
Returns whether the field is calculated based upon an expression.

Returns:
whether the field is calculated based upon an expression.

setCalculated

public void setCalculated(boolean calculated)
Deprecated. It never did work and it's not possible to support it at the current time.

Sets whether the field is calculated based upon an expression.

Parameters:
calculated - whether the field is calculated based upon an expression.

isShowInSearchTab

public boolean isShowInSearchTab()
Returns whether the field should show in the search tab.

Returns:
whether the field should show in the search tab.

setShowInSearchTab

public void setShowInSearchTab(boolean searchTab)
Sets whether the field should show in the search tab.

Parameters:
searchTab - whether the field should show in the search tab.

getCalculationId

public RecordId getCalculationId()
Returns:
Returns the calculationId.

setCalculationId

public void setCalculationId(RecordId calculationId)
Deprecated. It never did work and it's not possible to support it at the current time.

Parameters:
calculationId - The calculationId to set.

getPosition

public int getPosition()
Returns the position of the field in the table.

Returns:
a position

setPosition

public void setPosition(int position)
Sets the position of the field in the table. The position is assign by the MDM server.

Parameters:
position - a position

getSortIndex

public int getSortIndex()
Returns the sort index.

Returns:
the sort index
Since:
5.5 SP6 Patch 05, 7.1
See Also:
FieldSortIndexType

setSortIndex

public void setSortIndex(int sortIndex)
Sets the sort index.

The sort index field property makes a field sortable. It accelerates free-form search for the equals and starts with text operators, and for the =, <, <=, >, and >= numeric operators. It also greatly improves matching speed on equals matches in Record Matching.

However, MDM spends extra memory and processing to maintain the sort index, which can dramatically slow down updates and imports on larger repositories. To improve system performance – or if you don’t think you will need to sort on a particular field – do not make it sortable.

Parameters:
sortIndex - the sort index
Since:
5.5 SP6 Patch 05, 7.1
See Also:
FieldSortIndexType

clone

public Object clone()


Copyright 2004-2007 by SAP AG. All Rights Reserved.

SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies (SAP Group) for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.