Index (iknowbase-presentationservices-api 7.7.3 API)

A B C D E F G I L M N O P Q R S T U V W

A

ActivitiClient - Interface in com.iknowbase.api.presentationservices.client: The ActivitiClient represents the interface to the embedded Activiti process engine, and provides access to the process engine itself.
AfterInsert - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked after save of new document to iKnowBase repository
AfterLoad - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked after load from iKnowBase repository
AfterUpdate - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked after save of existing document to iKnowBase repository
applyCommonParameters(SolrQuery) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient: Applies common search parameters from the request to the query.
asString() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerNavigationModel
asString() - Method in interface com.iknowbase.api.presentationservices.portlet.Form.Result

B

BACK - Static variable in interface com.iknowbase.api.presentationservices.form.annotation.Form.TargetResponse: Redirect to p_form_back_url.
BeforeBeanToAttributesMapping - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked before a bean is converter to DocumentAttributes
BeforeInsert - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked after conversion to document attributes and before save to iKnowBase repository as new document
BeforeUpdate - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked after conversion to document attributes and before save to iKnowBase repository updating an existing document
BindingError - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked after binding and validation of the form backing bean
bindingError(BindingResult) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor
build() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder: Returns an FormProcessor built from parameters set on this builder.
build() - Method in interface com.iknowbase.api.presentationservices.portlet.Form.Builder
build() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngineBuilder: Builds a PresentationServicesEngineBuilder based on the parameters set on this builder.
build(PresentationServicesClient) - Method in interface com.iknowbase.api.presentationservices.quickLink.QuickLinkBuilder: Returns a ContentQueryAction built from parameters set on this builder.
buildElements(PresentationServicesClient) - Method in interface com.iknowbase.api.presentationservices.quickLink.QuickLinkBuilder: Returns a List of ContentQueryAction built from parameters set on this builder.
builder(T, ContentServicesClient) - Method in interface com.iknowbase.api.presentationservices.form.FormService
builder() - Method in interface com.iknowbase.api.presentationservices.portlet.Form.Factory
builder() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngineFactory: Creates a new PresentationServicesEngineBuilder.
builder(String) - Method in interface com.iknowbase.api.presentationservices.quickLink.QuickLinkService: Creates a new Builder for a quickLink action.

C

client(PresentationServicesClient) - Method in interface com.iknowbase.api.presentationservices.portlet.PortletRunner: Sets which client context to use
client(PresentationServicesClient) - Method in interface com.iknowbase.api.presentationservices.template.TemplateRunner
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.
CLOSE_WINDOW - Static variable in interface com.iknowbase.api.presentationservices.form.annotation.Form.TargetResponse: Close current window.
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.functions - package com.iknowbase.api.presentationservices.functions
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.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.template - package com.iknowbase.api.presentationservices.template
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.
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.
CONTINUE - Static variable in interface com.iknowbase.api.presentationservices.form.annotation.Form.TargetResponse: Continue displaying the page.
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.

D

dataSource(DataSource) - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngineBuilder: Specifies which data source to use.
DataSourceContentType - Annotation Type in com.iknowbase.api.presentationservices.validation: The content type of the annotated DataSource must match the specified regular expression and its content type in combination with its file name must exist in the iKnowBase configuration.
direct() - Method in interface com.iknowbase.api.presentationservices.quickLink.QuickLinkBuilder: Specify that the action should resolve directly to the target URL, without any redirection.
DocumentModel - Interface in com.iknowbase.api.presentationservices.model.common: The DocumentModel represents an iknowbase document
DocumentModel.AuditEntry - Interface in com.iknowbase.api.presentationservices.model.common
DocumentModel.AuditInformationModel - Interface in com.iknowbase.api.presentationservices.model.common
DocumentModel.ContentModel - Interface in com.iknowbase.api.presentationservices.model.common
DocumentModel.ValidityModel - Interface in com.iknowbase.api.presentationservices.model.common
domainGuid(String) - Method in interface com.iknowbase.api.presentationservices.page.PageRunner
DomainModel - Interface in com.iknowbase.api.presentationservices.model.common

