com.canto.cumulus

Class Server.CatalogInfo

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.Server.CatalogInfo

Enclosing class:

Server

public static final class Server.CatalogInfo
extends RecordPackWrapper

This immutable class holds information about a catalog at the server. Use Server.getCatalogInfo(int) to get this information.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canMigrate() Return whether this catalog can be migrated to the current version of the Cumulus server.
int	getCatalogID() Get the catalog ID of this catalog
java.lang.String	getCatalogLocation() Get the catalog location string (catalog file path) at the Cumulus server
java.lang.String	getCatalogName() Get the name of this catalog
java.lang.String	getDescription() Returns the description for the catalog.
java.lang.String	getDisplayName() Returns the display name for the catalog.
boolean	isDamaged() Return whether this catalog is marked as damaged.
boolean	isPublishedToInternet() Return whether this catalog is published to the Internet.
boolean	isShared() Return whether this catalog is shared.
java.lang.String	toString() Same as getCatalogName()

Methods inherited from class com.canto.cumulus.utils.RecordPackWrapper

toXMLString

Methods inherited from class java.lang.Object

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

Method Detail

getCatalogID

public int getCatalogID()

Get the catalog ID of this catalog

Returns:

The catalog ID.

getCatalogName

public java.lang.String getCatalogName()

Get the name of this catalog

Returns:

The catalog name

toString

public java.lang.String toString()

Same as getCatalogName()

Overrides:

toString in class java.lang.Object

Returns:

The catalog name.

getCatalogLocation

public java.lang.String getCatalogLocation()

Get the catalog location string (catalog file path) at the Cumulus server

Returns:

The location string of this catalog at the server.

isDamaged

public boolean isDamaged()

Return whether this catalog is marked as damaged.

Returns:

true if this catalog is marked as damaged, false otherwise.

isShared

public boolean isShared()

Return whether this catalog is shared.

Returns:

true if this catalog is shared, false otherwise.

isPublishedToInternet

public boolean isPublishedToInternet()

Return whether this catalog is published to the Internet.

Returns:

true if this catalog is published to the Internet, false otherwise.

canMigrate

public boolean canMigrate()

Return whether this catalog can be migrated to the current version of the Cumulus server.

Returns:

true if this catalog can be migrated to the current server version.

getDisplayName

public java.lang.String getDisplayName()

Returns the display name for the catalog. In case of no configured display name this method returns the default catalog name.

Returns:

display name for the catalog or the default catalog name if not configured

Since:

9.0

getDescription

public java.lang.String getDescription()

Returns the description for the catalog. In case of no configured description this method returns an empty string.

Returns:

description for the catalog or the empty string if not configured

Since:

9.0