com.canto.cumulus.prefs

Class CatalogSettingsRoot

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.CatalogTemplateLayout

com.canto.cumulus.prefs.CatalogSettingsRoot

public class CatalogSettingsRoot
extends CatalogTemplateLayout

This class is the entry point for all catalog related settings.

See Also:

Catalog.getProperties()

Nested Class Summary

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

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTRAL_ASSET_LOCATION_MODE_ALWAYS
static int	CENTRAL_ASSET_LOCATION_MODE_ALWAYS_EXCLUSIVE
static int	CENTRAL_ASSET_LOCATION_MODE_AS_SET_IN_AHS
static int	CENTRAL_ASSET_LOCATION_MODE_NEVER

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

TYPE_EJP, TYPE_NATIVE

Constructor Summary

Constructors

Constructor and Description
CatalogSettingsRoot(Catalog catalog, JPack coreData, Saver saver, java.lang.String path, PreferencesImpl preferences, com.canto.cumulus.prefs.BaseManager.ChangeManager changeManager)

Method Summary

Methods

Modifier and Type	Method and Description
CatalogAssetRelationList	getAssetRelations() Returns the list of configured asset relations.
int	getCatalogID() Returns the catalog ID.
java.lang.String	getCatalogLocation() Returns a textual representation of the catalogs location.
java.lang.String	getCatalogName() Returns the catalog name.
byte[]	getCentralAssetLocation() Returns the central asset location as an asset reference.
int	getCentralAssetLocationSetting() Returns the central asset location mode for this catalog.
DBMirroring	getDBMirroring() Returns the mirroring settings for this catalog.
CatalogInfo	getInfo() Returns catalog statistics.
boolean	getPublishToInternet() Returns whether this catalog should be available to WPP/ICP applications.
boolean	getShareCatalog() Returns whether this catalog is live and accessible for users.
TableConfigurationsList	getTableConfigurationsList() Returns the class which provides table specific configurations.
CatalogWorkflowList	getWorkflows() Returns the list of configured workflows.
void	save() Saves all changes made back to the server.
void	setCatalogName(java.lang.String value) Sets a new catalog name.
void	setCentralAssetLocation(byte[] value) Sets the central asset location for this catalog.
void	setCentralAssetLocationSetting(int value) Configures the central asset location mode for this catalog.
void	setPublishToInternet(boolean value) Sets whether this catalog should be available to WPP/ICP applications.
void	setShareCatalog(boolean value) Sets whether this catalog is live and accessible for users.

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

getAllowCatalogCreation, getAssetRelationList, getCatalogCategoryFieldList, getCatalogRecordFieldList, getDescription, getDisplayName, getUseJournaling, keepCategoriesUnique, setAllowCatalogCreation, setDescription, setDisplayName, setKeepCategoriesUnique, setUseJournaling

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

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

Methods inherited from class java.lang.Object

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

Field Detail

CENTRAL_ASSET_LOCATION_MODE_NEVER

public static final int CENTRAL_ASSET_LOCATION_MODE_NEVER

See Also:

Constant Field Values

CENTRAL_ASSET_LOCATION_MODE_AS_SET_IN_AHS

public static final int CENTRAL_ASSET_LOCATION_MODE_AS_SET_IN_AHS

See Also:

Constant Field Values

CENTRAL_ASSET_LOCATION_MODE_ALWAYS

public static final int CENTRAL_ASSET_LOCATION_MODE_ALWAYS

See Also:

Constant Field Values

CENTRAL_ASSET_LOCATION_MODE_ALWAYS_EXCLUSIVE

public static final int CENTRAL_ASSET_LOCATION_MODE_ALWAYS_EXCLUSIVE

See Also:

Constant Field Values

Constructor Detail

CatalogSettingsRoot

public CatalogSettingsRoot(Catalog catalog,
                   JPack coreData,
                   Saver saver,
                   java.lang.String path,
                   PreferencesImpl preferences,
                   com.canto.cumulus.prefs.BaseManager.ChangeManager changeManager)

Method Detail

getCatalogID

public int getCatalogID()

Returns the catalog ID.

Returns:

catalog ID

getCatalogName

public java.lang.String getCatalogName()

Returns the catalog name.

Returns:

catalog name

setCatalogName

public void setCatalogName(java.lang.String value)

Sets a new catalog name.

Parameters:

value - new catalog name

getCatalogLocation

public java.lang.String getCatalogLocation()

Returns a textual representation of the catalogs location.

Returns:

textual representation of the catalogs location

getShareCatalog

public boolean getShareCatalog()

Returns whether this catalog is live and accessible for users.

Returns:

true if this catalog is live and accessible for users

setShareCatalog

public void setShareCatalog(boolean value)

Sets whether this catalog is live and accessible for users.

Parameters:

value - set to true if this catalog should be live and accessible for users

getPublishToInternet

public boolean getPublishToInternet()

Returns whether this catalog should be available to WPP/ICP applications.

Returns:

true if this catalog should be available to WPP/ICP applications

setPublishToInternet

public void setPublishToInternet(boolean value)

Sets whether this catalog should be available to WPP/ICP applications.

Parameters:

value - set to true if this catalog should be available to WPP/ICP applications

getCentralAssetLocationSetting

public int getCentralAssetLocationSetting()

Returns the central asset location mode for this catalog. Possible values are CENTRAL_ASSET_LOCATION_MODE_NEVER, CENTRAL_ASSET_LOCATION_MODE_ALWAYS, CENTRAL_ASSET_LOCATION_MODE_ALWAYS_EXCLUSIVE and CENTRAL_ASSET_LOCATION_MODE_AS_SET_IN_AHS. Defaults to CENTRAL_ASSET_LOCATION_MODE_NEVER.

Returns:

central asset location mode

setCentralAssetLocationSetting

public void setCentralAssetLocationSetting(int value)

Configures the central asset location mode for this catalog. Possible values are CENTRAL_ASSET_LOCATION_MODE_NEVER, CENTRAL_ASSET_LOCATION_MODE_ALWAYS, CENTRAL_ASSET_LOCATION_MODE_ALWAYS_EXCLUSIVE and CENTRAL_ASSET_LOCATION_MODE_AS_SET_IN_AHS. Do not forget to set a valid central asset location when activating the location.

Parameters:

value - new mode for central asset location

See Also:

setCentralAssetLocation(byte[])

getCentralAssetLocation

public byte[] getCentralAssetLocation()

Returns the central asset location as an asset reference.

Returns:

asset reference as byte[] or null if not yet configured

See Also:

AssetReference

setCentralAssetLocation

public void setCentralAssetLocation(byte[] value)

Sets the central asset location for this catalog.

Parameters:

value - asset reference as byte[]

See Also:

AssetReference.getAsXML()

getDBMirroring

public DBMirroring getDBMirroring()

Returns the mirroring settings for this catalog.

Returns:

mirroring settings

getInfo

public CatalogInfo getInfo()

Returns catalog statistics.

Returns:

catalog statistics

getTableConfigurationsList

public TableConfigurationsList getTableConfigurationsList()

Returns the class which provides table specific configurations.

Returns:

manager which provides table specific configurations

Since:

9.2

getWorkflows

public CatalogWorkflowList getWorkflows()

Returns the list of configured workflows.

Returns:

list of configured workflows

Since:

9.2

getAssetRelations

public CatalogAssetRelationList getAssetRelations()

Returns the list of configured asset relations.

Returns:

list of configured asset relations

Since:

10.0.1

save

public void save()

Saves all changes made back to the server.

Overrides:

save in class BaseManager