E

execute(SolrParams) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient: Executes a query on the SolrQuery.
execute(SolrQuery) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient: Deprecated.
execute(SolrParams, String, Consumer<Reader>) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient: Executes a query on the solr server, without parsing the return value.
execute(SolrQuery, String, Consumer<Reader>) - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient: Deprecated.

F

failOnComponentFailure() - Method in interface com.iknowbase.api.presentationservices.page.PageRunner
Form - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for forms used in an iKnowBase Classic page.
Form - Interface in com.iknowbase.api.presentationservices.portlet
Form.BINDING_MODE - Enum in com.iknowbase.api.presentationservices.form.annotation
Form.Builder - Interface in com.iknowbase.api.presentationservices.portlet
Form.Factory - Interface in com.iknowbase.api.presentationservices.portlet
Form.Portlet - Interface in com.iknowbase.api.presentationservices.portlet
Form.Result - Interface in com.iknowbase.api.presentationservices.portlet
Form.Runner - Interface in com.iknowbase.api.presentationservices.portlet
Form.TargetResponse - Interface in com.iknowbase.api.presentationservices.form.annotation: Predefined target response supported by @TargetAfterInsert and @TargetAfterUpdate
Form.ValidationGroups - Interface in com.iknowbase.api.presentationservices.form.annotation: Validation groups supported by the java form in iKnowBase Classic context.
Form.ValidationGroups.Insert - Interface in com.iknowbase.api.presentationservices.form.annotation
Form.ValidationGroups.Update - Interface in com.iknowbase.api.presentationservices.form.annotation
FormProcessor<T> - Interface in com.iknowbase.api.presentationservices.form: Helper class for working with iKnowBase form backing beans in Spring MVC Controllers and FreeMarker views.
FormProcessorBuilder<T> - Interface in com.iknowbase.api.presentationservices.form
FormService - Interface in com.iknowbase.api.presentationservices.form
Function - Annotation Type in com.iknowbase.api.presentationservices.functions: Annotation for mapping iKnowBase Classic Portlet to iKnowBase JavaSDK Portlet implementation method.
function(String) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionRequest: Returns a copy of this FunctionRequest, with the specified functionName
FunctionRequest - Interface in com.iknowbase.api.presentationservices.functions: This class represents a request to execute a function.
FunctionResponse - Interface in com.iknowbase.api.presentationservices.functions
FunctionResponse.STATUS - Enum in com.iknowbase.api.presentationservices.functions
FunctionsClient - Interface in com.iknowbase.api.presentationservices.functions: A client object providing access to the iKnowBase Functions Engine.

G

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
getDateAsInstant() - 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
getDuration() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
getEditActionBuilder() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerRowModel
getEndTime() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
getExceptions() - Method in interface com.iknowbase.api.presentationservices.page.PageResult
getExecutedByJvm() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
getExecutionId() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
getExecutionLog() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
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
getFormGuid() - 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
getFromAsInstant() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.ValidityModel
getFullRequestURL() - Method in interface com.iknowbase.api.presentationservices.PresentationServicesRequest
getFunctionName() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
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.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
getOutput() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
getOutput() - Method in interface com.iknowbase.api.presentationservices.portlet.PortletResult: Returns the output from running a portlet.
getOutput() - Method in interface com.iknowbase.api.presentationservices.template.TemplateResult
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.common.ContextModel: Returns a ResourceModel providing access to the common resources
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
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
getStartTime() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
getStatus() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionResponse
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
getTo() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel.ValidityModel
getToAsInstant() - 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
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
getValidator() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder
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

I

