com.canto.cumulus

Class CumulusSession

java.lang.Object

com.canto.cumulus.CumulusSession

public final class CumulusSession
extends java.lang.Object

The CumulusSession object maintains a session with the Cumulus server. It can be seen as a client to a Cumulus database.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
CumulusSession() Creates a new session.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
boolean	getHasFeature(Feature feature) Check whether a given feature is available.
int	getLanguageID() Returns the language used for this session.
ModuleJsonPreferences	getModuleConfigurationData(java.lang.String moduleID) Return the shared module preferences for the given module ID.
Preferences	getPreferences() Returns the session's preferences.
UserContext	getUserContext() Returns the user context object.
int	hashCode()
boolean	isRemoteSession() Returns whether this session is bound to a remote server.
MultiCategoryItemCollection	newMultiCategoryItemCollection() Returns a new empty MultiCategoryItemCollection (Single User Edition only).
MultiRecordItemCollection	newMultiRecordItemCollection() Returns a new empty MultiRecordItemCollection (Single User Edition only).
Catalog	openCatalog(java.io.File catalogFile) Returns a new empty Catalog (Single User Edition only).
void	setLanguageID(int languageID) Sets the language used for this session.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CumulusSession

public CumulusSession()

Creates a new session.

Method Detail

isRemoteSession

public boolean isRemoteSession()

Returns whether this session is bound to a remote server.

Returns:

true if this session is remote

Since:

8.1

setLanguageID

public void setLanguageID(int languageID)

Sets the language used for this session.

Parameters:

languageID - the language ID for the session. The value is one of the language constants. Possible values are defined in the LanguageManager.

Since:

10.2.5

getLanguageID

public int getLanguageID()

Returns the language used for this session.

Returns:

the language ID of the session. The value is one of the language constants and can be used to parameterize the methods and properties of the Layout object. You can get the default language for newly created CumulusSession using Cumulus.getLanguageID(). Possible values are defined in the LanguageManager.

getPreferences

public Preferences getPreferences()

Returns the session's preferences.

Returns:

the session's preferences object.

getUserContext

public UserContext getUserContext()

Returns the user context object.

Returns:

the user context object.

getHasFeature

public boolean getHasFeature(Feature feature)

Check whether a given feature is available.

Parameters:

feature - the feature to check. Use one of the constants of the Feature enum.

Returns:

true if the feature is available, false otherwise.

Since:

8.0

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

newMultiRecordItemCollection

public MultiRecordItemCollection newMultiRecordItemCollection()

Returns a new empty MultiRecordItemCollection (Single User Edition only).

Returns:

a new empty MultiRecordItemCollection.

Since:

8.0

newMultiCategoryItemCollection

public MultiCategoryItemCollection newMultiCategoryItemCollection()

Returns a new empty MultiCategoryItemCollection (Single User Edition only).

Returns:

a new empty MultiCategoryItemCollection.

Since:

8.0.1

openCatalog

public Catalog openCatalog(java.io.File catalogFile)

Returns a new empty Catalog (Single User Edition only).

Parameters:

catalogFile - the Cumulus catalog file to open.

Returns:

the opened Catalog or null.

Since:

8.0

getModuleConfigurationData

public ModuleJsonPreferences getModuleConfigurationData(java.lang.String moduleID)

Return the shared module preferences for the given module ID.

Parameters:

moduleID - the module ID to get the preferences for

Returns:

module preferences