|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectcom.sap.mdm.schema.FieldProperties
This class represents a MDM field.
CreateFieldCommand,
TableProperties| 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 |
public static final int INTEGER_FIELD
public static final int REAL4_FIELD
public static final int CURRENCY_FIELD
public static final int DATE_FIELD
public static final int TIME_FIELD
public static final int GM_TIME_FIELD
public static final int BOOLEAN_FIELD
public static final int FIXED_WIDTH_TEXT_FIELD
public static final int FLAT_LOOKUP_FIELD
public static final int HIER_LOOKUP_FIELD
public static final int TAXONOMY_LOOKUP_FIELD
public static final int FLAT_MULTIVALUE_LOOKUP_FIELD
public static final int TEXT_FIELD
public static final int MULTIVALUE_TEXT_FIELD
public static final int IMAGE_FIELD
public static final int MULTIVALUE_IMAGE_FIELD
public static final int SOUND_FIELD
public static final int MULTIVALUE_SOUND_FIELD
public static final int VIDEO_FIELD
public static final int MULTIVALUE_VIDEO_FIELD
public static final int EXTERNAL_OBJECT_FIELD
public static final int MULTIVALUE_EXTERNAL_OBJECT_FIELD
public static final int NAME_FIELD
public static final int MEASUREMENT_FIELD
public static final int TIMESTAMP_FIELD
public static final int NORMALIZED_TEXT_FIELD
public static final int HIER_MULTIVALUE_LOOKUP_FIELD
public static final int MASK_FIELD
public static final int PDF_OBJECT_FIELD
public static final int MULTIVALUE_PDF_OBJECT_FIELD
public static final int AUTOID_FIELD
public static final int LARGE_TEXT_FIELD
public static final int LOG_FIELD
public static final int MULTIVALUE_MEASUREMENT_FIELD
public static final int EXTERNAL_SOURCE_FIELD
public static final int HTML_OBJECT_FIELD
public static final int MULTIVALUE_HTML_OBJECT_FIELD
public static final int CRC_FIELD
public static final int QUALIFIED_FLAT_LOOKUP_FIELD
public static final int USERSTAMP_FIELD
public static final int CREATESTAMP_FIELD
public static final int COPY_BLOCK_FIELD
public static final int MULTIVALUE_COPY_BLOCK_FIELD
public static final int TUPLE_FIELD
public static final int MULTIVALUE_TUPLE_FIELD
public static final int MAIN_LOOKUP_FIELD
public static final int MULTIVALUE_MAIN_LOOKUP_FIELD
public static final int QUALIFIED_HIER_LOOKUP_FIELD
public static final int QUALIFIED_TAXONOMY_LOOKUP_FIELD
public static final int DATAID_FIELD
public static final int ORIGINAL_LOCATION_FIELD
public static final int DATAGROUP_FIELD
public static final int LAYOUT_HEIGHT_FIELD
public static final int ROTATION_TYPE_FIELD
public static final int CROP_TYPE_FIELD
public static final int TABLE_ID_FIELD
public static final int CODE_FIELD
public static final int KEYWORD_FIELD
public static final int INTERNAL_TREE_FIELD
public static final int WORKFLOW_FIELD
public static final int EXPRESSION_FIELD
public static final int RC_FIELD
| Constructor Detail |
public FieldProperties(int type)
type - the field type.public FieldProperties(FieldProperties other)
FieldProperties object.
other - Object to copy| Method Detail |
public int getType()
public FieldId getId()
public void setId(FieldId fieldId)
fieldId - the field ID.public TableId getTableId()
getContainerId()public void setTableId(TableId tableId)
tableId - the table ID.public Id getContainerId()
public void setContainerId(Id containerId)
containerId - an Idpublic String getCode()
NamedRepositoryItem
getCode in interface NamedRepositoryItempublic void setCode(String name)
name - the coding name.public MultilingualString getName()
public void setName(MultilingualString name)
name - the field name.public String getDescription()
public void setDescription(String description)
description - a field descriptionpublic boolean isModifyOnce()
True if the field can only be set once, otherwise false.public boolean isEditable()
True if the field is editable, otherwise false.public void setModifyOnce(boolean modifyOnce)
modifyOnce - whether the field value an only be set once.
The modifyOnce to set.public boolean isRequired()
public void setRequired(boolean required)
required - whether the field always require a field value.public boolean isQualifier()
public void setQualifier(boolean qualifier)
qualifier - whether the field is a qualifier field.public boolean isQualifierCached()
public void setQualifierCached(boolean qualifierCached)
qualifierCached - whether the qualifier field is cached.public boolean isLookup()
public boolean isSortable()
public boolean isSearchable()
isPicklistSearchable(); it wasn't clear what is meant by searchable.
public boolean isPicklistSearchable()
true if a pick list can be retrieve for this field, otherwise false.
true if a pick list can be retrieve for this field, otherwise falsepublic boolean isFreeFormSearchable()
public boolean isMultiValued()
public boolean isMultiLingual()
public void setMultiLingual(boolean isMultiLingual)
isMultiLingual - whether the field is a multi-lingual field.public boolean isTaxonomyLookup()
public boolean isHierarchyLookup()
public boolean isLargeObjectLookup()
public boolean isKeywordIndexable()
public boolean isQualified()
public boolean isTuple()
true if a tuple field, otherwise falsepublic String getTypeName()
public String toString()
public int hashCode()
public boolean equals(Object obj)
public boolean isCalculated()
public void setCalculated(boolean calculated)
calculated - whether the field is calculated based upon an expression.public boolean isShowInSearchTab()
public void setShowInSearchTab(boolean searchTab)
searchTab - whether the field should show in the search tab.public RecordId getCalculationId()
public void setCalculationId(RecordId calculationId)
calculationId - The calculationId to set.public int getPosition()
public void setPosition(int position)
position - a positionpublic int getSortIndex()
FieldSortIndexTypepublic void setSortIndex(int sortIndex)
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.
sortIndex - the sort indexFieldSortIndexTypepublic Object clone()
|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
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.