Package gi.controlsite.objects

Class Summary

Class	Description
ContentEventMessage
CSApiKey	Class that handles the querying, updating, creation, and deletion of API Keys and associated constructs.
CSApiKeyContent	Class used to store the item data of a CSApiKey object.
CSApiKeyIpRule	Class represents a CSApiKeyIpRule object.
CSApiKeyMethodFilter	Represents a method filter, as serialised into the MethodFilter column on the APIKeyWorkers table.
CSApiKeyWorker	Represents a CSApiKeyWorker - i.e. the worker under an api key.
CSApiKeyWorkerDefaultCredentials	Represents default credentials that can be defined for a CSApiKeyWorker.
CSApplicationVar	Class that handles the querying of application variables as stored by autoconfig in the Preferences table.
CSApplicationVarContent	Class used to store the item data of a CSApplicationVar.
CSArticle	Class that handles the querying of an iCM article.
CSArticleContent	Class used to store the content of a CSArticle object.
CSArticleMultiple	Class that handles the querying and storage of multiple articles.
CSAttribute	Class that handles the querying of an iCM attribute.
CSAttributeContent	Class used to store the content of a CSAttribute object.
CSAttributeMultiple	Class that handles the querying and storage of multiple iCM attributes.
CSAttributeSetMultiple	Class that handles the retrieval of all the attribute types and their attributes for a specified product type or specified attribute types.
CSAttributeType	Class that handles the querying of an iCM attribute type.
CSAttributeTypeContent	Class used to store the content of a CSAttributeType object.
CSAttributeTypeMultiple	Class that handles the querying and storage of multiple iCM attribute types.
CSBasket	Class that handles the querying of an iCM basket.
CSBasketContent	Class used to store the content of a CSBasket object.
CSBasketItem	Class that handles the querying of an iCM basket item.
CSBasketItemContent	Class used to store the content of a CSBasketItem object.
CSBasketItemMultiple	Class that handles the querying and storage of multiple iCM basket items.
CSBasketMultiple	Class that handles the querying and storage of multiple iCM baskets.
CSCache	Custom Tag handler class to support in-file html caching in jsp.
CSCollectionArticle	Deprecated Replaced by CSSearchMultiple.
CSCollectionForumMessage	Deprecated Replaced by CSSearchMultiple.
CSCollectionMedia	Deprecated Replaced by CSSearchMultiple.
CSCommerceSetting	Class that handles the querying of an iCM commerce setting.
CSCommerceSettingContent	Class used to store the content of a CSCommerceSetting object.
CSCommerceSettingMultiple	Class that handles the querying and storage of multiple iCM commerce settings.
CSConstants	Library class of various constants.
CSContact	Class that handles the querying of an iCM contact.
CSContactContent	Class used to store the content of a CSContact object.
CSContactMultiple	Class that handles the querying and storage of multiple iCM contacts.
CSContributorActions	Class that detects what a site user may do in the way of article manipulation via their designated iCM user.
CSCountry	Class that handles the querying of an iCM country.
CSCountryContent	Class used to store the content of a CSCountry object.
CSCountryMultiple	Class that handles the querying and storage of multiple iCM countries.
CSCreditCardInfo	Class that handles the querying of an iCM credit card information item.
CSCreditCardInfoContent	Class used to store the content of a CSCreditCardInfo object.
CSCreditCardInfoMultiple	Class that handles the querying and storage of all iCM credit card information items.
CSDatabaseConnectionPool	This class is responsible for handling database connections.
CSDatabaseItem	Base class providing database access.
CSDatabaseItemImpl	Implementation of CSDatabaseItem that can be used instead of creating an instance of a fully-blown CSDatabaseItem-derived class such as CSArticle, CSLink, etc.
CSDelimList	Class that extends ArrayList to facilitate the creation and manipulation of delimited lists.
CSDiscountScheme	Class that handles the querying of an iCM discount scheme.
CSDiscountSchemeContent	Class used to store the content of a CSDiscountScheme object.
CSDiscountSchemeMultiple	Class that handles the querying and storage of multiple iCM discount schemes.
CSDiscountUtil	Utility Class for manipulating discounts.
CSEndpointWorker	Class that handles the querying of an iCM endpoint worker.
CSEndpointWorkerContent	Class used to store the item data of a CSEndpointWorker object.
CSEvent	Class that handles the querying of an event that has been set-up within the EVENTS section of iCM.
CSEventContent	Class used to store the content of a CSEvent object.
CSEventMultiple	Class that handles the querying and storage of multiple iCM events.
CSFeature	Class that handles the querying and storage of a feature item.
CSFeatureContent	Class used to store the content of a CSFeature object.
CSFeatureGroup	Class that handles the querying and storage of a feature group item.
CSFeatureGroupContent	Class used to store the content of a CSFeatureGroup object.
CSFeatureGroups	Class that handles the querying and storage of a multiple feature groups.
CSFeatureMultiple	Class that handles the querying and storage of a multiple feature groups.
CSFieldValidator	Simple form field validator class.
CSForm	Deprecated This is only used by pre-V9 forms.
CSFormatItem	Class that handles the querying and storage of an iCM item and also provides optional text formatting properties and methods.
CSFormatValue	Utility Class for formating values to a specific number of decimal places.
CSFormContent	Deprecated This is only used by pre-V9 forms.
CSFormItem	Deprecated This is only used by pre-V9 forms.
CSFormItemContent	Deprecated This is only used by pre-V9 forms.
CSFormItemMultiple	Deprecated This is only used by pre-V9 forms.
CSFormMultiple	Class that handles the querying and storage of multiple iCM forms.
CSFormSection	Deprecated This is only used by pre-V9 forms.
CSFormSectionContent	Deprecated This is only used by pre-V9 forms.
CSFormSectionMultiple	Deprecated This is only used by pre-V9 forms.
CSForum	API class for reading, modifying, and adding fora.
CSForumContent	Class used to store the content of a CSForum object.
CSForumMessage	API class for reading, modifying, and adding messages within fora.
CSForumMessageContent	Class used to store the content of a CSForumMessage object.
CSForumMessages	Class that handles the querying and storage of multiple forum messages.
CSForumMultiple	Class that handles the querying and storage of multiple forum items.
CSForumThread	API class for reading, modifying, and adding threads in forums.
CSForumThreadContent	Class used to store the content of a CSForumThread object.
CSForumThreads	Class that handles the querying and storage of a multiple forum threads.
CSItem	Base class for API classes.
CSItemContent	Base class providing storage of an item's (CSItem) data.
CSItemMultiple<E>	Base class representing multiple iCM items CSItem.
CSLink	Class that handles the querying of an iCM external link.
CSLinkContent	Class used to store the item data of a CSLink object.
CSLinkMultiple	Class that handles the querying and storage of multiple external links.
CSMaintenanceArea	Class that handles the querying of the maintenance areas found in the "System Online/Offline" area of iCM.
CSMaintenanceAreaContent	Class used to store the item data of a CSMaintenanceArea object.
CSMaintenanceAreaMultiple	The CSMaintenanceAreaMultiple class provides a method (CSMaintenanceAreaMultiple.get()) that retrieves the current online/offline status of various areas of iCM, details of those areas, and scheduled changes to the current status.
CSMaintenanceSchedule
CSMaintenanceScheduleContent
CSMedia	Class that handles the querying of an iCM media item.
CSMediaContent	Class used to store the data for a CSMediaType object.
CSMediaContentFile	Class used to store a filename and filetype for a media item.
CSMediaGroup	Class that handles the querying of an iCM media group.
CSMediaGroupContent	Class used to store the data for a CSMediaGroupMultiple object.
CSMediaGroupMultiple	Class that handles the querying and storage of multiple iCM media group items.
CSMediaMultiple	Class that handles the querying and storage of multiple iCM media items.
CSMediaType	Class that handles the querying of a iCM media type.
CSMediaTypeContent	Class used to store the data for a CSMedia object.
CSMediaTypeContentFile	Class used to store the content of a CSMediaType object's subtype.
CSMediaTypeMultiple	Class that handles the querying and storage of multiple iCM media types.
CSMetaData	Class that handles the querying and storage of an iCM metadata value.
CSMetaDataContent	Class used to store the content of a CSMetaData object.
CSMetaDataMultiple	Class that handles the querying and storage of multiple iCM metadata values.
CSMetaDataProperty	Class that handles the querying and storage of a metadata property.
CSMetaDataPropertyContent	Class used to store the content of a CSMetaDataProperty object.
CSMultiPageForm
CSMultiPageFormContent	Class used to store the content of a CSMultiPageFormContent object.
CSObject	Class that handles the processing and database manipulation of a iCM object and its relationships with other iCM objects.
CSObjectContent	Class used to store the content of a CSObject object.
CSObjectDefinition	Class that handles the processing and database manipulation of an iCM object's definition.
CSObjectDefinitionContent	Class used to store the content of a CSObjectDefinition object.
CSObjectMultiple	Class that handles the querying and storage of multiple iCM objects.
CSOrder	Class that handles the querying of an iCM order.
CSOrderAddress	Class that handles the querying of an iCM order.
CSOrderAddressContent	Class used to store the content of a CSOrderAddress object.
CSOrderAddressMultiple	Class that handles the querying and storage of multiple iCM order addresses.
CSOrderContent	Class used to store the content of a CSOrder object.
CSOrderGenerate	Class that handles the generation of a partially complete order from an iCM basket.
CSOrderGenerateContent	Class used to store the content of a CSOrderGenerate object.
CSOrderItem	Class that handles the querying of an iCM order item.
CSOrderItemContent	Class used to store the content of a CSOrderItem object.
CSOrderItemDispatch	Class that handles the querying of an iCM order item dispatch.
CSOrderItemDispatchContent	Class used to store the content of a CSOrderItemDispatch object.
CSOrderItemDispatchMultiple	Class that handles the querying and storage of multiple iCM order item dispatches.
CSOrderItemMultiple	Class that handles the querying and storage of multiple iCM order items.
CSOrderMultiple	Class that handles the querying and storage of multiple iCM orders.
CSOrderSelectMultiple	Class that handles the querying of multiple iCM orders for administrative purposes.
CSPoll	Class that handles the querying and storage of a single poll item.
CSPollContent	Class used to store the content of a CSPoll object.
CSPollContentAnswer	Class used to store the details for a poll answer.
CSPollMultiple	Class that handles the querying and storage of a multiple poll items.
CSPreparedStatementBuilder	Class that handles the construction of createPreparedStatement through encapsulating the SQL query string and its parameters.
CSPrices	Storage Class for product prices.
CSProductGroup	Class that handles the querying of an iCM product group.
CSProductGroupContent	Class used to store the content of a CSProductGroup object.
CSProductGroupMultiple	Class that handles the querying and storage of multiple iCM product groups.
CSProductMultiple	Class that handles the querying and storage of multiple iCM products.
CSProductOption	Class that handles the querying of an iCM product option.
CSProductOptionContent	Class used to store the content of a CSProductOption object.
CSProductOptionMultiple	Class that handles the querying and storage of multiple iCM product options.
CSProductType	Class that handles the querying of an iCM product type.
CSProductTypeContent	Class used to store the content of a CSProductType object.
CSProductTypeMultiple	Class that handles the querying and storage of multiple iCM product types.
CSProductTypeStatus	Class that handles the querying of an iCM product type's product options, and their associated attributes and media items, in a manner that is readily useable by the website's standard product page templates.
CSProductUtil	Utility Class for manipulating products.
CSPublishedEndpoint	Class that handles the querying of an iCM endpoint worker.
CSPublishedEndpointContent	Class used to store the item data of a CSPublishedEndpoint object.
CSRack	Class that handles the querying of an iCM rack.
CSRackContent	Class used to store the content of a CSRack object.
CSRackItem	Class that handles the querying of an iCM rack item.
CSRackItemContent	Class used to store the content of a CSRackItem object.
CSRackItemMultiple	Class that handles the querying and storage of multiple iCM rack items.
CSRackMultiple	Class that handles the querying and storage of multiple iCM racks.
CSSearchGroup	Class used by CSSearchMultiple for returning grouped search results.
CSSearchItem	Class used by CSSearchMultiple for returning search results.
CSSearchMultiple	Class that searches the specified iCM and/or user-defined Solr collections for items that match the specified criteria.
CSShippingScheme	Class that handles the querying of an iCM shipping scheme.
CSShippingSchemeContent	Class used to store the content of a CSShippingScheme object.
CSShippingSchemeMultiple	Class that handles the querying and storage of multiple iCM shipping schemes.
CSShippingZone	Class that handles the querying of an iCM shipping zone.
CSShippingZoneContent	Class used to store the content of a CSShippingZone object.
CSShippingZoneMultiple	Class that handles the querying and storage of multiple iCM shipping zones.
CSSinglePageForm
CSSinglePageFormContent	Class used to store the content of a CSSinglePageForm object.
CSSkeletonBasedItem
CSSolrSearch
CSState	An object of this class holds information about the state of the CSItem object with which it is associated.
CSSubsite	Class that handles the querying of a iCM subsite.
CSSubsiteAlias	Class that handles the querying of an iCM subsite alias.
CSSubsiteAliasContent	Class used to store the content of a CSSubsiteAlias object.
CSSubsiteContent	Class used to store the content of a CSSubsite object.
CSSubsiteMultiple	Class that handles the querying and storage of multiple subsites.
CSTemplate	Class that handles the querying and storage of a template item.
CSTemplateAsset	Class that handles the querying and storage of a template asset.
CSTemplateAssetConstraint	Class that handles the querying and storage of a template asset constraint.
CSTemplateAssetConstraintContent	Class used to store the content of a CSTemplateAssetConstraint object.
CSTemplateAssetContent	Class used to store the content of a CSTemplateAsset object.
CSTemplateContent	Class used to store the content of a CSTemplate object.
CSTemplateImage	Class that handles the querying and storage of a template image.
CSTemplateImageContent	Class used to store the content of a CSTemplateImage object.
CSTemplatePreviewMode	Class that handles the querying and storage of a template preview mode.
CSTemplatePreviewModeContent	Class used to store the content of a CSTemplatePreviewMode object.
CSUser
CSUserContent	Class used to store the content of a CSUser object.
CSUserGroup	Class that handles the querying and storage of a user group item.
CSUserGroupContent	Class used to store the content of a CSUserGroup object.
CSUserGroups	Class that handles the querying and storage of multiple user group items.
CSUserMultiple	Class that handles the querying and storage of a multiple user items.
CSUserProfile	Class that handles the querying and storage of a website user's profile details.
CSUserProfileContent	Class used to store the content of a CSUserProfile object.
CSUtil	Utility class which contains useful general-purpose static methods.
CSVatScheme	Class that handles the querying of an iCM VAT scheme.
CSVatSchemeContent	Class used to store the content of a CSVatScheme object.
CSVatSchemeMultiple	Class that handles the querying and storage of multiple iCM VAT schemes.
CSVatZone	Class that handles the querying of an iCM VAT zone.
CSVatZoneContent	Class used to store the content of a CSVatZone object.
CSVatZoneMultiple	Class that handles the querying and storage of multiple iCM VAT zones.
FileStoreDeleteMessage
GatewayMessageHandler	Handles the sending of gateway messages for search index and file store updating, plus content event handler execution NOTE: The Java API does not perform any iCM audit logging.
Json
JsonLexer
SearchUpdateMessage

Enum Summary

Enum	Description
CSApiKeyMethodFilter.HttpVerb	Represents specific HttpVerbs supported by method filters
CSPreparedStatementBuilder.JDBCType	The JDBC types that the CSPreparedStatementBuilder currently supports

Exception Summary

Exception	Description
CSDatabaseException	The CSDatabaseException class handles error conditions caused by unexpected problems reading the database.
CSException	The CSException class and its subclasses handle error conditions which a reasonable iCM application might want to catch.
CSJsonException
CSNotFoundException	The CSNotFoundException class handles error conditions which arise when attempting to retrieve an item that cannot be located on the database using the supplied key information.
CSParameterException	The CSParameterException class handle error conditions caused by invalid or missing key information.
CSRuntimeException	The CSRuntimeException class and its subclasses handle error conditions which a reasonable iCM application might want to catch at runtime.
CSSecurityException	The CSSecurityException class handles error conditions caused by an attempt to breach security.
CSValidationException	The CSValidationException class is used to indicate a problem when a validation request is attempted.
CSVerityException	The CSVerityException class handles error conditions which arise when attempting to retrieve data from a verity collection.