com.sssw.cm.api
Interface EbiDocType

All Superinterfaces:

Cloneable, EbiCmElement, EbiElement, EbiFrameworkElement, EbiSecurableElement, Serializable

public interface EbiDocType

extends EbiSecurableElement, EbiCmElement

This interface defines the notion of a Document Type. A Document Type is a template for creating a Document and is comprised of a collection of Extension Metadata Fields. For instance, the Document Type of "Movie Review" could contain such custom Metadata Fields as "Genre", "Director", "Year of Release", and "Rating".

See Also:

EbiDocField

Field Summary

static String	EL_DOC_TYPE The element type of "Document Type".
static String	LIST The 'list' permission type.
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

String	getDescription() Gets the description of the Document Type.
String	getDocTypeID() Gets the ID of the type.
String	getDocTypeName() Gets the name of the Document Type.
byte[]	getExtensionMeta() Gets the Extension Metadata associated with the type.
String	getOriginalName() Gets the original name of this doctype.
void	setDescription(String description) Sets the description of the Document Type.
void	setDocTypeID() Sets the UUID of the Document Type.
void	setDocTypeID(String uuid) Sets the UUID of the Document Type.
void	setDocTypeName(String docTypeName) Sets the name of the Document Type to the new value.
void	setExtensionMeta(byte[] extnMeta) Sets the new value for the Extension Metadata.

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_TYPE

public static final String EL_DOC_TYPE

The element type of "Document Type".

READ

public static final String READ

The 'read' permission type. Determines who can read the properties of the Document Type.

WRITE

public static final String WRITE

The 'write' permission type. Determines who can change the properties of the Document Type, who can add Document Fields to this Type, and who can create Documents of this Type.

PROTECT

public static final String PROTECT

The 'protect' permission type. Determines who can change the permissions set on this Document Type.

LIST

public static final String LIST

The 'list' permission type. Determines who can list (enumerate) the documents of this Type.

Method Detail

getDocTypeID

public String getDocTypeID()

Gets the ID of the type.

Returns:

the ID

getDocTypeName

public String getDocTypeName()

Gets the name of the Document Type.

Returns:

the name

getDescription

public String getDescription()

Gets the description of the Document Type.

Returns:

the description

getExtensionMeta

public byte[] getExtensionMeta()

Gets the Extension Metadata associated with the type. The Metadata may be a descriptor with additional information about the Document Type or an image associated with it.

Returns:

the Extension Metadata

getOriginalName

public String getOriginalName()

Gets the original name of this doctype. This is useful in case a rename has occurred via the setDocTypeName method, but for some reason the original name is needed. Note that as soon as the changes to the type 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 doctype

setDocTypeID

public void setDocTypeID()

Sets the UUID of the Document Type.

setDocTypeID

public void setDocTypeID(String uuid)

Sets the UUID of the Document Type.

Parameters:

uuid - the UUID

setDocTypeName

public void setDocTypeName(String docTypeName)

Sets the name of the Document Type to the new value. Use EbiContentManager.updateDocumentType to save the changes. Note that the name must be unique within the system.

Parameters:

docTypeName - the new name

setDescription

public void setDescription(String description)

Sets the description of the Document Type. Use EbiContentManager.updateDocumentType to save the changes.

Parameters:

description - the new description

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 Document Type or an image associated with it. EbiContentManager.updateDocumentType must be called for this change to take effect.

Parameters:

extnMeta - the new value for the Extension Metadata