Uses of Class
com.canto.cumulus.CumulusSession

Packages that use CumulusSession

Package	Description
com.canto.cumulus	The base package of the Cumulus Java Classes.
com.canto.cumulus.db.mail
com.canto.cumulus.db.trigger
com.canto.cumulus.fieldvalue	Wrapper clsses for field values of the Cumulus Java Classes.
com.canto.cumulus.modules	The package for accessing the plug-in modules of Cumulus.
com.canto.cumulus.modules.ejpregistries.general	The Cumulus EJaP registration package for gemneral EJaPs.
com.canto.cumulus.prefs	The Cumulus preferences package for accessing the Cumulus preferences.
com.canto.cumulus.usermanagement	The Cumulus User Management package.
com.canto.cumulus.utils	The Cumulus utilities package.

Uses of CumulusSession in com.canto.cumulus

Methods in com.canto.cumulus that return CumulusSession

Modifier and Type	Method and Description
CumulusSession	UserContext.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	Server.getCumulusSession() Returns the current CumulusSession object
CumulusSession	OutputDataStream.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	MultiLayout.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	MultiItemCollection.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	Layout.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	ItemCollection.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	Item.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	InputDataStream.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	FieldListEntry.getCumulusSession() Returns the current CumulusSession object.
abstract CumulusSession	FieldList.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	FieldDefinition.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	Catalog.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	AssetCollection.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	Asset.getCumulusSession() Returns the current CumulusSession object.
static CumulusSession	Cumulus.newSession() Create a new session to work with the Cumulus Java Classes.

Methods in com.canto.cumulus with parameters of type CumulusSession

Modifier and Type	Method and Description
java.awt.image.BufferedImage	Pixmap.getAsImage(CumulusSession session, Item item, boolean extendImageAreaToBoundingBox, int maxSizeWidth, int maxSizeHeight, int rotation) Return AWT image which optionally embeds the assets metadata tags.
byte[]	Pixmap.getAsJPEG(CumulusSession session, int maxSize, int rotation, int quality)
byte[]	Pixmap.getAsJPEG(Item item, CumulusSession cumulusSession, int maxWidth, int maxHeight, int rotation, int quality) Return JPEG image which optionally embeds the assets metadata tags.

Constructors in com.canto.cumulus with parameters of type CumulusSession

Constructor and Description
Asset(CumulusSession session, java.io.File fileOrFolder) Creates a new Asset object from the given file or folder object.
Asset(CumulusSession session, java.io.File fileOrFolder, java.lang.String assetHandlingSet) Creates a new Asset object from the given file or folder object, using a specific asset handling set.
Asset(CumulusSession session, java.lang.String sXML) Creates a new Asset object from the given AssetReference in XML format.
Asset(CumulusSession session, java.lang.String sXML, java.lang.String assetHandlingSet) Creates a new Asset object from the given AssetReference in XML format, using a specific asset handling set.

Uses of CumulusSession in com.canto.cumulus.db.mail

Methods in com.canto.cumulus.db.mail that return CumulusSession

Modifier and Type	Method and Description
CumulusSession	MailManager.getCumulusSession() Returns the CumulusSession for this MailManager.

Uses of CumulusSession in com.canto.cumulus.db.trigger

Methods in com.canto.cumulus.db.trigger that return CumulusSession

Modifier and Type	Method and Description
CumulusSession	Binding.getCumulusSession() Returns a bound CumulusSession.

Uses of CumulusSession in com.canto.cumulus.fieldvalue

Methods in com.canto.cumulus.fieldvalue that return CumulusSession

Modifier and Type	Method and Description
CumulusSession	AssetReferencePart.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	AssetReference.getCumulusSession() Get the Cumulus session that belongs to this asset reference.

Constructors in com.canto.cumulus.fieldvalue with parameters of type CumulusSession

Constructor and Description
AssetReference(CumulusSession session, java.lang.String pathNameOrXML, java.lang.String assetHandlingSet) Create a new asset reference object from the given data.
LengthInInchFieldValue(CumulusSession cumulusSession) Create a new empty length field value which uses the measurement unit from the user of the given session.
LengthInInchFieldValue(CumulusSession cumulusSession, double coreValue) Create a new length field value from the given core field value which uses the measurement unit from the user of the given session.

Uses of CumulusSession in com.canto.cumulus.modules

