com.sssw.cm.api
Interface EbiDocExtnMetaInfo

All Superinterfaces:

Cloneable, EbiCmElement, EbiElement, EbiFrameworkElement, Serializable

public interface EbiDocExtnMetaInfo

extends EbiCmElement

This interface represents the pair { field name, field values }.

The field name is the name of a specific Extension Metadata field for a Document of a certain type, e.g. "Country of origin" or "Rating" or "Year" for a Document of type "Movie Review".

The Field may have one or more values, for example, for a Movie Review, there may be a Field named "Genre" whose values are "Drama", "Tragedy", and "Tearjerker".

The type of the values must be per the definition of the Extension Field, e.g. String, Long, Integer, etc. See value type definitions in EbiDocField.

Field Summary

static String

EL_EXTN_META_INFO The element type of Extension Meta Info.

Fields inherited from interface com.sssw.cm.api.EbiCmElement

OP_COPY, OP_MOVE, OP_REMOVE, OP_UPDATE

Method Summary

String	getDataType() Gets the data type code for the Extension Metadata Field (EbiDocField.FT_STRING, EbiDocField.FT_LONG, etc.)
String	getDocumentID() Gets the ID of the Document whose Extension Metadata this meta info represents
String	getFieldID() Gets the ID of the Extension Metadata Field whose values this meta info is holding
String	getFieldName() Gets the name of the Extension Metadata Field whose values this meta info is holding
Collection	getFieldValues(boolean getStrings) Gets the values of the Extension Metadata Field.
void	setDataType(String dataType) Sets the data type.
void	setFieldID(String fieldID) Sets the Field ID.
void	setFieldName(String fieldName) Sets the Field name.
void	setFieldValues(Object[] values) Sets the values of the Extension Metadata Field. Notes: Use EbiContentManager.updateDocumentExtnMetaInfo to save the changes; The values supplied via this method overwrite whatever values the field may have had for the document; The type of the supplied values must be per the definition of the field, e.g.

Methods implemented from interface com.sssw.cm.api.EbiCmElement

fromXML, toXML, validateOperation

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_EXTN_META_INFO

public static final String EL_EXTN_META_INFO

The element type of Extension Meta Info.

See Also:

EbiElement.getType()

Method Detail

getDocumentID

public String getDocumentID()

Gets the ID of the Document whose Extension Metadata this meta info represents

Returns:

the Document ID

getFieldID

public String getFieldID()

Gets the ID of the Extension Metadata Field whose values this meta info is holding

Returns:

the field ID

getFieldName

public String getFieldName()

Gets the name of the Extension Metadata Field whose values this meta info is holding

Returns:

the field name

getDataType

public String getDataType()

Gets the data type code for the Extension Metadata Field (EbiDocField.FT_STRING, EbiDocField.FT_LONG, etc.)

Returns:

the data type

getFieldValues

public Collection getFieldValues(boolean getStrings)

Gets the values of the Extension Metadata Field.

Parameters:

getStrings - tells whether to return Strings or objects in their actual data type

Returns:

a Collection of the field's values; if 'getStrings' is false, the type of the returned values is per the definition of the field, e.g. String, Long, etc. (EbiDocField.FT_STRING, EbiDocField.FT_LONG, etc.), if it's true, a Collection of Strings is returned

setFieldID

public void setFieldID(String fieldID)

Sets the Field ID.

Parameters:

fieldID - the Field ID

setFieldName

public void setFieldName(String fieldName)

Sets the Field name.

Parameters:

fieldName - the Field name

setDataType

public void setDataType(String dataType)

Sets the data type.

Parameters:

dataType - the data type

setFieldValues

public void setFieldValues(Object[] values)

Sets the values of the Extension Metadata Field.
Notes:

1. Use EbiContentManager.updateDocumentExtnMetaInfo to save the changes;
2. The values supplied via this method overwrite whatever values the field may have had for the document;
3. The type of the supplied values must be per the definition of the field, e.g. String, Long, etc. (EbiDocField.FT_STRING, EbiDocField.FT_LONG, etc.)
4. The supplied array may not be null or of length 0: if a Document belongs to a specific Document Type, each of the Extension Fields defined on that type must have at least one value, which may be null.

Parameters:

values - the new values