- close() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesClient
-
Closes the client, if required
- close() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngine
-
Closes the PresentationServicesEngine after use.
- com.iknowbase.api.presentationservices - package com.iknowbase.api.presentationservices
-
- com.iknowbase.api.presentationservices.client - package com.iknowbase.api.presentationservices.client
-
Client objects that allow access to installed services.
- com.iknowbase.api.presentationservices.form - package com.iknowbase.api.presentationservices.form
-
- com.iknowbase.api.presentationservices.form.annotation - package com.iknowbase.api.presentationservices.form.annotation
-
- com.iknowbase.api.presentationservices.model.common - package com.iknowbase.api.presentationservices.model.common
-
Template models shared across presentation components.
- com.iknowbase.api.presentationservices.model.content - package com.iknowbase.api.presentationservices.model.content
-
Template models specific to the ContentViewer
- com.iknowbase.api.presentationservices.model.content.item - package com.iknowbase.api.presentationservices.model.content.item
-
Template models for items returned by a ContentViewer.
- com.iknowbase.api.presentationservices.model.menu - package com.iknowbase.api.presentationservices.model.menu
-
Template models specific to the MenuViewer
- com.iknowbase.api.presentationservices.model.page - package com.iknowbase.api.presentationservices.model.page
-
Template models specific to the PageViewer.
- com.iknowbase.api.presentationservices.page - package com.iknowbase.api.presentationservices.page
-
- com.iknowbase.api.presentationservices.portlet - package com.iknowbase.api.presentationservices.portlet
-
- com.iknowbase.api.presentationservices.quickLink - package com.iknowbase.api.presentationservices.quickLink
-
- com.iknowbase.api.presentationservices.validation - package com.iknowbase.api.presentationservices.validation
-
- configure(Consumer<QuickLinkBuilder>) - Method in interface com.iknowbase.api.presentationservices.quickLink.QuickLinkBuilder
-
Calls a configuration function with this builder, to allow reusable configuration logic.
- ContentViewerActionItemModel - Interface in com.iknowbase.api.presentationservices.model.content.item
-
The ContentViewerActionItemModel class represents a generic action.
- ContentViewerItemModel<T> - Interface in com.iknowbase.api.presentationservices.model.content.item
-
The ContentViewerStringItemModel class is the superclass of all item types.
- ContentViewerLogicModel - Interface in com.iknowbase.api.presentationservices.model.content
-
The ContentViewerLogicModel class represents various information about
a content viewer execution.
- ContentViewerModel - Interface in com.iknowbase.api.presentationservices.model.content
-
The ContentViewerModel class represents various information about
a content viewer execution.
- ContentViewerNavigationModel - Interface in com.iknowbase.api.presentationservices.model.content
-
The ContentViewerModContentViewerNavigationModelel class contains
information about the underlying data in a content viewer query.
- ContentViewerQuickLinkModel - Interface in com.iknowbase.api.presentationservices.model.content
-
The ContentViewerQuickLinkModel represents a single QuickLink, as
defined on the current content viewer.
- ContentViewerRowModel - Interface in com.iknowbase.api.presentationservices.model.content
-
The ContentViewerRowModel class represents a single row returned
from the content viewer.
- ContentViewerRowSetModel - Interface in com.iknowbase.api.presentationservices.model.content
-
The ContentViewerRowSetModel class represents the set of rows
returned by a content viewer.
- ContentViewerStyleItemModel - Interface in com.iknowbase.api.presentationservices.model.content
-
The ContentViewerStyleItemModel class represents the definition of a single
item to be returned from a content viewer.
- ContentViewerStyleModel - Interface in com.iknowbase.api.presentationservices.model.content
-
The ContentViewerStyleModel represents a presentation style, as defined in the
iKnowBase repository.
- ContextModel - Interface in com.iknowbase.api.presentationservices.model.common
-
The Context represents the current execution environment.
- createPageView(String, String) - Method in interface com.iknowbase.api.presentationservices.client.SpringMvcPageEngineClient
-
Creates a View that will embed the supplied content into a given iKnowBase page,
using the path of the page as a key.
- createStringView(String, String) - Method in interface com.iknowbase.api.presentationservices.client.SpringMvcPageEngineClient
-
Creates a View which will render a given content string using a given contentType,
for easy integration with Spring MVC patterns.
- createStringView(String) - Method in interface com.iknowbase.api.presentationservices.client.SpringMvcPageEngineClient
-
Creates a view which will render a given content string as text/html, for easy
integration with Spring MVC patterns.
- get(String) - Method in interface com.iknowbase.api.presentationservices.model.common.StringsModel
-
- get(String, String) - Method in interface com.iknowbase.api.presentationservices.model.common.StringsModel
-
- getAclReference() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getActivitiEngine() - Method in interface com.iknowbase.api.presentationservices.client.ActivitiClient
-
Configures security and returns a process engine object through
which all activiti operations can be executed.
- getAdditionalSupportedArguments() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder
-
- getAltTitle() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getAsString() - Method in interface com.iknowbase.api.presentationservices.model.page.PageComponentModel
-
- getAsString() - Method in interface com.iknowbase.api.presentationservices.model.page.RegionModel
-
- getAsString() - Method in interface com.iknowbase.api.presentationservices.page.PageResult
-
- getAttributes() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getAuditInformation() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getBody() - Method in interface com.iknowbase.api.presentationservices.model.page.ResourceModel
-
- getChangeDoctypeAction(String) - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
Deprecated.
- getClientPage() - Method in interface com.iknowbase.api.presentationservices.model.page.PageModel
-
- getCommonScripts() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns the full HTML required to include the common scripts.
- getContent() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getContentLink() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
- getContentServicesClient() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder
-
- getContentServicesClient() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesClient
-
Returns the currently connected ContentServicesClient.
- getContentServicesEngine() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngine
-
Returns the underlying ContentServicesEngine.
- getContextPath() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesRequest
-
- getCreated() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.AuditInformationModel
-
- getCreated() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getCreatedBy() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getDataLevel() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
Deprecated.
- getDate() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns the current date
- getDate() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.AuditEntry
-
- getDatetime() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns the current date and time
- getDescription() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getDocumentId() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
- getDocumentIdentity() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getDocumentLevel() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
- getDocumentLink() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
- getDocumentModel() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
- getDocumentReference() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getDocumentTypeReference() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getDomain() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns information about the current domain
- getEditActionBuilder() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
- getExceptions() - Method in interface com.iknowbase.api.presentationservices.page.PageResult
-
- getFileMap() - Method in interface com.iknowbase.api.presentationservices.model.common.RequestModel
-
- getFilename() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.ContentModel
-
- getFilename() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getFiles(String) - Method in interface com.iknowbase.api.presentationservices.model.common.RequestModel
-
- getFirstRow() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerNavigationModel
-
- getFormBean() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor
-
- getFormBean() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder
-
- getFormClass() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder
-
- getFormService() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngine
-
Returns the FormService.
- getFrom() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.ValidityModel
-
- getFullRequestURL() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesRequest
-
- getHead() - Method in interface com.iknowbase.api.presentationservices.model.page.ResourceModel
-
- getHierarchicalId() - Method in interface com.iknowbase.api.presentationservices.model.common.PortletModel
-
- getId() - Method in interface com.iknowbase.api.presentationservices.model.common.UserModel
-
- getIndent() - Method in interface com.iknowbase.api.presentationservices.model.menu.MenuItemModel
-
Returns a blank string suitable for indenting a menu item.
- getInstance() - Static method in interface com.iknowbase.api.presentationservices.PresentationServicesEngineFactory
-
Returns a PresentationServicesEngineFactory.
- getLabel() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerQuickLinkModel
-
- getLabel() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerStyleItemModel
-
- getLabel() - Method in interface com.iknowbase.api.presentationservices.model.content.item.ContentViewerActionItemModel
-
- getLabel() - Method in interface com.iknowbase.api.presentationservices.model.menu.MenuItemModel
-
Returns the label of this menu item.
- getLabel() - Method in interface com.iknowbase.api.presentationservices.model.page.PageComponentModel
-
- getLanguage() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns information about the current language
- getLanguage() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerLogicModel
-
- getLastRow() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerNavigationModel
-
- getLevel() - Method in interface com.iknowbase.api.presentationservices.model.menu.MenuItemModel
-
Returns the level of the menu item in the menu tree, starting with 1.
- getLocale() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns information about the current locale
- getLogic() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerModel
-
- getMarkupId() - Method in interface com.iknowbase.api.presentationservices.model.common.PortletModel
-
- getMarkupId() - Method in interface com.iknowbase.api.presentationservices.model.page.PageComponentModel
-
- getMaxRow() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerNavigationModel
-
- getMessageSource() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder
-
- getMillis() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns the number of milliseconds since the java epoch, January 1, 1970
- getName() - Method in interface com.iknowbase.api.presentationservices.model.common.UserTokenModel
-
- getName() - Method in interface com.iknowbase.api.presentationservices.model.page.RegionModel
-
- getNavigation() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerModel
-
- getNavigationModel(QueryResponse, String) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient
-
Returns a navigation model which generates URLs for navigating the result set.
- getObjectGuid() - Method in interface com.iknowbase.api.presentationservices.model.menu.MenuItemModel
-
Returns the object id of the menu item.
- getObjectId() - Method in interface com.iknowbase.api.presentationservices.model.menu.MenuItemModel
-
Returns the object id of the menu item.
- getOnclick() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerQuickLinkModel
-
- getOnclick() - Method in interface com.iknowbase.api.presentationservices.model.content.item.ContentViewerActionItemModel
-
- getOwnerReference() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getPageComponents() - Method in interface com.iknowbase.api.presentationservices.model.page.RegionModel
-
- getPageService() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngine
-
Returns the page service.
- getPageSize() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerNavigationModel
-
- getPageURL() - Method in interface com.iknowbase.api.presentationservices.model.common.RequestModel
-
- getParameter(String) - Method in interface com.iknowbase.api.presentationservices.model.common.RequestModel
-
- getParameterMap() - Method in interface com.iknowbase.api.presentationservices.model.common.RequestModel
-
- getParameterValues(String) - Method in interface com.iknowbase.api.presentationservices.model.common.RequestModel
-
- getParent() - Method in interface com.iknowbase.api.presentationservices.model.menu.MenuItemModel
-
Returns the parent of this menu item, or null if this is a top level item.
- getParentReference() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getPresentationServicesEngine() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesClient
-
Returns the underlying PresentationServicesEngine.
- getProviderId() - Method in interface com.iknowbase.api.presentationservices.model.common.SocialAuthenticationModel
-
- getQuery(String) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient
-
Gets a SolrQuery object from session (if present), or creates a new SolrQuery and stores in session.
- getQuickLinks() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerModel
-
- getQuickLinkService() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngine
-
Returns a QuickLinkService.
- getRegion(String) - Method in interface com.iknowbase.api.presentationservices.model.page.RegionsModel
-
- getRegions() - Method in interface com.iknowbase.api.presentationservices.model.page.PageModel
-
- getRegions() - Method in interface com.iknowbase.api.presentationservices.model.page.RegionsModel
-
- getRequest() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns information about the current request
- getRequest() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerModel
-
- getResources() - Method in interface com.iknowbase.api.presentationservices.model.page.PageModel
-
- getRowSet(QueryResponse, String) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient
-
Returns a ContentViewerRowSetModel containing rows corresponding to the specified presentation
style, for the results returned by Solr.
- getRowSetModel() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerModel
-
- getScript() - Method in interface com.iknowbase.api.presentationservices.model.content.item.ContentViewerActionItemModel
-
- getSearchClient(String) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClientProvider
-
Returns a SolrSearchClient object that may be used to execute searches.
- getServerName() - Method in interface com.iknowbase.api.presentationservices.model.common.RequestModel
-
- getServerName() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesRequest
-
- getServerPort() - Method in interface com.iknowbase.api.presentationservices.model.common.RequestModel
-
- getServerPort() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesRequest
-
- getSessionAttribute(String) - Method in interface com.iknowbase.api.presentationservices.PresentationServicesRequest
-
- getSocialAuthentication() - Method in interface com.iknowbase.api.presentationservices.model.common.UserModel
-
- getStartRow() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerNavigationModel
-
- getStatusReference() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getStrings() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerModel
-
- getStrings() - Method in interface com.iknowbase.api.presentationservices.model.page.PageModel
-
- getStyleItem(String) - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerStyleModel
-
- getStyleItems() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
Deprecated.
- getStyleItems() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerStyleModel
-
- getTargetLink(String) - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
-
- getTextContent() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.ContentModel
-
- getTime() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns the current time
- getTimestamp() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.AuditInformationModel
-
- getTimestamp() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getTitle() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getTitle() - Method in interface com.iknowbase.api.presentationservices.model.content.item.ContentViewerActionItemModel
-
Deprecated.
- getTo() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.ValidityModel
-
- getToken() - Method in interface com.iknowbase.api.presentationservices.model.common.UserModel
-
- getTopCount() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerNavigationModel
-
- getTotalRows() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerNavigationModel
-
- getUpdated() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.AuditInformationModel
-
- getUpdated() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getUpdatedBy() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getUrl() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.ContentModel
-
- getUrl() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getUrl() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerQuickLinkModel
-
- getUrl() - Method in interface com.iknowbase.api.presentationservices.model.content.item.ContentViewerActionItemModel
-
- getUser() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel
-
Returns information about the current user
- getUser() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.AuditEntry
-
- getUserDisplayName() - Method in interface com.iknowbase.api.presentationservices.model.common.SocialAuthenticationModel
-
- getUserId() - Method in interface com.iknowbase.api.presentationservices.model.common.SocialAuthenticationModel
-
- getUserImageUrl() - Method in interface com.iknowbase.api.presentationservices.model.common.SocialAuthenticationModel
-
- getUsername() - Method in interface com.iknowbase.api.presentationservices.model.common.UserModel
-
- getUserProfileUrl() - Method in interface com.iknowbase.api.presentationservices.model.common.SocialAuthenticationModel
-
- getValidFrom() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getValidity() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getValidTo() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
-
- getValue() - Method in interface com.iknowbase.api.presentationservices.model.common.UserTokenModel
-
- getXmlContent() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.ContentModel
-