com.sssw.cm.api
Interface EbiCmElement

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

All Known Subinterfaces:

EbiContentAdmin, EbiDirectory, EbiDirectoryEntry, EbiDocCategory, EbiDocContent, EbiDocExtnMeta, EbiDocExtnMetaInfo, EbiDocField, EbiDocFolder, EbiDocLayoutSet, EbiDocLayoutStyle, EbiDocLink, EbiDocType, EbiDocument, EbiDocVersion, EbiLayoutDocDescriptor, EbiQueryResult

public interface EbiCmElement

extends EbiFrameworkElement

This is the base interface for content management elements.

Field Summary

static int	OP_COPY The op-code for the "copy" operation.
static int	OP_MOVE The op-code for the "move" operation.
static int	OP_REMOVE The op-code for the "remove" operation.
static int	OP_UPDATE The op-code for the "update/change properties" operation.

Method Summary

void	fromXML(EbiContext context, EbiContentMgmtDelegate cmgr, Node node, EbiXmlDataOptions options) Initializes the element with values from an XML structure.
Document	toXML(EbiContext context, EbiContentMgmtDelegate cmgr, EbiXmlDataOptions options) Returns an XML representation of the element object in its current state.
String	validateOperation(EbiContext context, int opCode) Tells whether or not a specific operation is valid for the given element.

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

OP_UPDATE

public static final int OP_UPDATE

The op-code for the "update/change properties" operation.

OP_REMOVE

public static final int OP_REMOVE

The op-code for the "remove" operation.

OP_COPY

public static final int OP_COPY

The op-code for the "copy" operation.

OP_MOVE

public static final int OP_MOVE

The op-code for the "move" operation.

Method Detail

validateOperation

public String validateOperation(EbiContext context,
                                int opCode)
                         throws EboUnrecoverableSystemException

Tells whether or not a specific operation is valid for the given element.

Parameters:

context - The context.

opCode - The operation code. See the OP_XXXX constants.

Returns:

Null if the operation is valid, otherwise a string giving the reason why the operation is not valid.

fromXML

public void fromXML(EbiContext context,
                    EbiContentMgmtDelegate cmgr,
                    Node node,
                    EbiXmlDataOptions options)
             throws EboUnrecoverableSystemException

Initializes the element with values from an XML structure.

Parameters:

context - the context

cmgr - the Content Manager Delegate

node - the XML structure node

options - options for extracting data from the XML

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

toXML

public Document toXML(EbiContext context,
                      EbiContentMgmtDelegate cmgr,
                      EbiXmlDataOptions options)
               throws EboUnrecoverableSystemException,
                      EboSecurityException

Returns an XML representation of the element object in its current state. Refer to the DTD for each element type for more information on the XML document format and contents.

Parameters:

context - the context

cmgr - the Content Manager Delegate

options - options for writing data to the output XML document

Returns:

the XML Document representing the element object in its current state

Throws:

EboUnrecoverableSystemException - on an unrecoverable system exception

EboSecurityException - on a security exception