Init - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked during initialization of the form backing bean
init() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor
input(Map) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionRequest: Returns a copy of this FunctionRequest, with the specified input parameters
Insert - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for method that handles the "Save" / "Submit" event for a Form for new documents.
InsertTemplate - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for method that returns the template to be used by a Form for new documents
isAdmin() - Method in interface com.iknowbase.api.presentationservices.model.common.UserModel
isBreadcrumb() - Method in interface com.iknowbase.api.presentationservices.model.menu.MenuItemModel: Returns a flag indicating whether the menu item has been tagged for breadcrumb usage
isDevelopmentMode() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel: Returns information about whether development mode is enabled
isFile() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
isLoggedOn() - Method in interface com.iknowbase.api.presentationservices.model.common.UserModel
isServeExpandedResources() - Method in interface com.iknowbase.api.presentationservices.model.common.ContextModel: Returns information about whether to serve expanded resources
isSitemap() - Method in interface com.iknowbase.api.presentationservices.model.menu.MenuItemModel: Returns a flag indicating whether the menu item has been tagged for sitemap usage
isSortActive() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerStyleItemModel
isSortActiveAscending() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerStyleItemModel
isSortActiveDescending() - Method in interface com.iknowbase.api.presentationservices.model.content.ContentViewerStyleItemModel
isText() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
isUrl() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel
isXml() - Method in interface com.iknowbase.api.presentationservices.model.common.DocumentModel

L

load(Integer) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor

M

MenuItemModel - Interface in com.iknowbase.api.presentationservices.model.menu: A menu item from a menu defined in the repository.
MessageSourceProvider - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that return a MessageSource or MessageSource basename for use in FormProcessor.
model(String, Object) - Method in interface com.iknowbase.api.presentationservices.template.TemplateRunner
model(Map<String, ?>) - Method in interface com.iknowbase.api.presentationservices.template.TemplateRunner

N

newQuery() - Method in interface com.iknowbase.api.presentationservices.client.SolrSearchClient: Creates a new SolrQuery object, ready for use.

O

onCloseCallback(String) - Method in interface com.iknowbase.api.presentationservices.quickLink.QuickLinkBuilder: Specify that the form opened by the edit action shall call a specified javascript function when closing.
onCloseUrl(String) - Method in interface com.iknowbase.api.presentationservices.quickLink.QuickLinkBuilder: Specify that the form opened by the edit action shall redirect to a specific URL when closing.

P

PageComponentModel - Interface in com.iknowbase.api.presentationservices.model.page
PageController - Annotation Type in com.iknowbase.api.presentationservices.page: Marks a class as being a Page Controller containing iKnowBase JavaSDK Portlet implementation methods annotated with
PageEngineClient - Interface in com.iknowbase.api.presentationservices.client
PageMapping - Annotation Type in com.iknowbase.api.presentationservices.page: Annotation for mapping iKnowBase Classic Page to iKnowBase JavaSDK Page implementation method.
PageModel - Interface in com.iknowbase.api.presentationservices.model.page
PageResult - Interface in com.iknowbase.api.presentationservices.page
PageRunner - Interface in com.iknowbase.api.presentationservices.page: The PageRunner lets you run an iKnowBase Classic Page on demand.
PageService - Interface in com.iknowbase.api.presentationservices.page: A service managing the page services, in particular providing access to TemplateRunner, PortletRunner and PageRunner objects.
parameter(String, String) - Method in interface com.iknowbase.api.presentationservices.quickLink.QuickLinkBuilder: Specify a parameter that is to be passed to the target.
path(String) - Method in interface com.iknowbase.api.presentationservices.page.PageRunner
portlet(String) - Method in interface com.iknowbase.api.presentationservices.portlet.PortletRunner: Sets the name of the portlet to run
PortletController - Annotation Type in com.iknowbase.api.presentationservices.portlet: Marks a class as being a Portlet Controller containing iKnowBase JavaSDK Portlet implementation methods annotated with @PortletMapping.
PortletMapping - Annotation Type in com.iknowbase.api.presentationservices.portlet: Annotation for mapping iKnowBase Classic Portlet to iKnowBase JavaSDK Portlet implementation method.
PortletModel - Interface in com.iknowbase.api.presentationservices.model.common
PortletResult - Interface in com.iknowbase.api.presentationservices.portlet: The PortletResult contains the output from running a portlet.
portletRunner() - Method in interface com.iknowbase.api.presentationservices.page.PageService: Returns a PortletRunner useful for running a portlet
PortletRunner - Interface in com.iknowbase.api.presentationservices.portlet: The PortletRunner lets you run a portlet on-demand.
PresentationServicesClient - Interface in com.iknowbase.api.presentationservices: Access to key iKnowBase ContentServices and PresentationServices for a connected user
PresentationServicesEngine - Interface in com.iknowbase.api.presentationservices: The main engine object for iKnowBase PresentationServices, holding all services available to the users.
PresentationServicesEngineBuilder - Interface in com.iknowbase.api.presentationservices: A builder used to configure and build a new PresentationServicesEngine, including the underlying ContentServicesEngine.
PresentationServicesEngineFactory - Interface in com.iknowbase.api.presentationservices
PresentationServicesRequest - Interface in com.iknowbase.api.presentationservices
priority(Integer) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionRequest: Returns a copy of this FunctionRequest, with the specified priority
properties(Properties) - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngineBuilder: Specifies properties used to configure the PresentationServicesEngine.
propertyFile(String...) - Method in interface com.iknowbase.api.presentationservices.PresentationServicesEngineBuilder: Specifies one or more property files to load.

