Package com.canto.cumulus

The base package of the Cumulus Java Classes.

See: Description

Interface Summary

Interface	Description
FieldTypes	This interface contains all constants for field types and field value interpretation values.
StartStopListener	The event listener interface to receive events when the Cumulus Java Classes are starting up and shutting down.

Class Summary

Class	Description
AllCategoriesItemCollection	This class represents an unmutable collection of all categories that the current user is able to see.
Asset	The Asset object allows you to access an individual asset.
Asset.VersionInformation	This class bundles version information for an asset.
AssetCollection	This class represents an iterable collection of Asset objects.
Audio	The Audio object allows you to access a Cumulus audio field.
Catalog	The Catalog object allows you to access the properties of an open Cumulus catalog.
Catalog.CatalogInfo	This class hold the information for a Catalog.
CategoryItem	This class represents a category of a Cumulus catalog.
CategoryItemCollection	This class represents the categories of a Cumulus catalog.
Cumulus	The base class of the Cumulus Java Classes library.
CumulusSession	The CumulusSession object maintains a session with the Cumulus server.
FieldDefinition	The FieldDefinition object can be used it to access a specific field of a layout.
FieldList	The FieldList object is used to maintain a collection of field entries.
FieldListEntry	The FieldListEntry object represents an entry of the FieldList object.
GUID	The GUID object allows you uniquely identify Cumulus objects like Fields, Asset Storages and Modules.
InputDataStream	The InputDataStream object allows you to read bytes from a data stream.
Item	This class represents an entry in one of the tables of the catalog.
ItemCollection	This class represents a collection of items of any table of a Cumulus catalog.
ItemIdentifier	An identifier of an Item object on a catalog.
Layout	The Layout specifies the list of fields of a table.
MultiCategoryItemCollection	A collection of CategoryItemCollection objects of different catalogs.
MultiItemCollection	A collection of ItemCollection objects of different catalogs.
MultiLayout	This class tries to offer the same functionality as a normal Layout while working on multiple catalogs.
MultiRecordItemCollection	A collection of RecordItemCollection objects for different catalogs.
OutputDataStream	The OutputDataStream object allows you to write bytes to a data stream.
Pack	Deprecated Use JPack instead.
Pixmap	The Pixmap object allows you to access a Cumulus pixmap field.
Pixmap.AssetInfo	Wraps asset information.
Pixmap.JPEGInfo	Wraps image information.
RecordItem	This class represents a record in the Cumulus.TABLE_NAME_ASSET_RECORDS table of a Cumulus catalog.
RecordItemCollection	A collection of RecordItem objects of a Cumulus catalog.
Server	The Server object allows you to connect to a remote server and administer or work with it.
Server.CatalogInfo	This immutable class holds information about a catalog at the server.
SortFieldDescriptor	The information about a single sorting field.
UserContext	The UserContext object represents the current logged-in user.
UserContextData	This class represents user field data for use in an ESP trigger action module in the Cumulus server.
UserContextPredefinedFields	This class contains GUIDs for the predefined fields available through the UserContext or UserContextData classes.

Exception Summary

Exception	Description
CumulusException	The Cumulus specific exception.

Package com.canto.cumulus Description

The base package of the Cumulus Java Classes.
© 2002-2021 Canto GmbH. All Rights Reserved.