Methods in com.canto.cumulus.modules with parameters of type CumulusSession

Modifier and Type	Method and Description
boolean	ModuleRegistry.allocateModuleLicense(CumulusSession session, int productID) Allocate an option's license with the given product ID.
Asset	AssetStorageModule.browseForAsset(CumulusSession cumulusSession, boolean allowContainer, boolean allowAsset, java.lang.String title) Bring up a dialog to allow the user to select a single asset.
Asset	AssetStorageModule.browseForAsset(CumulusSession cumulusSession, boolean allowContainer, boolean allowAsset, java.lang.String title, java.lang.String defaultNameForContainer) Bring up a dialog to allow the user to select a single asset.
byte[]	AssetStorageModule.createAssetReferenceData(CumulusSession cumulusSession, Asset asset) Create AssetReference part data for the given asset if possible.
Module	ModuleRegistry.findModuleByID(CumulusSession session, java.lang.String id, int type) Deprecated. Use ModuleRegistry.findModuleByID(String, int) instead
java.util.Collection<Module>	ModuleRegistry.getAssetMetadataModules(CumulusSession session) Deprecated. Use ModuleRegistry.getAssetMetadataModules() instead
java.util.Collection<Module>	ModuleRegistry.getAssetProcessorModules(CumulusSession session) Deprecated. Use ModuleRegistry.getAssetProcessorModules() instead
java.util.Collection<Module>	ModuleRegistry.getAssetStorageModules(CumulusSession session) Deprecated. Use ModuleRegistry.getAssetStorageModules() instead
void	ModuleRegistry.getAvailableAssetFormats(CumulusSession session, AssetFormatsList assetFormatsList, ModulePreferencesList modulePreferencesList) Deprecated. Use ModuleRegistry.getAvailableAssetFormats(com.canto.cumulus.prefs.AssetFormatsList, com.canto.cumulus.prefs.ModulePreferencesList) instead
FieldList	ModuleRegistry.getAvailableCategoryFields(CumulusSession session) Return a list of all category fields available from registered modules.
java.util.List<FieldListEntry>	ModuleRegistry.getAvailableCategoryFieldsAsList(CumulusSession session) Deprecated. Use ModuleRegistry.getAvailableCategoryFieldsAsList() instead
java.util.List<FieldListEntry>	ModuleRegistry.getAvailableDistinctNamedCategoryFieldsAsList(CumulusSession session) Deprecated. Use ModuleRegistry.getAvailableDistinctNamedCategoryFieldsAsList() instead
java.util.List<FieldListEntry>	ModuleRegistry.getAvailableDistinctNamedRecordFieldsAsList(CumulusSession session) Deprecated. Use ModuleRegistry.getAvailableDistinctNamedRecordFieldsAsList() instead
java.util.List<FieldListEntry>	ModuleRegistry.getAvailableDistinctNamedSortableCategoryFieldsAsList(CumulusSession session) Deprecated. Use ModuleRegistry.getAvailableDistinctNamedSortableCategoryFieldsAsList() instead
java.util.List<FieldListEntry>	ModuleRegistry.getAvailableDistinctNamedSortableRecordFieldsAsList(CumulusSession session) Deprecated. Use ModuleRegistry.getAvailableDistinctNamedSortableRecordFieldsAsList() instead
FieldList	ModuleRegistry.getAvailableRecordFields(CumulusSession session) Return a list of all record fields available from registered modules.
java.util.List<FieldListEntry>	ModuleRegistry.getAvailableRecordFieldsAsList(CumulusSession session) Deprecated. Use ModuleRegistry.getAvailableRecordFieldsAsList() instead
java.util.Collection<Module>	ModuleRegistry.getFilterModules(CumulusSession session) Deprecated. Use ModuleRegistry.getFilterModules() instead
java.util.Collection<Module>	ModuleRegistry.getModules(CumulusSession session, int typeMask) Deprecated. use ModuleRegistry.getModules(int) instead
boolean	FilterModule.hasFormatPreferencesDialog(CumulusSession cumulusSession, JPack prefsModulePreferencesPack, int formatIndexInFilter) Returns whether this module has a preference dialog for the given format.
boolean	Module.hasPreferencesDialog(CumulusSession cumulusSession) Returns whether this module has a settings dialog.
boolean	AssetStorageModule.isValidExclusiveAssetReferenceForCatalog(CumulusSession cumulusSession, AssetReferencePart assetReferencePart, java.lang.String catalogName) Return whether the given AssetReference is valid to be used as an exclusive central asset location for the given catalog.
void	ModuleRegistry.releaseModuleLicense(CumulusSession session, int productID) Release a license previously allocated using the ModuleRegistry.allocateModuleLicense(com.canto.cumulus.CumulusSession, int) method.
Asset	AssetStorageModule.resolveAssetReferenceData(CumulusSession cumulusSession, byte[] data, boolean showUI, Asset container) Returns the asset found for the given asset reference data.
JPack	FilterModule.showFormatPreferencesDialog(CumulusSession cumulusSession, JPack prefsModulePreferencesPack, int formatIndexInFilter) Show the preferences dialog using the given preferences from the module preferences pack.
JPack	Module.showPreferencesDialog(CumulusSession cumulusSession, JPack prefsModulePreferencesPack) Show the preferences dialog using the given preferences from the module preferences pack.
void	ModuleRegistry.updateAssetFormatsList(CumulusSession session, AssetFormatsList assetFormatsList, boolean addNewFormatsAutomatically, ModulePreferencesList modulePreferencesList) Deprecated. Use ModuleRegistry.updateAssetFormatsList1(com.canto.cumulus.utils.JPack, boolean, com.canto.cumulus.utils.JPack) instead