Q

QuickLinkBuilder - Interface in com.iknowbase.api.presentationservices.quickLink: A builder used to configure and build quickLink actions
QuickLinkService - Interface in com.iknowbase.api.presentationservices.quickLink: A service managing quickLink actions.

R

RegionModel - Interface in com.iknowbase.api.presentationservices.model.page
RegionsModel - Interface in com.iknowbase.api.presentationservices.model.page
registerFormMacro(Model, String) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor
registerFormMacro(Model, String, String) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor
renderPage(String, String) - Method in interface com.iknowbase.api.presentationservices.client.PageEngineClient: Renders an iKnowBase page, using the supplied clientPageContent as an iKnowBase client page.
renderPage(PresentationServicesClient, String, String) - Method in interface com.iknowbase.api.presentationservices.page.PageService: Renders an iKnowBase page, using the supplied clientPageContent as an iKnowBase client page.
renderTemplate(String, Map<String, ?>) - Method in interface com.iknowbase.api.presentationservices.client.PageEngineClient: Renders a file-based template using both the iKnowBase-provided model objects and the model supplied with the method call, giving priority to the latter.
renderTemplate(PresentationServicesClient, String, Map<String, ?>) - Method in interface com.iknowbase.api.presentationservices.page.PageService: Renders a file-based template using both the iKnowBase-provided model objects and the model supplied with the method call, giving priority to the latter.
request() - Method in interface com.iknowbase.api.presentationservices.functions.FunctionsClient: Creates a FunctionsRequest.
RequestModel - Interface in com.iknowbase.api.presentationservices.model.common
ResourceModel - Interface in com.iknowbase.api.presentationservices.model.page
run() - Method in interface com.iknowbase.api.presentationservices.page.PageRunner
run(HttpServletRequest) - Method in interface com.iknowbase.api.presentationservices.portlet.Form.Runner
run() - Method in interface com.iknowbase.api.presentationservices.portlet.PortletRunner: Runs the portlet, using the specified configuration
run(PresentationServicesClient) - Method in interface com.iknowbase.api.presentationservices.template.TemplateRunner
run() - Method in interface com.iknowbase.api.presentationservices.template.TemplateRunner
runner() - Method in interface com.iknowbase.api.presentationservices.page.PageService: Returns a PageRunner useful for running a page
runner() - Method in interface com.iknowbase.api.presentationservices.portlet.Form.Portlet

S

save() - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor: Saves the document using the document identifier found in the form bean.
save(Integer) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor: Saves the document using a given document ID
service(String) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionRequest: Returns a copy of this FunctionRequest, with the specified serviceName
setSessionAttribute(String, Serializable) - Method in interface com.iknowbase.api.presentationservices.PresentationServicesRequest
SocialAuthenticationModel - Interface in com.iknowbase.api.presentationservices.model.common
SolrSearchClient - Interface in com.iknowbase.api.presentationservices.client: SolrSearchClient is a client service object enabling easy access to the Solr search services integrated with iKnowBase.
SolrSearchClientProvider - Interface in com.iknowbase.api.presentationservices.client: A client service object enabling easy access to the SolrSearchClient objects configured in the current repository.
SpringMvcPageEngineClient - Interface in com.iknowbase.api.presentationservices.client: SpringMvcPageEngineClient is a client service object enabling easy access to page engine functionality.
startProcessDefinitionId(String) - Method in interface com.iknowbase.api.presentationservices.portlet.Form.Runner
StringsModel - Interface in com.iknowbase.api.presentationservices.model.common
submit(FunctionRequest) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionsClient: Submits a request for execution by the Functions engine.
submit(String) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionsClient: Submits a request for execution by the Functions engine.
submitAndWaitForResponse(String, Duration) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionsClient: Submits a request for execution by the Functions engine and waits for a response.
submitAndWaitForResponse(FunctionRequest, Duration) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionsClient: Submits a request for execution by the Functions engine and waits for a response.
submitPage(String) - Method in interface com.iknowbase.api.presentationservices.client.SpringMvcPageEngineClient: Deprecated.

T

TargetAfterInsert - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for method that returns the target after insert new document.
TargetAfterUpdate - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for method that returns the target after update existing document.
taskId(String) - Method in interface com.iknowbase.api.presentationservices.portlet.Form.Runner
template(String) - Method in interface com.iknowbase.api.presentationservices.portlet.Form.Builder
template(Path) - Method in interface com.iknowbase.api.presentationservices.template.TemplateRunner
template(File) - Method in interface com.iknowbase.api.presentationservices.template.TemplateRunner
template(String) - Method in interface com.iknowbase.api.presentationservices.template.TemplateRunner
TemplateResult - Interface in com.iknowbase.api.presentationservices.template
TemplateRunner - Interface in com.iknowbase.api.presentationservices.template
timeToLive(Duration) - Method in interface com.iknowbase.api.presentationservices.functions.FunctionRequest: Returns a copy of this FunctionRequest, with the specified timeToLive

U

Update - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for method that handles the "Save" / "Submit" event for a Form for existing documents.
UpdateTemplate - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for method that returns the template to be used by a Form for existing documents
UserModel - Interface in com.iknowbase.api.presentationservices.model.common
username(String) - Method in interface com.iknowbase.api.presentationservices.page.PageRunner
UserTokenModel - Interface in com.iknowbase.api.presentationservices.model.common

V

Validate - Annotation Type in com.iknowbase.api.presentationservices.form.annotation: Marker annotation for methods that needs to be invoked after initial generic validation and validation of insert/update groups.
validate(BindingResult) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessor
valueOf(String) - Static method in enum com.iknowbase.api.presentationservices.form.annotation.Form.BINDING_MODE: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.iknowbase.api.presentationservices.functions.FunctionResponse.STATUS: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.iknowbase.api.presentationservices.form.annotation.Form.BINDING_MODE: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.iknowbase.api.presentationservices.functions.FunctionResponse.STATUS: Returns an array containing the constants of this enum type, in the order they are declared.

W

withAdditionalSupportedArguments(Object...) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder: Add additional objects that may be used as arguments in @IKBBefore/After injected methods.
withFormGuid(String) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder: Specify Form GUID to store on documents.
withMessageSource(MessageSource) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder: Explicitly add a message source accessor for resolving properties.
withValidator(Validator) - Method in interface com.iknowbase.api.presentationservices.form.FormProcessorBuilder: Add a validator to use during custom validation using @Validate callback.

A B C D E F G I L M N O P Q R S T U V W