com.canto.cumulus.prefs

Class CatalogTemplateLayout

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.CatalogTemplateLayout

Direct Known Subclasses:

CatalogSettingsRoot

public class CatalogTemplateLayout
extends BaseManager

This class manages the settings of a catalog template.

Since:

8.0

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getAllowCatalogCreation() Returns true if this template can be used to create a new catalog.
CatalogAssetRelationList	getAssetRelationList() Returns the list of asset relation types for this catalog.
CatalogFieldList	getCatalogCategoryFieldList() Returns the list of category fields for this catalog.
CatalogFieldList	getCatalogRecordFieldList() Returns the list of record fields for this catalog.
java.lang.String	getDescription(int languageID) Returns the description for the given language id.
java.lang.String	getDisplayName(int languageID) Returns the description for the given language id.
boolean	getUseJournaling() Returns whether journaling should be used.
boolean	keepCategoriesUnique() Returns whether the catalog keep category names unique.
void	setAllowCatalogCreation(boolean value) If set to true this template can be used to create a new catalog.
void	setDescription(int languageID, java.lang.String description) Sets the description for the given language.
void	setDisplayName(int languageID, java.lang.String displayName) Sets the description for the given language.
void	setKeepCategoriesUnique(boolean value) Sets whether the catalog should keep category names unique.
void	setUseJournaling(boolean value) Sets whether journaling should be used.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

keepCategoriesUnique

public boolean keepCategoriesUnique()

Returns whether the catalog keep category names unique.

Returns:

true if category names should be unique

setKeepCategoriesUnique

public void setKeepCategoriesUnique(boolean value)

Sets whether the catalog should keep category names unique.

Parameters:

value - set to true if category names should be unique

getUseJournaling

public boolean getUseJournaling()

Returns whether journaling should be used.

Returns:

true if journaling is active for this catalog.

setUseJournaling

public void setUseJournaling(boolean value)

Sets whether journaling should be used.

Parameters:

value - set to true if journaling should be used for this catalog.

getAllowCatalogCreation

public boolean getAllowCatalogCreation()

Returns true if this template can be used to create a new catalog.

Returns:

true if this template can be used to create a new catalog

setAllowCatalogCreation

public void setAllowCatalogCreation(boolean value)

If set to true this template can be used to create a new catalog.

Parameters:

value - true if this template can be used to create a new catalog

getDescription

public java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Parameters:

languageID - specifying the language for the description

Returns:

description text

Since:

8.0

setDescription

public void setDescription(int languageID,
                  java.lang.String description)

Sets the description for the given language.

Parameters:

languageID - the language to set the description for

description - the new description

Since:

8.0

getDisplayName

public java.lang.String getDisplayName(int languageID)

Returns the description for the given language id.

Parameters:

languageID - specifying the language for the description

Returns:

description text

Since:

8.5

setDisplayName

public void setDisplayName(int languageID,
                  java.lang.String displayName)

Sets the description for the given language.

Parameters:

languageID - the language to set the description for

displayName - the new display name

Since:

8.5

getCatalogRecordFieldList

public CatalogFieldList getCatalogRecordFieldList()

Returns the list of record fields for this catalog.

Returns:

list of record fields

getCatalogCategoryFieldList

public CatalogFieldList getCatalogCategoryFieldList()

Returns the list of category fields for this catalog.

Returns:

list of category fields

getAssetRelationList

public CatalogAssetRelationList getAssetRelationList()

Returns the list of asset relation types for this catalog.

Returns:

list of asset relation types

Since:

10.0.1