com.canto.cumulus.modules.ejpregistries.general

Interface GeneralEJPRegistry

public interface GeneralEJPRegistry

Registry of EJaPs with preferences stored in the "General" section of the user preferences.

Since:

EJaP 6.0.0

Method Summary

Methods

Modifier and Type	Method and Description
Pack	getPreferences(CumulusSession session, java.lang.String ejpID) Deprecated. For better performance use getPreferencesAsJPack(com.canto.cumulus.CumulusSession, String) and setPreferences(com.canto.cumulus.CumulusSession, String, com.canto.cumulus.utils.JPack) instead.
JPack	getPreferencesAsJPack(CumulusSession session, java.lang.String ejpID) Deprecated. Use Preferences.getModulePreferences(String, boolean) instead.
JPack	getSharedPreferences(CumulusSession session, java.lang.String ejpID) Deprecated. Use Preferences.getModulePreferences(String, boolean) instead.
void	register(GeneralEJP generalEJP) Add an EJP to the global registry of general EJPs.
void	setPreferences(CumulusSession session, java.lang.String ejpID, JPack prefsPack) Deprecated. Use com.canto.cumulus.prefs.Preferences#setModulePreferences(String, com.canto.cumulus.utils.JPack, boolean) instead.
void	setPreferences(CumulusSession session, java.lang.String ejpID, Pack prefsPack) Deprecated. For better performance use setPreferences(com.canto.cumulus.CumulusSession, String, com.canto.cumulus.utils.JPack) and getPreferencesAsJPack(com.canto.cumulus.CumulusSession, String) instead.
void	setSharedPreferences(CumulusSession session, java.lang.String ejpID, JPack prefsPack) Deprecated. Use com.canto.cumulus.prefs.Preferences#setModulePreferences(String, com.canto.cumulus.utils.JPack, boolean) instead.
void	unregister(GeneralEJP generalEJP) Remove an EJP from the global registry of general EJPs.

Method Detail

getPreferences

@Deprecated
Pack getPreferences(CumulusSession session,
                             java.lang.String ejpID)

Deprecated. For better performance use getPreferencesAsJPack(com.canto.cumulus.CumulusSession, String) and setPreferences(com.canto.cumulus.CumulusSession, String, com.canto.cumulus.utils.JPack) instead.

Get the preferences as a Pack structure.

Parameters:

session - The current CumulusSession object. Typically this is taken from a RecordCollection object. This session determines the server where the preferences are stored.

ejpID - The unique identifier of the EJP module.

Returns:

A Pack containing the preferences for the given EJP.

getSharedPreferences

@Deprecated
JPack getSharedPreferences(CumulusSession session,
                                    java.lang.String ejpID)

Deprecated. Use Preferences.getModulePreferences(String, boolean) instead.

Get the shared preferences as a Pack structure.

Parameters:

session - The current CumulusSession object. Typically this is taken from a RecordCollection object. This session determines the server where the preferences are stored.

ejpID - The unique identifier of the EJP module.

Returns:

A JPack containing the preferences for the given EJP.

Since:

6.1

setPreferences

@Deprecated
void setPreferences(CumulusSession session,
                             java.lang.String ejpID,
                             Pack prefsPack)

Deprecated. For better performance use setPreferences(com.canto.cumulus.CumulusSession, String, com.canto.cumulus.utils.JPack) and getPreferencesAsJPack(com.canto.cumulus.CumulusSession, String) instead.

Set the preferences as a Pack structure.

Parameters:

session - The current CumulusSession object. Typically this is taken from a RecordCollection object. This session determines the server where the preferences are stored.

ejpID - The unique identifier of the EJP module.

prefsPack - The Pack containing the preferences for the given EJP.

setSharedPreferences

@Deprecated
void setSharedPreferences(CumulusSession session,
                                   java.lang.String ejpID,
                                   JPack prefsPack)

Deprecated. Use com.canto.cumulus.prefs.Preferences#setModulePreferences(String, com.canto.cumulus.utils.JPack, boolean) instead.

Set the shared preferences as a Pack structure.

Parameters:

session - The current CumulusSession object. Typically this is taken from a RecordCollection object. This session determines the server where the preferences are stored.

ejpID - The unique identifier of the EJP module.

prefsPack - The JPack containing the preferences for the given EJP.

Since:

6.1

register

void register(GeneralEJP generalEJP)

Add an EJP to the global registry of general EJPs. Only registered EJPs have the ability to show a prefernce panel in the Preference dialog of Cumulus.

Parameters:

generalEJP - The interface that exposes the preferences panel.

unregister

void unregister(GeneralEJP generalEJP)

Remove an EJP from the global registry of general EJPs.

Parameters:

generalEJP - The interface that exposes the preferences panel.

getPreferencesAsJPack

@Deprecated
JPack getPreferencesAsJPack(CumulusSession session,
                                     java.lang.String ejpID)

Deprecated. Use Preferences.getModulePreferences(String, boolean) instead.

Get the preferences as a Pack structure.

Parameters:

session - The current CumulusSession object. Typically this is taken from a RecordCollection object. This session determines the server where the preferences are stored.

ejpID - The unique identifier of the EJP module.

Returns:

A JPack containing the preferences for the given EJP.

Since:

6.1

setPreferences

@Deprecated
void setPreferences(CumulusSession session,
                             java.lang.String ejpID,
                             JPack prefsPack)

Deprecated. Use com.canto.cumulus.prefs.Preferences#setModulePreferences(String, com.canto.cumulus.utils.JPack, boolean) instead.

Set the preferences as a Pack structure.

Parameters:

session - The current CumulusSession object. Typically this is taken from a RecordCollection object. This session determines the server where the preferences are stored.

ejpID - The unique identifier of the EJP module.

prefsPack - The JPack containing the preferences for the given EJP.

Since:

6.1