com.sssw.cm.api
Interface EbiDocField

All Superinterfaces:

Cloneable, EbiCmElement, EbiElement, EbiFrameworkElement, EbiSecurableElement, Serializable

public interface EbiDocField

extends EbiSecurableElement, EbiCmElement

This interface defines a Document Field. Document Fields are application- specific fields stored by the Content Manager per Document. After fields are created, they can be used when creating new Document Types. When creating Documents of those Types, the user must specify values for all the Fields referenced by the Type (null values are allowed).

See Also:

EbiDocType

Field Summary

static String	EL_DOC_FIELD The element type of "Document Field"
static String	FT_BIGDECIMAL The BigDecimal value type for Document Extension Metadata Fields
static String	FT_BOOLEAN The Boolean value type for Document Extension Metadata Fields
static String	FT_BYTE The Byte alue type for Document Extension Metadata Fields
static String	FT_BYTEARRAY The ByteArray value type for Document Extension Metadata Fields
static String	FT_CHAR The Character value type for Document Extension Metadata Fields
static String	FT_DATE The Date value type for Document Extension Metadata Fields
static String	FT_DOUBLE The Double value type for Document Extension Metadata Fields
static String	FT_FLOAT The Float value type for Document Extension Metadata Fields
static String	FT_INT The Integer value type for Document Extension Metadata Fields
static String	FT_LONG The Long value type for Document Extension Metadata Fields
static String	FT_LONGVARCHAR The LongVarChar value type for Document Extension Metadata Fields.
static String	FT_SHORT The Short value type for Document Extension Metadata Fields
static String	FT_STRING The String value type for Document Extension Metadata Fields
static String	FT_TIME The Time value type for Document Extension Metadata Fields
static String	FT_TIMESTAMP The Timestamp value type for Document Extension Metadata Fields
static String	PROTECT The 'protect' permission type.
static String	READ The 'read' permission type.
static String	WRITE The 'write' permission type.

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

OP_COPY, OP_MOVE, OP_REMOVE, OP_UPDATE

Method Summary

byte[]	getExtensionMeta() Gets the extension metadata associated with the field.
String	getFieldID() Gets the ID of the Field.
String	getFieldName() Gets the name of the document field
String	getFieldValueType() Gets the value type of the Field
String	getOriginalName() Gets the original name of this field.
void	setExtensionMeta(byte[] extnMeta) Sets the new value for the extension metadata.
void	setFieldID() Sets/generates a UUID for the field.
void	setFieldID(String uuid) Sets the field UUID.
void	setFieldName(String name) Sets the field's name to a new value.
void	setFieldValueType(String valueType) Sets the value type of the field.

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

getAcl, getObjectID, isUserAuthorized, removeAcl, setAcl

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

Field Detail

EL_DOC_FIELD

public static final String EL_DOC_FIELD

The element type of "Document Field"

See Also:

EbiElement.getType()

READ

public static final String READ

The 'read' permission type. Specifies who can read the metadata of the field, such as its name, description, extension meta, etc.

WRITE

public static final String WRITE

The 'write' permission type. Specifies who can modify the metadata of the field, such as its name, description, extension meta, etc.

PROTECT

public static final String PROTECT

The 'protect' permission type. Specifies who can modify the ACL of the field.

FT_BOOLEAN

public static final String FT_BOOLEAN

The Boolean value type for Document Extension Metadata Fields

FT_CHAR

public static final String FT_CHAR

The Character value type for Document Extension Metadata Fields

FT_BYTE

public static final String FT_BYTE

The Byte alue type for Document Extension Metadata Fields

FT_SHORT

public static final String FT_SHORT

The Short value type for Document Extension Metadata Fields

FT_INT

public static final String FT_INT

The Integer value type for Document Extension Metadata Fields

FT_LONG

public static final String FT_LONG

The Long value type for Document Extension Metadata Fields

FT_FLOAT

public static final String FT_FLOAT

The Float value type for Document Extension Metadata Fields

FT_DOUBLE

public static final String FT_DOUBLE

The Double value type for Document Extension Metadata Fields

FT_BYTEARRAY

public static final String FT_BYTEARRAY

The ByteArray value type for Document Extension Metadata Fields

FT_STRING

public static final String FT_STRING

The String value type for Document Extension Metadata Fields

FT_DATE

public static final String FT_DATE

The Date value type for Document Extension Metadata Fields

FT_TIME

public static final String FT_TIME

The Time value type for Document Extension Metadata Fields

FT_TIMESTAMP

public static final String FT_TIMESTAMP

The Timestamp value type for Document Extension Metadata Fields

FT_BIGDECIMAL

public static final String FT_BIGDECIMAL

The BigDecimal value type for Document Extension Metadata Fields

FT_LONGVARCHAR

public static final String FT_LONGVARCHAR

The LongVarChar value type for Document Extension Metadata Fields.

Method Detail

getFieldID

public String getFieldID()

Gets the ID of the Field.

Returns:

the Field ID

getFieldName

public String getFieldName()

Gets the name of the document field

Returns:

the Field name

getFieldValueType

public String getFieldValueType()

Gets the value type of the Field

Returns:

the Field's value type

getExtensionMeta

public byte[] getExtensionMeta()

Gets the extension metadata associated with the field. The metadata may be a descriptor with additional information about the field or an image associated with the field.

Returns:

the extension metadata

getOriginalName

public String getOriginalName()

Gets the original name of this field. This is useful in case a rename has occurred via the setFieldName method, but for some reason the original name is needed. Note that as soon as the changes to the field are committed to the Repository via the update method, the original name is reset to be the same as the new name.

Returns:

the original name of the field

setFieldName

public void setFieldName(String name)

Sets the field's name to a new value. EbiContentManager.updateDocumentField must be called for this change to take effect. Note that the name must be unique within the system.

Parameters:

name - the new name

setExtensionMeta

public void setExtensionMeta(byte[] extnMeta)

Sets the new value for the extension metadata. The metadata may be a descriptor with additional information about the field or an image associated with the field. EbiContentManager.updateDocumentField must be called for this change to take effect.

Parameters:

extnMeta - the new value for the extension metadata

setFieldID

public void setFieldID()

Sets/generates a UUID for the field.

setFieldID

public void setFieldID(String uuid)

Sets the field UUID.

Parameters:

uuid - the UUID

setFieldValueType

public void setFieldValueType(String valueType)

Sets the value type of the field.