com.sssw.cm.api
Interface EbiDocLayoutStyle

All Superinterfaces:

Cloneable, EbiCmElement, EbiElement, EbiFrameworkElement, EbiSecurableElement, Serializable

public interface EbiDocLayoutStyle

extends EbiSecurableElement, EbiCmElement

Objects implementing this interface represent Document Layout Styles that are defined by Administrators per Document Type.

See Also:

EbiLayoutDocDescriptor

Field Summary

static String	EL_LAYOUT_STYLE The element type of Layout Style.
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 Layout Style.
String	getDocTypeID() Gets the Document Type ID.
String	getDocTypeName() Gets the name of the Document Type.
String	getOriginalName() Gets the original name of this style.
String	getStyleID() Gets the Layout Style ID.
String	getStyleName() Gets the name of the Style.
boolean	isDefault() Determines if this style is the default style for the Document Type that the style is intended for
void	resetOriginalName() Resets the original name to be the same as any new name as soon as changes to this style are committed to the Repository.
void	setDefault(boolean isDefault) Changes the 'is default style' setting.
void	setDescription(String description) Sets the description of the Style.
void	setDocTypeID(String docTypeID) Sets the document type ID.
void	setStyleID() Sets/generates the style ID.
void	setStyleID(String uuid) Sets the style UUID.
void	setStyleName(String styleName) Sets the style's name to a new value.

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_LAYOUT_STYLE

public static final String EL_LAYOUT_STYLE

The element type of Layout Style.

See Also:

EbiElement.getType()

READ

public static final String READ

The 'read' permission type. Specifies who can read the metadata of the Layout Style, such as its name, description, etc.

WRITE

public static final String WRITE

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

PROTECT

public static final String PROTECT

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

Method Detail

getStyleID

public String getStyleID()

Gets the Layout Style ID.

Returns:

the ID of the Layout Style.

getDocTypeID

public String getDocTypeID()

Gets the Document Type ID.

Returns:

the ID of the Document Type for which this Layout was created

getDocTypeName

public String getDocTypeName()

Gets the name of the Document Type.

Returns:

the name of the Document Type for which this Layout was created

getStyleName

public String getStyleName()

Gets the name of the Style.

Returns:

style name

getDescription

public String getDescription()

Gets the description of the Layout Style.

Returns:

the description

isDefault

public boolean isDefault()

Determines if this style is the default style for the Document Type that the style is intended for

Returns:

true if the style is the default, false otherwise

setDocTypeID

public void setDocTypeID(String docTypeID)

Sets the document type ID.

Parameters:

docTypeID - the Document type ID

getOriginalName

public String getOriginalName()

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

setStyleName

public void setStyleName(String styleName)

Sets the style's name to a new value. EbiContentManager.updateDocumentLayoutStyle to save the change. Note that the name must be unique within the set of styles defined on a document type.

Parameters:

styleName - the new style name

setDescription

public void setDescription(String description)

Sets the description of the Style. Note: use EbiContentManager.updateDocumentLayoutStyle to save the change.

setDefault

public void setDefault(boolean isDefault)

Changes the 'is default style' setting. Note: use EbiContentManager.updateDocumentLayoutStyle to save the change.

setStyleID

public void setStyleID()

Sets/generates the style ID.

setStyleID

public void setStyleID(String uuid)

Sets the style UUID.

Parameters:

uuid - the UUID

resetOriginalName

public void resetOriginalName()

Resets the original name to be the same as any new name as soon as changes to this style are committed to the Repository. This is not part of the public API and is expected to be called by the Content Manager only.