|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
This interface represents record in MDM repository. Is supplies methods for getting and setting values for all record elements: fields, taxonomy attributes, qualifiers.
HierNode,
RecordResultSet| Nested Class Summary | |
static interface |
Record.CheckoutStatus
Constants for Check-out Status of Record |
static interface |
Record.MatrixType
Constants for record matrix type |
static interface |
Record.ModificationStatus
Constants for Modification Status of Record |
| Method Summary | |
Object |
clone()
Returns a clone. |
boolean |
containsAttribute(FieldId taxonomyFieldId,
AttributeId attrId)
Check if specified attribute is populate with data |
boolean |
containsField(FieldId fieldId)
Check if specified field is populate with data |
Record[] |
findLookupRecords(FieldId lookupFieldId)
Find supported lookup record (or records for multi-value case) in cache of result set for the specified lookup field. |
AttributeId[] |
getAttributes(FieldId taxonomyFieldId)
Get array of attribute IDs for the specified taxonomy field. |
MdmValue |
getAttributeValue(FieldId taxonomyFieldId,
AttributeId attrId)
Get value of the specified attribute for taxonomy field. |
int |
getChangeStamp()
Get change stamp of the record |
int |
getCheckoutStatus()
Get checkout status |
String |
getDefaultRegionCode()
Returns the default region code. |
String |
getDisplayValue()
Get display value of this record. |
FieldId[] |
getFields()
Get array of field IDs for all populated records. |
MdmValue |
getFieldValue(FieldId fieldId)
Get value of the specified field. |
RecordId |
getId()
Get record ID |
String |
getLookupDisplayValue(FieldId lookupFieldId)
Returns display value for lookup field |
int |
getMatrixType()
Returns the matrix type. |
TableSchema |
getMetadata()
Get metadata of table the current record belongs to. |
int |
getModificationStatus()
Get modification status (NEW, MODIFIED, UNMODIFIED) |
MultiregionValue |
getMultiregionFieldValue(FieldId fieldId)
Get multi-region value of the specified field. |
Record[] |
getReverseLookupRecords(ReverseLookupId reverseLookup)
Gets the value of the specified reverse lookup field, which is an array of records that reference this record. |
ReverseLookupId[] |
getReverseLookups()
Returns the reverse lookups specified for the record. |
TableId |
getTable()
Get ID of the table the current record belongs to. |
String |
getTupleDisplayValue(FieldId tupleFieldId)
Returns the display value for the tuple field. |
boolean |
hasFieldValue(FieldId fieldId)
Returns whether the specified field has field value, meaning not null. |
boolean |
isInWorkflow()
Returns whether the record is in a work flow. |
boolean |
isProtected()
Check if the this record is protected |
boolean |
isQualifiedField(FieldId fieldId)
Indicates if specified field is qualified lookup field |
boolean |
isTaxonomyField(FieldId fieldId)
Indicates if the specified record field is taxonomy field |
void |
setAttributeValue(FieldId taxonomyFieldId,
AttributeId attrId,
MdmValue value)
Set new value to the specified attribute for taxonomy field. |
void |
setFieldValue(FieldId fieldId,
MdmValue value)
Set new value to the specified field. |
void |
setMatrixType(int matrixType)
Sets the matrix type. |
String |
toString(FieldId fieldId)
Converts specified field value to string; this is the short form of the method. |
String |
toString(FieldId fieldId,
AttributeId attributeId)
Converts the specified attribute value to string; this is the short form of the method. |
String |
toString(FieldId fieldId,
AttributeId attributeId,
int regionInheritanceMode,
RegionInheritanceProperties regionInheritance,
DimensionsManager dm)
Converts the specified attribute value to string according to the specified parameters; this is the long form of the method. |
String |
toString(FieldId fieldId,
int regionInheritanceMode,
RegionInheritanceProperties regionInheritance,
DimensionsManager dm)
Converts the specified field value to a string according to the specified parameters; this is the long form of the method. |
| Method Detail |
public RecordId getId()
public TableId getTable()
public int getChangeStamp()
public TableSchema getMetadata()
public String getDisplayValue()
public boolean isProtected()
public boolean isInWorkflow()
true if in workflow, otherwise falsepublic int getCheckoutStatus()
Record.CheckoutStatuspublic int getMatrixType()
Record.MatrixTypepublic void setMatrixType(int matrixType)
Record.MatrixType.ORDINARY.
matrixType - a matrix typepublic int getModificationStatus()
public FieldId[] getFields()
public MdmValue getFieldValue(FieldId fieldId)
throws IllegalArgumentException
fieldId - field ID
IllegalArgumentException - if field with specified ID does not exist or was not populated
public void setFieldValue(FieldId fieldId,
MdmValue value)
throws IllegalArgumentException,
MdmValueTypeException
fieldId - field IDvalue - new field value
IllegalArgumentException - if field with specified ID does not exist
MdmValueTypeException - if there is mismatch between field type and type of value
public MultiregionValue getMultiregionFieldValue(FieldId fieldId)
throws IllegalArgumentException
fieldId - field ID
IllegalArgumentException - if field with specified ID does not exist or was not populatedpublic String getDefaultRegionCode()
public Record[] findLookupRecords(FieldId lookupFieldId)
throws IllegalArgumentException
lookupFieldId - ID of lookup field
IllegalArgumentException - if field with specified ID does not exist or
was not populated or is not lookup field
public String getLookupDisplayValue(FieldId lookupFieldId)
throws IllegalArgumentException
lookupFieldId - ID of lookup field
IllegalArgumentException - if field with specified ID does not exist or
was not populated or is not lookup field
public String getTupleDisplayValue(FieldId tupleFieldId)
throws IllegalArgumentException
tupleFieldId - a tuple field
IllegalArgumentExceptionpublic boolean isTaxonomyField(FieldId fieldId)
fieldId - field ID
true if specified field is taxonomy field, false otherwisepublic boolean isQualifiedField(FieldId fieldId)
fieldId - field ID
true if specified field is qualified lookup field, false otherwisepublic boolean containsField(FieldId fieldId)
fieldId - field ID
public AttributeId[] getAttributes(FieldId taxonomyFieldId)
throws IllegalArgumentException
taxonomyFieldId - taxonomy field ID
IllegalArgumentException - if field was not populated or field is not taxonomy field
public MdmValue getAttributeValue(FieldId taxonomyFieldId,
AttributeId attrId)
throws IllegalArgumentException
taxonomyFieldId - taxonomy field IDattrId - attribute ID
IllegalArgumentException - if field or attribute with specified ID was not populated or
field is not taxonomy field
public void setAttributeValue(FieldId taxonomyFieldId,
AttributeId attrId,
MdmValue value)
throws IllegalArgumentException,
MdmValueTypeException
taxonomyFieldId - taxonomy field IDattrId - attribute IDvalue - new attribute value
IllegalArgumentException - if field or attribute with specified ID was not populated or
field is not taxonomy field
MdmValueTypeException - if there is mismatch between attribute type and type of value
public boolean containsAttribute(FieldId taxonomyFieldId,
AttributeId attrId)
taxonomyFieldId - field IDattrId - attribute ID
public Object clone()
public ReverseLookupId[] getReverseLookups()
public Record[] getReverseLookupRecords(ReverseLookupId reverseLookup)
reverseLookup - Reverse lookup field to retrieve
public boolean hasFieldValue(FieldId fieldId)
getFieldValue(FieldId).isNull() always return true when
ResultDefinition.setIsLoadTupleValues(boolean) is set to false. In such a case,
this method can be used to determine if tuple values exist.
For non-tuple fields, the following statement is true:
getFieldValue(FieldId).isNull() != hasFieldValue(FieldId)
fieldId - field ID
public String toString(FieldId fieldId)
fieldId - the field ID
getFieldValue(FieldId)
public String toString(FieldId fieldId,
int regionInheritanceMode,
RegionInheritanceProperties regionInheritance,
DimensionsManager dm)
fieldId - the field IDregionInheritanceMode - specifies the value inheritance mode, defined by the RegionalLayer enumeration; relevant for
multilingual fieldsregionInheritance - specifies the inheritance for a language; relevant for multilingual fields, otherwise can be
nulldm - specifies the dimension manager for unit of measurement (UOM); relevant for user-defined UOM fields,
otherwise can be null
getFieldValue(FieldId),
RegionalLayer,
GetRepositoryInheritedRegionListCommand,
GetRepositoryDimensionsCommand
public String toString(FieldId fieldId,
AttributeId attributeId)
fieldId - the ID of the taxonomy lookup field , related to the attributeattributeId - the attribute ID
getAttributeValue(FieldId, AttributeId)
public String toString(FieldId fieldId,
AttributeId attributeId,
int regionInheritanceMode,
RegionInheritanceProperties regionInheritance,
DimensionsManager dm)
fieldId - the ID of the taxonomy lookup field , related to the attributeattributeId - the attribute IDregionInheritanceMode - specifies the value inheritance mode, defined by the RegionalLayer enumeration; relevant for multilingual text attributesregionInheritance - specifies the inheritance for a language; relevant for multilingual text attributes, otherwise can be
nulldm - specifies the dimension manager for unit of measurement (UOM); relevant for user-defined UOM numeric
attributes, otherwise can be null
getAttributeValue(FieldId, AttributeId),
RegionalLayer,
GetRepositoryInheritedRegionListCommand,
GetRepositoryDimensionsCommand
|
|||||||||||
| 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.