com.sap.mdm.schema
Class TextAttributeProperties

java.lang.Object
  extended bycom.sap.mdm.schema.AbstractAttributeProperties
      extended bycom.sap.mdm.schema.TextAttributeProperties
All Implemented Interfaces:
AttributeProperties, Cloneable, NamedRepositoryItem, RepositoryItem

public class TextAttributeProperties
extends AbstractAttributeProperties

Defines a text attribute. A text attribute is define as a list of discrete values, such as red, blue and white.


Field Summary
 
Fields inherited from interface com.sap.mdm.schema.AttributeProperties
COUPLED_TYPE, INVALID_TYPE, NUMERIC_TYPE, TEXT_TYPE
 
Constructor Summary
TextAttributeProperties()
          Empty constructor
TextAttributeProperties(AttributeId id)
          Constructor with the specified attribute Id.
TextAttributeProperties(TextAttributeProperties other)
          Copy c'tor.
 
Method Summary
 void addTextAttributeValue(TextAttributeValueProperties value)
          Add an attribute text value.
 void clear()
          Clear all attribute text values.
 Object clone()
           
 boolean equals(Object obj)
           
 TextAttributeValueProperties getTextAttributeValue(int index)
          Returns the attribute text value.
 TextAttributeValueProperties getTextAttributeValue(TextAttributeValueId textAttrValueId)
          Returns the attribute text value.
 TextAttributeValueProperties[] getTextAttributeValues()
          Returns all attribute text values.
 int getType()
          Indicates an attribute type (text, numeric or coupled).
 int hashCode()
           
 boolean isKeyMappable()
          Indicates if the text attribute allows for key maps.
 boolean isTextAttributeValuesLoaded()
          Indicates if the text attribute values have been loaded
 TextAttributeValueProperties removeTextAttributeValue(int index)
          Removes an attribute text value for the specified index.
 TextAttributeValueProperties removeTextAttributeValue(TextAttributeValueId textAttrValueId)
          Removes an attribute text value for the specified ID.
 void setKeyMappable(boolean isKeyMappable)
          Sets to true to allow for key maps, otherwise set to false to not allow.
 void setTextAttributeValuesLoaded(boolean isTextAttributeValuesLoaded)
          Specifies if the text attribute values have been loaded
 
Methods inherited from class com.sap.mdm.schema.AbstractAttributeProperties
getAlias, getChangeStamp, getCode, getDefinition, getId, getImageId, getName, getTableId, isMultiValued, setAlias, setChaneStamp, setChangeStamp, setCode, setDefinition, setImageId, setMultiValued, setName, setTableId, toString
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TextAttributeProperties

public TextAttributeProperties()
Empty constructor


TextAttributeProperties

public TextAttributeProperties(AttributeId id)
Constructor with the specified attribute Id.

Parameters:
id - an attribute Id

TextAttributeProperties

public TextAttributeProperties(TextAttributeProperties other)
Copy c'tor. Creates deep copy of TextAttributeProperties object.

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

getType

public int getType()
Description copied from interface: AttributeProperties
Indicates an attribute type (text, numeric or coupled).

Returns:
an attribute type

addTextAttributeValue

public void addTextAttributeValue(TextAttributeValueProperties value)
Add an attribute text value.

Parameters:
value - an attribute text value

getTextAttributeValue

public TextAttributeValueProperties getTextAttributeValue(int index)
Returns the attribute text value.

Parameters:
index - the index value
Returns:
an attribute text value

getTextAttributeValue

public TextAttributeValueProperties getTextAttributeValue(TextAttributeValueId textAttrValueId)
Returns the attribute text value. If the text attribute value is not found, null is returned.

Parameters:
textAttrValueId - a text attribute value Id
Returns:
an attribute text value

getTextAttributeValues

public TextAttributeValueProperties[] getTextAttributeValues()
Returns all attribute text values.

Returns:
attribute text values

removeTextAttributeValue

public TextAttributeValueProperties removeTextAttributeValue(int index)
Removes an attribute text value for the specified index.

Parameters:
index - an index value
Returns:
the attribute text value removed

removeTextAttributeValue

public TextAttributeValueProperties removeTextAttributeValue(TextAttributeValueId textAttrValueId)
Removes an attribute text value for the specified ID.

Parameters:
textAttrValueId - the ID of text attribute value that should be removed
Returns:
the attribute text value removed

clear

public void clear()
Clear all attribute text values.


hashCode

public int hashCode()
Overrides:
hashCode in class AbstractAttributeProperties

equals

public boolean equals(Object obj)
Overrides:
equals in class AbstractAttributeProperties

isKeyMappable

public boolean isKeyMappable()
Indicates if the text attribute allows for key maps.

Returns:
true if key mappable, otherwise false
Since:
5.5 SP6 Patch 05

setKeyMappable

public void setKeyMappable(boolean isKeyMappable)
Sets to true to allow for key maps, otherwise set to false to not allow.

Since:
5.5 SP6 Patch 05

clone

public Object clone()
Specified by:
clone in interface AttributeProperties
Overrides:
clone in class AbstractAttributeProperties

setTextAttributeValuesLoaded

public void setTextAttributeValuesLoaded(boolean isTextAttributeValuesLoaded)
Specifies if the text attribute values have been loaded

Parameters:
isTextAttributeValuesLoaded - a boolean indicating if the text attribute values have been loaded

isTextAttributeValuesLoaded

public boolean isTextAttributeValuesLoaded()
Indicates if the text attribute values have been loaded

Returns:
a boolean indicating if the text attribute values have been loaded


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.