Package com.priint.pubserver.plugin.interfaces

Interface ConnectorRemote

  • All Superinterfaces:
    PluginControl
    All Known Subinterfaces:
    ConnectorLocal
    All Known Implementing Classes:
    AbstractConnector
    public interface ConnectorRemote
extends PluginControl
    Interface for a connector class designed for connecting publishing hub with a content system.

    If a connector does not want to give a specific implementation of a method, it is expected to throw a com.priint.pubserver.plugin.exceptions.NotImplementedException.

    Since:
    4.0.0, 4.1.6 added several overloadings for methods to get content for a bucket (added a parentEntityIdentifier parameter).
    See Also:
    com.priint.pubserver.plugin.exception#NotImplementedException(java.lang.Class, java.lang.String)

    • Method Detail

      • getRootBuckets

        java.util.List<Bucket> getRootBuckets​(Context context,
                                      ConnectorEntity connectorEntity,
                                      java.lang.String searchStr)
                               throws NotImplementedException,
                                      DataSourceException,
                                      ConnectorException
        Returns the top level nodes from an hierarchy.
        Parameters:
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all matching root buckets or an empty list if no matching root buckets are found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getChildBuckets

        java.util.List<Bucket> getChildBuckets​(java.lang.String bucketId,
                                       Context context,
                                       ConnectorEntity connectorEntity,
                                       java.lang.String parentBucketConnectorEntity,
                                       java.lang.String searchStr)
                                throws NotImplementedException,
                                       DataSourceException,
                                       ConnectorException
        Get the subordinated buckets for a given bucket.
        Parameters:
        bucketId - The ID of the source bucket of all subordinated buckets.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        parentBucketConnectorEntity - A content system specific hint used to find the parent bucket, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label (e.g. part of con_bucket.label) or value field of the content.
        Implementation may be connector specific.
        Returns:
        List of all subordinated buckets from one given bucket or
        an empty list if no matching buckets are found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getCordedBuckets

        java.util.List<Bucket> getCordedBuckets​(java.lang.String bucketId,
                                        Context context,
                                        ConnectorRemote.Direction directed,
                                        ConnectorEntity connectorEntity,
                                        java.lang.String searchStr)
                                 throws NotImplementedException,
                                        DataSourceException,
                                        ConnectorException
        Get buckets which are connected via cords.

        The cords are directional connections. That means: A cord points from a source bucket to a destination bucket. Therefore you have to decide which buckets to return:

        • the buckets where the current bucket points to
        • the buckets which points to the current bucket
        • both of them
        Parameters:
        bucketId - Id of the source bucket in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        directed - Indication if only the buckets needed which point away from or point to the source bucket or both.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label (e.g. part of con_bucket.label) or value field of the content.
        Implementation may be connector specific.
        Returns:
        List of buckets which are connected with the source bucket via cords or an empty list if no matching buckets are found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getBucketsByGroupIdentifier

        java.util.List<Bucket> getBucketsByGroupIdentifier​(java.lang.String groupIdentifier,
                                                   Context context,
                                                   ConnectorEntity connectorEntity,
                                                   java.lang.String searchStr)
                                            throws NotImplementedException,
                                                   DataSourceException,
                                                   ConnectorException
        Searching for buckets via group identifier and optional context, connectorEntity and label.
        Parameters:
        groupIdentifier - Group identifier of the bucket.
        The group identifier must NOT be unique. Associated with the context it will be unique.
        If no context is indicated, all context variations will be given back.
        context - Optional context needed to get the language and the country of the context..
        connectorEntity - The connectorEntity for which buckets have to give out.
        searchStr - Optional part of con_bucket.label, the internal name of the container.
        Returns:
        A List of matching buckets or
        an empty list if no matching buckets are found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getBucketsByIdentifier

        java.util.List<Bucket> getBucketsByIdentifier​(java.lang.String identifier,
                                              Context context,
                                              ConnectorEntity connectorEntity,
                                              java.lang.String searchStr)
                                       throws NotImplementedException,
                                              DataSourceException,
                                              ConnectorException
        Searching for buckets via identifier and optional context, connectorEntity and label.
        Parameters:
        identifier - Identifier of the buckets in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        A List of matching buckets or
        an empty list if no matching buckets are found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getBuckets

        java.util.List<Bucket> getBuckets​(java.lang.String searchStr,
                                  Context context,
                                  ConnectorEntity connectorEntity)
                           throws NotImplementedException,
                                  DataSourceException,
                                  ConnectorException
        Searching for certain buckets via context and searchStr alone.
        Parameters:
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        Returns:
        List of all needed buckets or an empty list if no bucket has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getCordsOfBuckets

        java.util.List<Cord> getCordsOfBuckets​(java.lang.String bucketId,
                                       ConnectorEntity connectorEntity,
                                       Context context,
                                       ConnectorRemote.Direction directed,
                                       java.lang.String searchStr)
                                throws NotImplementedException,
                                       DataSourceException,
                                       ConnectorException
        Get cords of a bucket.

        The cords are directional connections. That means: A cord points from a source bucket to a destination bucket. Therefore you have to decide which cords to return:

        • the cords where the current bucket points to
        • the cords which points to the current bucket
        • both of them
        Parameters:
        bucketId - Id of the source bucket in the content system.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        context - Optional context needed to restrict the query to certain language, country, etc..
        directed - Indication if only the buckets needed which point away from or point to the source bucket or both.
        searchStr - Search pattern typically used for filtering the label (e.g. part of con_cord.label) or value field of the content.
        Implementation may be connector specific.
        Returns:
        A List of matching cords or an empty list if no matching cords are found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getCords

        java.util.List<Cord> getCords​(java.lang.String searchStr,
                              Context context,
                              ConnectorEntity connectorEntity)
                       throws NotImplementedException,
                              DataSourceException,
                              ConnectorException
        Searching for certain Cords via context and searchStr alone.
        Parameters:
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        Returns:
        List of all needed Cords or an empty list if no Cords has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getCordsByIdentifier

        default java.util.List<Cord> getCordsByIdentifier​(java.lang.String identifier,
                                                  Context context,
                                                  ConnectorEntity connectorEntity,
                                                  java.lang.String searchStr)
                                           throws NotImplementedException,
                                                  DataSourceException,
                                                  ConnectorException
        Get cord by its identifier.
        Parameters:
        identifier - Identifier of the searched cords in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all needed cords or an empty list if no cords has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getTextsOfBucket

        java.util.List<Text> getTextsOfBucket​(java.lang.String parentBucketId,
                                      Context context,
                                      ConnectorEntity connectorEntity,
                                      java.lang.String searchStr)
                               throws NotImplementedException,
                                      DataSourceException,
                                      ConnectorException
        Get texts for a given bucket.
        Parameters:
        parentBucketId - Id of the source bucket in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all texts from a given bucket or an empty list if the bucket has no texts matching context and searchStr.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getTexts

        java.util.List<Text> getTexts​(java.lang.String searchStr,
                              Context context,
                              ConnectorEntity connectorEntity)
                       throws NotImplementedException,
                              DataSourceException,
                              ConnectorException
        Searching for certain texts via context and searchStr.
        Parameters:
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        Returns:
        List of all matching texts or an empty list if no texts has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getTextsByIdentifier

        java.util.List<Text> getTextsByIdentifier​(java.lang.String identifier,
                                          Context context,
                                          ConnectorEntity connectorEntity,
                                          java.lang.String searchStr)
                                   throws NotImplementedException,
                                          DataSourceException,
                                          ConnectorException
        Get text by its identifier.
        Parameters:
        identifier - Identifier of the searched texts in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all needed texts or an empty list if no texts has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getTextsByGroupIdentifier

        java.util.List<Text> getTextsByGroupIdentifier​(java.lang.String groupIdentifier,
                                               Context context,
                                               ConnectorEntity connectorEntity,
                                               java.lang.String searchStr)
                                        throws NotImplementedException,
                                               DataSourceException,
                                               ConnectorException
        Get texts via group identifier.
        Parameters:
        groupIdentifier - Group identifier of the texts. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all needed texts or an empty list if no texts has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getKeyValuesOfBucket

        java.util.List<KeyValue> getKeyValuesOfBucket​(java.lang.String parentBucketId,
                                              Context context,
                                              ConnectorEntity connectorEntity,
                                              java.lang.String searchStr)
                                       throws NotImplementedException,
                                              DataSourceException,
                                              ConnectorException
        Get key value objects for a given bucket.
        Parameters:
        parentBucketId - Id of the source bucket in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all key value objects from a given bucket or an empty list if the bucket has no matching key value objects.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getKeyValuesByIdentifier

        java.util.List<KeyValue> getKeyValuesByIdentifier​(java.lang.String identifier,
                                                  Context context,
                                                  ConnectorEntity connectorEntity,
                                                  java.lang.String searchStr)
                                           throws NotImplementedException,
                                                  DataSourceException,
                                                  ConnectorException
        Get keyvalue objects via its identifier.
        Parameters:
        identifier - Identifier of the key values in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all keyvalue objects for a given identifier or an empty list if no matching keyvalue objects have been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getKeyValuesByGroupIdentifier

        java.util.List<KeyValue> getKeyValuesByGroupIdentifier​(java.lang.String groupIdentifier,
                                                       Context context,
                                                       ConnectorEntity connectorEntity,
                                                       java.lang.String searchStr)
                                                throws NotImplementedException,
                                                       DataSourceException,
                                                       ConnectorException
        Get key value objects via group identifier.
        Parameters:
        groupIdentifier - Group identifier of the key values. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all key value objects for a given group identifier or an empty list if no matching key value objects could be found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getKeyValues

        java.util.List<KeyValue> getKeyValues​(java.lang.String searchStr,
                                      Context context,
                                      ConnectorEntity connectorEntity)
                               throws NotImplementedException,
                                      DataSourceException,
                                      ConnectorException
        Get certain keyValues by context and searchStr alone.
        Parameters:
        searchStr - Search pattern typically used for filtering the label (e.g. part of con_key_value.key_label) or value field of the content.
        Implementation may be connector specific.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        Returns:
        List of all matching keyValues or an empty list if no keyValues has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getMediaAssetsOfBucket

        java.util.List<MediaAsset> getMediaAssetsOfBucket​(java.lang.String parentBucketId,
                                                  Context context,
                                                  ConnectorEntity connectorEntity,
                                                  java.lang.String searchStr)
                                           throws NotImplementedException,
                                                  DataSourceException,
                                                  ConnectorException
        Get media assets for a given bucket.
        Parameters:
        parentBucketId - Id of the source bucket in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all matching media assets for a given bucket or an empty list if no media assets have been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getMediaAssetsByIdentifier

        java.util.List<MediaAsset> getMediaAssetsByIdentifier​(java.lang.String identifier,
                                                      Context context,
                                                      ConnectorEntity connectorEntity,
                                                      java.lang.String searchStr)
                                               throws NotImplementedException,
                                                      DataSourceException,
                                                      ConnectorException
        Get media assets for an identifier.
        Parameters:
        identifier - Identifier of the searched media assets
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all matching media assets for an identifier or an empty list if no media assets have been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getMediaAssetsByGroupIdentifier

        java.util.List<MediaAsset> getMediaAssetsByGroupIdentifier​(java.lang.String groupIdentifier,
                                                           Context context,
                                                           ConnectorEntity connectorEntity,
                                                           java.lang.String searchStr)
                                                    throws NotImplementedException,
                                                           DataSourceException,
                                                           ConnectorException
        Get media assets for a group identifier.
        Parameters:
        groupIdentifier - Group identifier of the media assets. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all matching media assets or an empty list if no media assets has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getMediaAssets

        java.util.List<MediaAsset> getMediaAssets​(java.lang.String searchStr,
                                          Context context,
                                          ConnectorEntity connectorEntity)
                                   throws NotImplementedException,
                                          DataSourceException,
                                          ConnectorException
        Searching for certain MediaAssets via context and searchStr alone.
        Parameters:
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        Returns:
        List of all matching mediaAssets or an empty list if no mediaAssets has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getPricesOfBucket

        java.util.List<Price> getPricesOfBucket​(java.lang.String parentBucketId,
                                        Context context,
                                        ConnectorEntity connectorEntity,
                                        java.lang.String searchStr)
                                 throws NotImplementedException,
                                        DataSourceException,
                                        ConnectorException
        Get prices for a given bucket.
        Parameters:
        parentBucketId - Id of the source bucket in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of prices for a given bucket or an empty list if no matching prices have been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getPricesByIdentifier

        java.util.List<Price> getPricesByIdentifier​(java.lang.String identifier,
                                            Context context,
                                            ConnectorEntity connectorEntity,
                                            java.lang.String searchStr)
                                     throws NotImplementedException,
                                            DataSourceException,
                                            ConnectorException
        Get prices via identifier.
        Parameters:
        identifier - Identifier of the searched prices
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of matching prices or an empty list if no prices has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getPricesByGroupIdentifier

        java.util.List<Price> getPricesByGroupIdentifier​(java.lang.String groupIdentifier,
                                                 Context context,
                                                 ConnectorEntity connectorEntity,
                                                 java.lang.String searchStr)
                                          throws NotImplementedException,
                                                 DataSourceException,
                                                 ConnectorException
        Get prices for a group identifier.
        Parameters:
        groupIdentifier - Group identifier of the prices. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of matching prices or an empty list if no prices has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getPrices

        java.util.List<Price> getPrices​(java.lang.String searchStr,
                                Context context,
                                ConnectorEntity connectorEntity)
                         throws NotImplementedException,
                                DataSourceException,
                                ConnectorException
        Get Prices matching a certain context and searchStr alone.
        Parameters:
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        Returns:
        List of all matching prices or an empty list if no prices has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getTableData

        java.util.List<TableData> getTableData​(java.lang.String searchStr,
                                       Context context,
                                       ConnectorEntity connectorEntity)
                                throws NotImplementedException,
                                       DataSourceException,
                                       ConnectorException
        Get TableData matching a certain context and searchStr alone.
        Parameters:
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        Returns:
        List of all matching tables or an empty list if no table has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getTableDataByGroupIdentifier

        java.util.List<TableData> getTableDataByGroupIdentifier​(java.lang.String groupIdentifier,
                                                        Context context,
                                                        ConnectorEntity connectorEntity,
                                                        java.lang.String searchStr)
                                                 throws NotImplementedException,
                                                        DataSourceException,
                                                        ConnectorException
        Get tables for a group identifier.
        Parameters:
        groupIdentifier - Group identifier of the tables. The group identifier must NOT be unique. Associated with the context it will be unique. If no context is indicated, all context variations will be returned.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of matching tables or an empty list if no table has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.5

      • getTableDataByIdentifier

        java.util.List<TableData> getTableDataByIdentifier​(java.lang.String identifier,
                                                   Context context,
                                                   ConnectorEntity connectorEntity,
                                                   java.lang.String searchStr)
                                            throws NotImplementedException,
                                                   DataSourceException,
                                                   ConnectorException
        Get table data by its identifier.
        Parameters:
        identifier - Identifier of the searched table data in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all needed table data or an empty list if no table data has been found.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getTableDataOfBucket

        java.util.List<TableData> getTableDataOfBucket​(java.lang.String parentBucketId,
                                               Context context,
                                               ConnectorEntity connectorEntity,
                                               java.lang.String searchStr)
                                        throws NotImplementedException,
                                               DataSourceException,
                                               ConnectorException
        Get table data for a given bucket.
        Parameters:
        parentBucketId - Id of the source bucket in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering the label or value field of the content. Implementation may be connector specific.
        Returns:
        List of all table data from a given bucket or an empty list if the bucket has no table data matching context and searchStr.
        Throws:
        NotImplementedException
        DataSourceException
        ConnectorException
        Since:
        4.0.0

      • getContentMetadataOfBucket

        java.util.List<ContentMetaData> getContentMetadataOfBucket​(java.lang.String parentBucketId,
                                                           Context context,
                                                           ConnectorEntity connectorEntity,
                                                           java.lang.String searchStr)
                                                    throws DataSourceException,
                                                           ConnectorException
        Get content meta data for a given bucket.
        Parameters:
        parentBucketId - Id of the source bucket in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given bucket or an empty list if the bucket has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataOfKeyValue

        java.util.List<ContentMetaData> getContentMetadataOfKeyValue​(java.lang.String keyValueId,
                                                             Context context,
                                                             ConnectorEntity connectorEntity,
                                                             java.lang.String searchStr)
                                                      throws DataSourceException,
                                                             ConnectorException
        Get content meta data for a given key value.
        Parameters:
        keyValueId - Id of the source keyValue in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given keyValue or an empty list if the keyValue has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataOfPlanning

        java.util.List<ContentMetaData> getContentMetadataOfPlanning​(java.lang.String planningId,
                                                             Context context,
                                                             ConnectorEntity connectorEntity,
                                                             java.lang.String searchStr)
                                                      throws DataSourceException,
                                                             ConnectorException
        Get content meta data for a given planningId.
        Parameters:
        planningId - Id of the source planning in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given planning or an empty list if the planning has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataOfTableData

        java.util.List<ContentMetaData> getContentMetadataOfTableData​(java.lang.String tableDataId,
                                                              Context context,
                                                              ConnectorEntity connectorEntity,
                                                              java.lang.String searchStr)
                                                       throws DataSourceException,
                                                              ConnectorException
        Get content meta data for a given tableDataId.
        Parameters:
        tableDataId - Id of the source tableData in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given tableData or an empty list if the tableData has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataOfMediaAsset

        java.util.List<ContentMetaData> getContentMetadataOfMediaAsset​(java.lang.String mediaAssetId,
                                                               Context context,
                                                               ConnectorEntity connectorEntity,
                                                               java.lang.String searchStr)
                                                        throws DataSourceException,
                                                               ConnectorException
        Get content meta data for a given mediaAssetId.
        Parameters:
        mediaAssetId - Id of the source mediaAsset in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given mediaAsset or an empty list if the mediaAsset has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataOfCord

        java.util.List<ContentMetaData> getContentMetadataOfCord​(java.lang.String cordId,
                                                         Context context,
                                                         ConnectorEntity connectorEntity,
                                                         java.lang.String searchStr)
                                                  throws DataSourceException,
                                                         ConnectorException
        Get content meta data for a given cordId.
        Parameters:
        cordId - Id of the source cord in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given cord or an empty list if the cord has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataOfText

        java.util.List<ContentMetaData> getContentMetadataOfText​(java.lang.String textId,
                                                         Context context,
                                                         ConnectorEntity connectorEntity,
                                                         java.lang.String searchStr)
                                                  throws DataSourceException,
                                                         ConnectorException
        Get content meta data for a given textId.
        Parameters:
        textId - Id of the source text in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given text or an empty list if the text has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataOfPrice

        java.util.List<ContentMetaData> getContentMetadataOfPrice​(java.lang.String priceId,
                                                          Context context,
                                                          ConnectorEntity connectorEntity,
                                                          java.lang.String searchStr)
                                                   throws DataSourceException,
                                                          ConnectorException
        Get content meta data for a given priceId.
        Parameters:
        priceId - Id of the source price in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given price or an empty list if the price has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataOfMetadata

        java.util.List<ContentMetaData> getContentMetadataOfMetadata​(java.lang.String metaDataId,
                                                             Context context,
                                                             ConnectorEntity connectorEntity,
                                                             java.lang.String searchStr)
                                                      throws DataSourceException,
                                                             ConnectorException
        Get content meta data for a given metaDataId.
        Parameters:
        metaDataId - Id of the source contentMetaData in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given contentMetaData or an empty list if the contentMetaData has no content meta data matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5

      • getContentMetadataByIdentifier

        java.util.List<ContentMetaData> getContentMetadataByIdentifier​(java.lang.String metaDataId,
                                                               Context context,
                                                               ConnectorEntity connectorEntity,
                                                               java.lang.String searchStr)
                                                        throws DataSourceException,
                                                               ConnectorException
        Get content meta data for a given identifier.
        Parameters:
        metaDataId - Id of the source contentMetaData in the content system.
        context - Optional context needed to restrict the query to certain language, country, etc.
        connectorEntity - A hint specific to the connector or content system for where to find the data, e.g. a table name or the value of a keyed column in a database.
        searchStr - Search pattern typically used for filtering result of the method. Implementation may be connector specific.
        Returns:
        List of content meta data for a given metaDataId or an empty list if the contentMetaData not exists or no matching context and searchStr.
        Throws:
        DataSourceException
        ConnectorException
        Since:
        4.1.5