com.sssw.cm.api
Interface EbiDocLayoutSet

All Superinterfaces:

Cloneable, EbiCmElement, EbiElement, EbiFrameworkElement, Serializable

public interface EbiDocLayoutSet

extends EbiCmElement

Objects that implement this interface represent Document Layout Sets that are created by Document Authors per a specific Document, if they choose to specify Layouts that are to be used by the Presentation Layer at the document viewing time.

The Set is characterized by:

• The ID of the Document for which the Set is created;
• The ID of the Document Layout Style chosen for this Document by its Author;
• Zero or more Layout Descriptors, each of which is a pair { Document ID, Document Version ID }; the Document ID in the pair must specify a Layout Document that is valid for Documents with the Document Type and Layout Style that are specified in this Layout Set; the Document Version ID must be a valid version of that Document or -1 for "use the current version".

See EbiLayoutDocDescriptor for more information on the Content Manager's support for Layouts.

Field Summary

static String

EL_LAYOUT_SET The element type of "Layout Set".

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

OP_COPY, OP_MOVE, OP_REMOVE, OP_UPDATE

Method Summary

String	getDocumentID() Gets the ID of the Document for which this Set was created or is being created.
Collection	getLayoutDescriptors() Enumerates the Layout Descriptors
String	getLayoutStyleID() Gets the ID of the Layout Style chosen for the Document.
void	setDocumentID(String docID) Sets the Document ID.
void	setLayoutDescriptor(EbiDocVersionDescriptor layoutDescriptor) Adds a Layout Descriptor to the Set.
void	setLayoutDescriptors(EbiDocVersionDescriptor[] layoutDescriptors) Resets all the Layout Descriptors currently in the Layout Set to the ones contained by the supplied array.
void	setLayoutStyleID(String layoutStyleID) Sets the Layout Style ID.

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_LAYOUT_SET

public static final String EL_LAYOUT_SET

The element type of "Layout Set".

See Also:

EbiElement.getType()

Method Detail

getDocumentID

public String getDocumentID()

Gets the ID of the Document for which this Set was created or is being created.

Returns:

the Document ID

getLayoutStyleID

public String getLayoutStyleID()

Gets the ID of the Layout Style chosen for the Document.

Returns:

the Layout Style ID

getLayoutDescriptors

public Collection getLayoutDescriptors()

Enumerates the Layout Descriptors

Returns:

a Collection of EbiDocVersionDescriptor's each of which represents a Layout Document

setLayoutStyleID

public void setLayoutStyleID(String layoutStyleID)

Sets the Layout Style ID.

Parameters:

layoutStyleID - the Layout Style ID

setLayoutDescriptor

public void setLayoutDescriptor(EbiDocVersionDescriptor layoutDescriptor)

Adds a Layout Descriptor to the Set.

Parameters:

layoutDescriptor - the new Layout Descriptor

setDocumentID

public void setDocumentID(String docID)

Sets the Document ID.

Parameters:

docID - the Document ID

setLayoutDescriptors

public void setLayoutDescriptors(EbiDocVersionDescriptor[] layoutDescriptors)

Resets all the Layout Descriptors currently in the Layout Set to the ones contained by the supplied array.

Parameters:

layoutDescriptors - the new set of Descriptors