A B C D E F G I L P S T V W

A

addCriteria(BrokerCriteria) - Method in interface com.sdl.web.api.broker.querying.criteria.BrokerCriteria

Add criteria to the current BrokerCriteria, as a nested Child.

addFromStatement(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerQueryConstructor

This adds the from part of the broker query.

addItem(Object) - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResultRow

This adds a result item to this query result row.

addLinkRequest(BatchLinkRequest) - Method in interface com.sdl.web.api.linking.BatchLinkRetriever

Add a link request to be executed in a batch.

addOrderStatement(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerQueryConstructor

This adds the order part of the broker query.

addQueryParameters(Map<String, Object>) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerQueryConstructor

This adds the query parameters needed for the broker query.

addResultRow(BrokerQueryResultRow) - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResult

This adds a result to the broker query.

addSelectStatement(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerQueryConstructor

This adds the select part of the broker query.

addSorting(BrokerSortParameter) - Method in interface com.sdl.web.api.broker.querying.BrokerQuery

Apply sorting parameter to query.

addSortParameter(BrokerSortParameter) - Method in interface com.sdl.web.api.broker.querying.sorting.BrokerSorting

Adds a sorting parameter to the Sorting container.

addWhereStatement(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerQueryConstructor

This adds the condition part of the broker query.

assembleQuery() - Method in interface com.sdl.web.api.broker.querying.generators.BrokerQueryConstructor

This assembles the full broker query.

assembleTaxonomy(String, String, boolean, boolean, boolean, String, String) - Method in interface com.sdl.web.api.dynamic.WebTaxonomyAssembler

Assembles a taxonomy by creating a view of it and displaying it in a basic way using constructs.

assembleTaxonomy(String, String[], Keyword[], String, boolean, boolean, boolean, String, String) - Method in interface com.sdl.web.api.dynamic.WebTaxonomyAssembler

Assembles a taxonomy by creating a view of it and displaying it in a basic way using constructs.

B

BatchLinkRequest - Interface in com.sdl.web.api.linking

BatchLinkRequest.

BatchLinkRetriever - Interface in com.sdl.web.api.linking

The BatchLinkRetriever interface provides functionality to fetch multiple links in a single request.

BinaryContentRetriever - Interface in com.sdl.web.api.content

BinaryContentRetriever used to retrieve the binary data.

BinaryLink - Interface in com.sdl.web.api.linking

The BinaryLink interface provides functionality to link to a binary resource based on a tcm:uri.

BrokerCriteria - Interface in com.sdl.web.api.broker.querying.criteria

The BrokerCriteria provides the structure of the QueryTree, this is used by all query criteria and operators.

BrokerGeneratorStrategy - Interface in com.sdl.web.api.broker.querying.generators

This represents the strategy that all criteria, sorting elements need to provide so a broker query can be constructed.

BrokerQuery - Interface in com.sdl.web.api.broker.querying

The Criteria provides the structure of the QueryTree, this is used by all query criteria and operators.

BrokerQueryConstructor - Interface in com.sdl.web.api.broker.querying.generators

Broker Query Constructor.

BrokerQueryResult - Interface in com.sdl.web.api.broker.querying

Broker Query Result.

BrokerQueryResultRow - Interface in com.sdl.web.api.broker.querying

Broker Query Result Row.

BrokerQueryService - Interface in com.sdl.web.api.broker.querying.generators.service

This is the BrokerQueryService responsible for executing the broker query.

BrokerResultFilter - Interface in com.sdl.web.api.broker.querying.filter

This is the Interface all ResultFilters must inherit making it possible to use them in the Broker Query mechanism.

BrokerSortColumn - Interface in com.sdl.web.api.broker.querying.sorting

This represents the sorting column which can be used in the broker Query API to sort the result on.

BrokerSortDirection - Interface in com.sdl.web.api.broker.querying.sorting

This represents the sorting direction which can be used in sorting the Broker results.

BrokerSorting - Interface in com.sdl.web.api.broker.querying.sorting

Broker Sorting.

BrokerSortParameter - Interface in com.sdl.web.api.broker.querying.sorting

This is a sorting parameter used to order results in the BrokerQuerying.

build() - Method in interface com.sdl.web.api.dynamic.FilterQueryStringParameter

Transform filter hierarchy into String representation.

C

clearRequestData() - Method in interface com.sdl.web.api.linking.BatchLinkRetriever

Clears all data held by the retriever.

com.sdl.web.api.broker.querying - package com.sdl.web.api.broker.querying

com.sdl.web.api.broker.querying.criteria - package com.sdl.web.api.broker.querying.criteria

com.sdl.web.api.broker.querying.filter - package com.sdl.web.api.broker.querying.filter

com.sdl.web.api.broker.querying.generators - package com.sdl.web.api.broker.querying.generators

com.sdl.web.api.broker.querying.generators.service - package com.sdl.web.api.broker.querying.generators.service

com.sdl.web.api.broker.querying.sorting - package com.sdl.web.api.broker.querying.sorting

com.sdl.web.api.content - package com.sdl.web.api.content

com.sdl.web.api.dynamic - package com.sdl.web.api.dynamic

com.sdl.web.api.dynamic.formatter - package com.sdl.web.api.dynamic.formatter

com.sdl.web.api.dynamic.mapping - package com.sdl.web.api.dynamic.mapping

com.sdl.web.api.dynamic.taxonomies - package com.sdl.web.api.dynamic.taxonomies

com.sdl.web.api.dynamic.taxonomies.filters - package com.sdl.web.api.dynamic.taxonomies.filters

com.sdl.web.api.linking - package com.sdl.web.api.linking

com.sdl.web.api.meta - package com.sdl.web.api.meta

ComponentLink - Interface in com.sdl.web.api.linking

The ComponentLink interface provides functionality to validate and resolve links to ComponentPresentations on Pages.

D

DynamicComponentLink - Interface in com.sdl.web.api.linking

The DynamicComponentLink validates links to Dynamic Component Presentations on Pages.

DynamicMappingsRetriever - Interface in com.sdl.web.api.dynamic

DynamicMappingsRetriever.

DynamicMetaRetriever - Interface in com.sdl.web.api.dynamic

DynamicMetaRetriever.

E

executeEntityQuery() - Method in interface com.sdl.web.api.broker.querying.BrokerQuery

Execute the Broker query.

executeQuery() - Method in interface com.sdl.web.api.broker.querying.BrokerQuery

Execute the Broker query.

executeQuery(String, BrokerCriteria, BrokerSorting, BrokerResultFilter) - Method in interface com.sdl.web.api.broker.querying.generators.service.BrokerQueryService

This executes the actual broker query based on the given criteria, sorting and filter.

executeQuery(BrokerQueryConstructor, BrokerResultFilter) - Method in interface com.sdl.web.api.broker.querying.generators.service.BrokerQueryService

This executes the actual broker query based on the constructed query and resultFilter.

executeRequest() - Method in interface com.sdl.web.api.linking.BatchLinkRetriever

Executes a batch link request by querying for all the link request objects added using addLinkRequest.

F

FilterQueryStringParameter - Interface in com.sdl.web.api.dynamic

Represents one parameter for $filter query string operation when querying content service.

filterTaxonomyContext() - Method in interface com.sdl.web.api.dynamic.taxonomies.filters.WebTaxonomyFilter

This method is responsible for the building of a query used to retrieve a filtered taxonomy.

finalizeFiltering(List<Keyword>) - Method in interface com.sdl.web.api.dynamic.formatter.WebTaxonomyFormatter

This is the method that defines the format of the Taxonomy, it must return a single branch/fragment of the original Taxonomy in whatever structure desired.

findAllComponentPresentations(int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Retrieve a list of all component presentations for a component.

findAllComponentPresentations(int, int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Retrieve a list of all component presentations for a component.

findAllComponentPresentations(String) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Retrieve a list of all component presentations for a component.

findAllReferencingPages(String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Finds all referencing pages for the specified Binary URI.

findAllReferencingPages(String, String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Finds all referencing pages for the specified Binary URI and its variantId.

G

generateQuery(String, BrokerCriteria, BrokerSorting) - Method in interface com.sdl.web.api.broker.querying.generators.service.BrokerQueryService

This generates the main broker query needed to execute the JPQL query.

getAllMeta() - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Finds all the PublicationMeta's.

getAnchor() - Method in interface com.sdl.web.api.linking.Link

Returns the anchor for this link.

getAttributes() - Method in interface com.sdl.web.api.linking.Link

Returns the attributes for this link.

getBinary(int, int, String) - Method in interface com.sdl.web.api.content.BinaryContentRetriever

Get binary content.

getBinary(String) - Method in interface com.sdl.web.api.content.BinaryContentRetriever

Gets from the Broker storage the default binary (with empty variantId) that has the given uri.

getBinary(String, String) - Method in interface com.sdl.web.api.content.BinaryContentRetriever

Gets from the Broker storage the binary that has the given uri and the given variantId.

getBinary(int, int) - Method in interface com.sdl.web.api.content.BinaryContentRetriever

Gets from the Broker storage the default binary (with empty variantId) from a given publication and with a certain binaryId.

getBinaryMetaByURL(String) - Method in interface com.sdl.web.api.dynamic.DynamicMetaRetriever

Returns the BinaryMeta object in the Publication identified by the publicationId parameter which has the URL Path as passed by the urlPath parameter.

getComponentPresentation(int, int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get a component presentation.

getComponentPresentation(String, String) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get a component presentation.

getComponentPresentation(int, int, int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get a component presentation.

getComponentPresentationWithHighestPriority(int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get the component presentation for a component that has the highest priority.

getComponentPresentationWithHighestPriority(String) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get the component presentation for a component that has the highest priority.

getComponentPresentationWithLowestPriority(int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get the component presentation for a component that has the lowest priority.

getComponentPresentationWithLowestPriority(String) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get the component presentation for a component that has the lowest priority.

getComponentPresentationWithOutputFormat(int, String) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get a component presentation for a component, with the given output format.

getComponentPresentationWithOutputFormat(String, String) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get a component presentation for a component, with the given output format.

getComponentPresentationWithPriority(int, int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get a component presentation for a component, with the specified priority.

getComponentPresentationWithPriority(String, int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Get a component presentation for a component, with the specified priority.

getContent(String) - Method in interface com.sdl.web.api.dynamic.PageContentAssembler

getContent(String, Map<String, String>) - Method in interface com.sdl.web.api.dynamic.PageContentAssembler

Get rendered content for specified page URI and passed in variable maps.

getContent(int, int) - Method in interface com.sdl.web.api.dynamic.PageContentAssembler

Getting rendered content for specific page determined by publication id and page id.

getContent(int, int, Map<String, String>) - Method in interface com.sdl.web.api.dynamic.PageContentAssembler

Getting rendered content for specific page determined by publication id and page id.

getContent(int, int) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationAssembler

Returns the content of a Dynamic Component Presentation.

getContent(int, int, Map<String, String>) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationAssembler

Returns the content of a Dynamic Component Presentation.

getContent(String, String, Map<String, String>) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationAssembler

Returns the content of a Dynamic Component Presentation.

getContent(String, String) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationAssembler

Returns the content of a Dynamic Component Presentation.

getCriteria() - Method in interface com.sdl.web.api.broker.querying.BrokerQuery

Retrieves the Criteria applied to this Query.

getCriteriaChildren() - Method in interface com.sdl.web.api.broker.querying.criteria.BrokerCriteria

Returns a list of children for the Criteria.

getCriteriaName() - Method in interface com.sdl.web.api.broker.querying.criteria.BrokerCriteria

Returns criteria name.

getDomain() - Method in interface com.sdl.web.api.dynamic.mapping.PublicationMapping

Gets the domain name for the mapping.

getFieldOperatorAsString() - Method in interface com.sdl.web.api.broker.querying.criteria.BrokerCriteria

Get field operator as String.

getFilterName() - Method in interface com.sdl.web.api.dynamic.taxonomies.filters.WebTaxonomyFilter

This returns the name of the Filter.

getFrom(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerGeneratorStrategy

This generates the from part of the broker query, this indicates on which entities conditions can be applied.

getItem(Class<T>) - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResultRow

This allows retrieval of an entity from this broker query result row.

getItemURI() - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResultRow

This retrieves the itemURI of the item representing this result row.

getLink(String) - Method in interface com.sdl.web.api.linking.BatchLinkRetriever

Returns a link object (if present) from the result available from executing the query by passing unique identifier obtained when adding a link request.

getLink(String, String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.BinaryLink

The getLink method tries to find the location of the binary and wraps this location in a Link object.

getLink(String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.BinaryLink

The getLink method tries to find the location of the binary and wraps this location in a Link object.

getLink(String, String, String, String, String, boolean, boolean) - Method in interface com.sdl.web.api.linking.ComponentLink

Tries to create a link to a suitable component presentation on a page and returnes this as a Link object.

getLink(int) - Method in interface com.sdl.web.api.linking.ComponentLink

Gets a URL to the first page that is found containing the requested targetComponentId.

getLink(String) - Method in interface com.sdl.web.api.linking.ComponentLink

Gets a URL to the first page that is found containing the requested targetComponentId.

getLink(int, int, int, String, String, boolean, boolean) - Method in interface com.sdl.web.api.linking.ComponentLink

Tries to create a link to a suitable component presentation on a page and returns this as a Link object.

getLink(int, int, int, String, String, boolean) - Method in interface com.sdl.web.api.linking.DynamicComponentLink

This method tries to validate a link to a Dynamic Component Presentation on a Page.

getLink(String, String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.DynamicComponentLink

This method tries to validate a link to a Dynamic Component Presentation on a Page.

getLink(int) - Method in interface com.sdl.web.api.linking.PageLink

Create a new Link object targeting a page with just a page Id.

getLink(String) - Method in interface com.sdl.web.api.linking.PageLink

Create a new Link object targeting a page with just a page URI.

getLink(int, String, String, String, boolean, String) - Method in interface com.sdl.web.api.linking.PageLink

Create a Link object targeting a page.

getLink(int, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.PageLink

Create a Link object targeting a page.

getLink(String, String, String, String, String, boolean, String) - Method in interface com.sdl.web.api.linking.PageLink

Create a page link as a String a tcm:uri.

getLink(String, String, String, String, boolean, String) - Method in interface com.sdl.web.api.linking.PageLink

Create a page link using a tcm:uri.

getLink(String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.PageLink

Create a page link using a tcm:uri.

getLinkAsString(String, String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.BinaryLink

The getLinkAsString method calls the getLink method to create a link object.

getLinkAsString(String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.BinaryLink

The getLinkAsString method calls the getLink method to create a link object.

getLinkAsString(int, int, int, String, String, boolean) - Method in interface com.sdl.web.api.linking.ComponentLink

Calls the public method getLinkAsString with an additional parameter for the anchor with the value false.

getLinkAsString(int, int, int, String, String, boolean, boolean) - Method in interface com.sdl.web.api.linking.ComponentLink

Creates a new Link instance and returnes this as a String.

getLinkAsString(String, String, String, String, String, boolean, boolean) - Method in interface com.sdl.web.api.linking.ComponentLink

Creates a new Link instance and returns this as a String.

getLinkAsString(String, String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.ComponentLink

Tries to create a link to a suitable component presentation on a page and returns this as a Link object.

getLinkAsString(String, String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.DynamicComponentLink

This method tries to validate a link to a Dynamic Component Presentation on a Page.

getLinkAsString(int, int, int, String, String, boolean) - Method in interface com.sdl.web.api.linking.DynamicComponentLink

This method tries to validate a link to a Dynamic Component Presentation on a Page.

getLinkAsString(int, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.PageLink

Create a page link as a String.

getLinkAsString(int, String, String, String, boolean, String) - Method in interface com.sdl.web.api.linking.PageLink

Create a page link as a String, using a tcm:uri.

getLinkAsString(String, String, String, String, boolean, String) - Method in interface com.sdl.web.api.linking.PageLink

Create a page link as a String, using a tcm:uri.

getLinkAsString(String, String, String, String, boolean) - Method in interface com.sdl.web.api.linking.PageLink

Create a page link as a String using a tcm:uri.

getLinkRequestParams() - Method in interface com.sdl.web.api.linking.BatchLinkRequest

Get batch link request parameters.

getMeta(String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Finds the Binary metadata for the specified URI.

getMeta(String, String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Finds the Binary metadata for the specified URI.

getMeta(int) - Method in interface com.sdl.web.api.meta.WebComponentMetaFactory

Returns the ComponentMeta for a component with id [componentId] in the publication of this ComponentMetaFactory instance.

getMeta(String) - Method in interface com.sdl.web.api.meta.WebComponentMetaFactory

Returns the ComponentMeta for a component with TCMURI [componentId] in the publication of this ComponentMetaFactory instance.

getMeta(int, int) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

Returns the ComponentPresentationMeta for the given [componentId] and [componentTemplateId] with the publication of this ComponentPresentationMetaFactory instance.

getMeta(String, String) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

Returns the ComponentPresentationMeta for the given [componentURI] and [componentTemplateURI] with the publication of this ComponentPresentationMetaFactory instance.

getMeta(int) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Return the PageMeta for the given page item id within the publication this PageMetaFactory was created with.

getMeta(String) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Return the PageMeta for the given page TCMURI within the publication this PageMetaFactory was created with.

getMeta(int) - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Find PublicationMeta by publication id.

getMeta(String) - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Find PublicationMeta by publication id.

getMetaByComponent(String) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

Return a collection of ComponentPresentationMeta's available for the given component.

getMetaByKey(String) - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Find PublicationMeta's by publication key.

getMetaByMultimediaPath(String) - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Find PublicationMeta's by publication's multimedia path.

getMetaByMultimediaUrl(String) - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Find PublicationMeta's by publication's multimedia url.

getMetaByPublicationPath(String) - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Find PublicationMeta's by publication path.

getMetaByPublicationUrl(String) - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Find PublicationMeta's by publication url.

getMetaByTitle(String) - Method in interface com.sdl.web.api.meta.WebPublicationMetaFactory

Find PublicationMeta's by publication title.

getMetaByURL(String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Returns all BinaryMeta objects which exactly match the URL Path passed as the urlPath parameter.

getMetaByURL(int, String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Returns the BinaryMeta object in the Publication identified by the publicationId parameter which has the URL Path as passed by the urlPath parameter.

getMetaByURL(String, String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Returns the BinaryMeta object in the Publication identified by the publicationURI parameter which has the URL Path as passed by the urlPath parameter.

getMetaByURL(String) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Returns all PageMeta objects which exactly match the URL Path passed as the urlPath parameter.

getMetaByURL(int, String) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Returns the PageMeta object in the Publication identified by the publicationId parameter which has the URL Path as passed by the urlPath parameter.

getMetaByURL(String, String) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Returns the PageMeta object in the Publication identified by the publicationURI parameter which has the URL Path as passed by the urlPath parameter.

getMetas(String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Finds the Binary metadata for the specified URI and all of its variants as a collection.

getOrder(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerGeneratorStrategy

This generates the ordering part of the broker query, this indicates on which entities conditions can be applied.

getPageContent(int, int) - Method in interface com.sdl.web.api.content.PageContentRetriever

Get page content.

getPageContent(String) - Method in interface com.sdl.web.api.content.PageContentRetriever

Get page content.

getPageMetaByURL(String) - Method in interface com.sdl.web.api.dynamic.DynamicMetaRetriever

Returns the PageMeta object in the Publication identified by the publicationId parameter which has the URL Path as passed by the urlPath parameter.

getParameters() - Method in interface com.sdl.web.api.linking.Link

Returns the QueryString for this link.

getParams(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerGeneratorStrategy

This returns the parameters needed for the strategy.

getPath() - Method in interface com.sdl.web.api.dynamic.mapping.PublicationMapping

Gets the publication path for the mapping.

getPathScanDepth() - Method in interface com.sdl.web.api.dynamic.mapping.PublicationMapping

Gets the publication path scan depth for the mapping.

getPort() - Method in interface com.sdl.web.api.dynamic.mapping.PublicationMapping

Gets the TCP port number for the mapping.

getProtocol() - Method in interface com.sdl.web.api.dynamic.mapping.PublicationMapping

Gets the TCP protocol for the mapping.

getPublicationId() - Method in interface com.sdl.web.api.dynamic.mapping.PublicationMapping

Gets the publication ID for the mapping.

getPublicationMapping(String) - Method in interface com.sdl.web.api.dynamic.DynamicMappingsRetriever

Gets the Publication mapping for a given URL.

getPublicationUrls(int) - Method in interface com.sdl.web.api.dynamic.DynamicMappingsRetriever

Gets a list of Publication URLs for a given Publication ID.

getQueryParameters() - Method in interface com.sdl.web.api.broker.querying.generators.BrokerQueryConstructor

This returns the full map of the all the parameters needed in the broker query.

getResultIds() - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResult

This returns a list of found result tcmuri's.

getResultItems() - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResultRow

Gets the result items.

getResultRows() - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResult

This returns all the detailed result rows found for the broker query.

getResults(Class<T>) - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResult

This returns all the detailed result rows found for the broker query.

getSchema(int, int) - Method in interface com.sdl.web.api.meta.WebSchemaFactory

Provides the schema data.

getSchemas(int) - Method in interface com.sdl.web.api.meta.WebSchemaFactory

Provides all the schemas for a publication.

getSchemas() - Method in interface com.sdl.web.api.meta.WebSchemaFactory

Provides all the schemas in storage.

getSelect(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerGeneratorStrategy

This generates the select part of the broker Query.

getSignature() - Method in interface com.sdl.web.api.broker.querying.criteria.BrokerCriteria

Returns unique signature of the criteria.

getSortColumn() - Method in interface com.sdl.web.api.broker.querying.sorting.BrokerSortColumn

Returns SortColumn enum.

getSortColumn() - Method in enum com.sdl.web.api.broker.querying.sorting.SortColumn

getSortingColumn() - Method in interface com.sdl.web.api.broker.querying.sorting.BrokerSortParameter

Returns the sorting column to sort on for the results.

getSortingDirection() - Method in interface com.sdl.web.api.broker.querying.sorting.BrokerSortParameter

Returns the direction on which to sort the results.

getSortingName() - Method in interface com.sdl.web.api.broker.querying.sorting.BrokerSortColumn

Get a sorting name.

getSortingName() - Method in enum com.sdl.web.api.broker.querying.sorting.SortColumn

getSortingParameters() - Method in interface com.sdl.web.api.broker.querying.sorting.BrokerSorting

Returns all the sorting parameters.

getSQLSortDirection() - Method in interface com.sdl.web.api.broker.querying.sorting.BrokerSortDirection

Returns SQL sort direction String representation.

getSQLSortDirection() - Method in enum com.sdl.web.api.broker.querying.sorting.SortDirection

getStorageId() - Method in interface com.sdl.web.api.broker.querying.generators.service.BrokerQueryService

Returns the storageId that the queryService will query.

getTargetURI() - Method in interface com.sdl.web.api.linking.Link

Returns the tcm:uri if the Item targeted by this link.

getTaxonomies(String) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This method retrieves a list of Taxonomies, and returns the TCMURI as String.

getTaxonomyComponentPresentationMetas(Keyword, String, boolean) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

This retrieves all ComponentPresentationMetas for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.

getTaxonomyComponentPresentationMetas(Keyword[], String, boolean) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

This retrieves all ComponentPresentationMetas for the specified taxonomy keywords, either directly linked to the keyword or a branch/child of the specified keyword.

getTaxonomyComponentPresentations(Keyword, String, boolean) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

This retrieves all ComponentPresentations for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.

getTaxonomyComponentPresentations(Keyword[], String, boolean) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

This retrieves all ComponentPresentations for the specified taxonomy keyword, either directly linked to the keyword or a branch/child of the specified keyword.

getTaxonomyKeyword(String) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This allows the retrieval of a specific keyword in a specific Taxonomy.

getTaxonomyKeywords(String) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This retrieves a taxonomy and returns a tree of Keywords.

getTaxonomyKeywords(String, WebTaxonomyFormatter) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This retrieves a taxonomy and returns a tree of Keywords.

getTaxonomyKeywords(String, WebTaxonomyFilter) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This retrieves a specific Taxonomy and applies a set of Filters on this Taxonomy.

getTaxonomyKeywords(String, WebTaxonomyFilter, WebTaxonomyFormatter) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This retrieves a specific Taxonomy and applies a set of Filters on this Taxonomy.

getTaxonomyKeywords(String, WebTaxonomyFilter, String) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This retrieves a Taxonomy from the specified Keyword and applies a set of Filters on this Taxonomy.

getTaxonomyKeywords(String, WebTaxonomyFilter, String, WebTaxonomyFormatter) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This retrieves a Taxonomy from the specified Keyword and applies a set of Filters on this Taxonomy.

getTaxonomyKeywords(String, WebTaxonomyFilter, String, Keyword[]) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This retrieves a specific Taxonomy from a specified Context Keyword and applies a set of Filters on this Taxonomy.

getTaxonomyKeywords(String, WebTaxonomyFilter, String, Keyword[], WebTaxonomyFormatter) - Method in interface com.sdl.web.api.dynamic.taxonomies.WebTaxonomyFactory

This retrieves a specific Taxonomy from a specified Context Keyword and applies a set of Filters on this Taxonomy.

getTaxonomyKeywords(String, Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String[], Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String, String, Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String, String[], Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.dynamic.WebComponentPresentationFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String[], Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String, Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String, String, Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String, String[], Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.meta.WebComponentPresentationMetaFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String, Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String[], Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String, String, Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyKeywords(String, String[], Keyword[], WebTaxonomyFilter) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

Retrieves the Taxonomy Keywords for a number of content items and applies a taxonomyFilter to retrieve more related keywords.

getTaxonomyPages(Keyword, boolean) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

This returns all the pagemetas for pages related to the specified taxonomy facet.

getTaxonomyPages(Keyword[], boolean) - Method in interface com.sdl.web.api.meta.WebPageMetaFactory

This returns all the pagemetas for pages related to the specified taxonomy facets.

getText() - Method in interface com.sdl.web.api.linking.Link

Returns the link text for this link.

getTextOnFail() - Method in interface com.sdl.web.api.linking.Link

Returns the textOnFail value, which indicates if the link will return text if the targeted URI cannot be resolved or validated.

getURL() - Method in interface com.sdl.web.api.linking.Link

Returns the URL of the resolved item.

getVariants(int, String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Returns all BinaryMeta objects for the given publication that have the share the given variantId.

getVariants(String, String) - Method in interface com.sdl.web.api.meta.WebBinaryMetaFactory

Returns all BinaryMeta objects for the given publication that have the share the given variantId.

getWhere(String) - Method in interface com.sdl.web.api.broker.querying.generators.BrokerGeneratorStrategy

This generates the condition part of the broker query, this indicates on which entities conditions can be applied.

I

isOperator() - Method in interface com.sdl.web.api.broker.querying.criteria.BrokerCriteria

Returns if this BrokerCriteria is an operator.

isResolved() - Method in interface com.sdl.web.api.linking.Link

Indicates if this link has been resolved and is targeting a valid URL.

L

Link - Interface in com.sdl.web.api.linking

The future Link object is a bean that holds information about a link to a tridion resource.

LOG - Static variable in interface com.sdl.web.api.linking.PageLink

Logger for PageLink.

P

PageContentAssembler - Interface in com.sdl.web.api.dynamic

PageContentAssembler.

PageContentRetriever - Interface in com.sdl.web.api.content

PageContentRetriever used to retrieve the raw content of pages.

PageLink - Interface in com.sdl.web.api.linking

The PageLink class provides functionality to validate and resolve links to Pages.

PublicationMapping - Interface in com.sdl.web.api.dynamic.mapping

PublicationMapping.

S

setAnchor(String) - Method in interface com.sdl.web.api.linking.Link

Sets the anchor of this Link instance.

setAttributes(String) - Method in interface com.sdl.web.api.linking.Link

Sets the attributes for this Link instance.

setCriteria(BrokerCriteria) - Method in interface com.sdl.web.api.broker.querying.BrokerQuery

Sets the Criteria to apply to the Query, the CriteriaBuilder can be used to build a set of Criteria.

setItemURI(TCMURI) - Method in interface com.sdl.web.api.broker.querying.BrokerQueryResultRow

This sets the itemURI for the found resultRow.

setParameters(String) - Method in interface com.sdl.web.api.linking.Link

Sets the QueryString of this Link instance.

setResultFilter(BrokerResultFilter) - Method in interface com.sdl.web.api.broker.querying.BrokerQuery

Sets the result filter to the Query.

setText(String) - Method in interface com.sdl.web.api.linking.Link

Sets the link text for this Link instance.

setTextOnFail(boolean) - Method in interface com.sdl.web.api.linking.Link

Sets the textOnFail property for this Link instance.

setURL(String) - Method in interface com.sdl.web.api.linking.Link

Sets the URL of this Link instance.

SortColumn - Enum in com.sdl.web.api.broker.querying.sorting

This represents the sorting column which can be used in the broker Query API to sort the result date on.

SortDirection - Enum in com.sdl.web.api.broker.querying.sorting

This represents the sorting direction which can be used in sorting the Broker results.

T

toTaxonomyFilterUriRepresentation() - Method in interface com.sdl.web.api.dynamic.taxonomies.filters.WebTaxonomyFilter

Return the URI representation of TaxonomyFilter.

V

valueOf(String) - Static method in enum com.sdl.web.api.broker.querying.sorting.SortColumn

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.sdl.web.api.broker.querying.sorting.SortDirection

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.sdl.web.api.broker.querying.sorting.SortColumn

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.sdl.web.api.broker.querying.sorting.SortDirection

Returns an array containing the constants of this enum type, in the order they are declared.

W

WebBinaryMetaFactory - Interface in com.sdl.web.api.meta

The BinaryMetaFactory class loads Binary metadata from the Broker based on the specified tcm:uri of a binary.

WebComponentMetaFactory - Interface in com.sdl.web.api.meta

Provides access to ComponentMeta that can be obtained using a component item id or component tcm uri Each instance is specifically linked to a publication when an instance is created.

WebComponentPresentationAssembler - Interface in com.sdl.web.api.dynamic

The ComponentPresentationAssembler allows you to assemble Dynamic Component Presentations.

WebComponentPresentationFactory - Interface in com.sdl.web.api.dynamic

Interface used to retrieve the raw content of component presentations.

WebComponentPresentationMetaFactory - Interface in com.sdl.web.api.meta

Provides access to ComponentPresentationMeta that can be obtained using the combination of a component and template id, specified either as a numbers or as TCM URIs.

WebPageMetaFactory - Interface in com.sdl.web.api.meta

Provides access to PageMeta that can be obtained using a page Id or TCM URI or it's URL.

WebPublicationMetaFactory - Interface in com.sdl.web.api.meta

Provides access to PublicationMeta that can be obtained using a publication id, title, key, or any other property.

WebSchemaFactory - Interface in com.sdl.web.api.meta

The schema factory is responsible for providing information about schemas in the storage.

WebTaxonomyAssembler - Interface in com.sdl.web.api.dynamic

Assembler interfaces for the taxonomy.

WebTaxonomyFactory - Interface in com.sdl.web.api.dynamic.taxonomies

This is the WebTaxonomyFactory interface responsible for retrieving Taxonomies.

WebTaxonomyFilter - Interface in com.sdl.web.api.dynamic.taxonomies.filters

This is the interface class implemented by all TaxonomyFilters, used to construct a filtering query for taxonomies.

WebTaxonomyFormatter - Interface in com.sdl.web.api.dynamic.formatter

This is the interface used to define Taxonomy Formatter used to build Taxonomy hierarchy.

A B C D E F G I L P S T V W