com.sap.mdm.data
Interface Record

All Superinterfaces:

java.lang.Cloneable, RepositoryItem

All Known Subinterfaces:

BinaryBlobRecord, BlobRecord, HierNode, HierNodeEx, ImageBlobRecord, PdfBlobRecord, RecordEx, TextBlobRecord

public interface Record

extends RepositoryItem, java.lang.Cloneable

This interface represents record in MDM repository. Is supplies methods for getting and setting values for all record elements: fields, taxonomy attributes, qualifiers.

See Also:

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

java.lang.Object	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
java.lang.String	getDefaultRegionCode() Returns the default region code.
java.lang.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
java.lang.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.
TableId	getTable() Get ID of the table the current record belongs to.
boolean	isProtected() Check if the this record is protected
boolean	isTaxonomyField(FieldId fieldId) Returns true if specified 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.

Method Detail

getId

public RecordId getId()

Get record ID

Returns:

record ID or null if record is new

getTable

public TableId getTable()

Get ID of the table the current record belongs to.

Returns:

table ID

getChangeStamp

public int getChangeStamp()

Get change stamp of the record

Returns:

change stamp. Return -1 if record is new

getMetadata

public TableSchema getMetadata()

Get metadata of table the current record belongs to.

Returns:

table metadata. Returns Null if metadata was not loaded.

getDisplayValue

public java.lang.String getDisplayValue()

Get display value of this record. Display value is string compounded on the server side from display field values. For new record return Null

Returns:

record display value. Null for new record.

isProtected

public boolean isProtected()

Check if the this record is protected

Returns:

true if record is protected, false otherwise

getCheckoutStatus

public int getCheckoutStatus()

Get checkout status

Returns:

checkout status

See Also:

Record.CheckoutStatus

getMatrixType

public int getMatrixType()

Returns the matrix type.

Returns:

a matrix type

See Also:

Record.MatrixType

setMatrixType

public void setMatrixType(int matrixType)

Sets the matrix type. The default is Record.MatrixType.ORDINARY.

Parameters:

matrixType - a matrix type

getModificationStatus

public int getModificationStatus()

Get modification status (NEW, MODIFIED, UNMODIFIED)

Returns:

modification status

getFields

public FieldId[] getFields()

Get array of field IDs for all populated records.

Returns:

array of field IDs. Empty array is returned if any field was populated

getFieldValue

public MdmValue getFieldValue(FieldId fieldId)
                       throws java.lang.IllegalArgumentException

Get value of the specified field.

Parameters:

fieldId - field ID

Returns:

field value

Throws:

java.lang.IllegalArgumentException - if field with specified ID does not exist or was not populated

setFieldValue

public void setFieldValue(FieldId fieldId,
                          MdmValue value)
                   throws java.lang.IllegalArgumentException,
                          MdmValueTypeException

Set new value to the specified field.

Parameters:

fieldId - field ID

value - new field value

Throws:

java.lang.IllegalArgumentException - if field with specified ID does not exist

MdmValueTypeException - if there is mismatch between field type and type of value

getMultiregionFieldValue

public MultiregionValue getMultiregionFieldValue(FieldId fieldId)
                                          throws java.lang.IllegalArgumentException

Get multi-region value of the specified field.

Parameters:

fieldId - field ID

Returns:

field multi-region value

Throws:

java.lang.IllegalArgumentException - if field with specified ID does not exist or was not populated

getDefaultRegionCode

public java.lang.String getDefaultRegionCode()

Returns the default region code.

Returns:

the default region code.

findLookupRecords

public Record[] findLookupRecords(FieldId lookupFieldId)
                           throws java.lang.IllegalArgumentException

Find supported lookup record (or records for multi-value case) in cache of result set for the specified lookup field.

Parameters:

lookupFieldId - ID of lookup field

Returns:

array of supported lookup record. If there is not values for specified lookup field then empty array is returned. If supported lookup record was not loaded then Null is returned.

Throws:

java.lang.IllegalArgumentException - if field with specified ID does not exist or was not populated or is not lookup field

getLookupDisplayValue

public java.lang.String getLookupDisplayValue(FieldId lookupFieldId)
                                       throws java.lang.IllegalArgumentException

Returns display value for lookup field

Parameters:

lookupFieldId - ID of lookup field

Returns:

display value of lookup record. If lookup record was not loaded then Null is returned

Throws:

java.lang.IllegalArgumentException - if field with specified ID does not exist or was not populated or is not lookup field

isTaxonomyField

public boolean isTaxonomyField(FieldId fieldId)

Returns true if specified field is taxonomy field

Parameters:

fieldId - field ID

Returns:

true if specified field is taxonomy field, false otherwise

containsField

public boolean containsField(FieldId fieldId)

Check if specified field is populate with data

Parameters:

fieldId - field ID

Returns:

true if specified field is populated with data, false otherwise

getAttributes

public AttributeId[] getAttributes(FieldId taxonomyFieldId)
                            throws java.lang.IllegalArgumentException

Get array of attribute IDs for the specified taxonomy field.

Parameters:

taxonomyFieldId - taxonomy field ID

Returns:

array of attribute IDs. If attributes were not populated then empty array is returned

Throws:

java.lang.IllegalArgumentException - if field was not populated or field is not taxonomy field

getAttributeValue

public MdmValue getAttributeValue(FieldId taxonomyFieldId,
                                  AttributeId attrId)
                           throws java.lang.IllegalArgumentException

Get value of the specified attribute for taxonomy field.

Parameters:

taxonomyFieldId - taxonomy field ID

attrId - attribute ID

Returns:

attribute value

Throws:

java.lang.IllegalArgumentException - if field or attribute with specified ID was not populated or field is not taxonomy field

setAttributeValue

public void setAttributeValue(FieldId taxonomyFieldId,
                              AttributeId attrId,
                              MdmValue value)
                       throws java.lang.IllegalArgumentException,
                              MdmValueTypeException

Set new value to the specified attribute for taxonomy field.

Parameters:

taxonomyFieldId - taxonomy field ID

attrId - attribute ID

value - new attribute value

Throws:

java.lang.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

containsAttribute

public boolean containsAttribute(FieldId taxonomyFieldId,
                                 AttributeId attrId)

Check if specified attribute is populate with data

Parameters:

taxonomyFieldId - field ID

attrId - attribute ID

Returns:

true if specified field is populated with data, false otherwise

clone

public java.lang.Object clone()

See Also:

java.lang.Object#clone()