Uses of CumulusSession in com.canto.cumulus.modules.ejpregistries.general

Methods in com.canto.cumulus.modules.ejpregistries.general with parameters of type CumulusSession

Modifier and Type	Method and Description
Pack	GeneralEJPRegistry.getPreferences(CumulusSession session, java.lang.String ejpID) Deprecated. For better performance use GeneralEJPRegistry.getPreferencesAsJPack(com.canto.cumulus.CumulusSession, String) and GeneralEJPRegistry.setPreferences(com.canto.cumulus.CumulusSession, String, com.canto.cumulus.utils.JPack) instead.
JPack	GeneralEJPRegistry.getPreferencesAsJPack(CumulusSession session, java.lang.String ejpID) Deprecated. Use Preferences.getModulePreferences(String, boolean) instead.
JPack	GeneralEJPRegistry.getSharedPreferences(CumulusSession session, java.lang.String ejpID) Deprecated. Use Preferences.getModulePreferences(String, boolean) instead.
void	GeneralEJPRegistry.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	GeneralEJPRegistry.setPreferences(CumulusSession session, java.lang.String ejpID, Pack prefsPack) Deprecated. For better performance use GeneralEJPRegistry.setPreferences(com.canto.cumulus.CumulusSession, String, com.canto.cumulus.utils.JPack) and GeneralEJPRegistry.getPreferencesAsJPack(com.canto.cumulus.CumulusSession, String) instead.
void	GeneralEJPRegistry.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.

Uses of CumulusSession in com.canto.cumulus.prefs

Methods in com.canto.cumulus.prefs that return CumulusSession

Modifier and Type	Method and Description
CumulusSession	PreferencesImpl.getCumulusSession() Returns the current CumulusSession object.
CumulusSession	Preferences.getCumulusSession() Returns the current CumulusSession object.

Methods in com.canto.cumulus.prefs with parameters of type CumulusSession

Modifier and Type	Method and Description
java.util.List<LengthInInchFieldValue>	QueryConditionLengthInInch.getComparisonListValues(CumulusSession cumulusSession)
java.lang.String	Workflow.validate(int languageID, CumulusSession cumulusSession) Validates this workflow for being correct.

Constructors in com.canto.cumulus.prefs with parameters of type CumulusSession

Constructor and Description
PreferencesImpl(CumulusSession session)

Uses of CumulusSession in com.canto.cumulus.usermanagement

Methods in com.canto.cumulus.usermanagement that return CumulusSession

Modifier and Type	Method and Description
CumulusSession	AuthenticationManager.getCumulusSession() Returns the CumulusSession object.

Uses of CumulusSession in com.canto.cumulus.utils

Methods in com.canto.cumulus.utils with parameters of type CumulusSession

Modifier and Type	Method and Description
java.lang.String	WorkflowManager.getMatchingRecordsQuery(CumulusSession cumulusSession, Workflow workflow, int activityID) Returns a query string which finds all records where the given activity can be applied on.