Interface AssetConsumerAssetInterface

  • All Known Implementing Classes:
    AssetConsumer

    public interface AssetConsumerAssetInterface
    AssetConsumerAssetInterface supports queries to retrieve information about an asset.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<java.lang.String> findAssets​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Return a list of assets with the requested search string in their name, qualified name or description.
      java.lang.String getAssetForConnection​(java.lang.String userId, java.lang.String connectionGUID)
      Returns the unique identifier for the asset connected to the requested connection.
      java.lang.String getAssetForConnectionName​(java.lang.String userId, java.lang.String connectionName)
      Returns the asset corresponding to the supplied connection name.
      AssetUniverse getAssetProperties​(java.lang.String userId, java.lang.String assetGUID)
      Returns a comprehensive collection of properties about the requested asset.
      java.util.List<java.lang.String> getAssetsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Return a list of assets with the requested name.
      java.util.List<java.lang.String> getAssetsByToken​(java.lang.String userId, java.lang.String assetToken, int startFrom, int pageSize)
      Returns a list of assets that match the token which may be the GUID or the qualified name.
    • Method Detail

      • findAssets

        java.util.List<java.lang.String> findAssets​(java.lang.String userId,
                                                    java.lang.String searchString,
                                                    int startFrom,
                                                    int pageSize)
                                             throws InvalidParameterException,
                                                    PropertyServerException,
                                                    UserNotAuthorizedException
        Return a list of assets with the requested search string in their name, qualified name or description. The search string is interpreted as a regular expression (RegEx).
        Parameters:
        userId - calling user
        searchString - string to search for in text
        startFrom - starting element (used in paging through large result sets)
        pageSize - maximum number of results to return
        Returns:
        list of assets that match the search string.
        Throws:
        InvalidParameterException - the searchString is invalid
        PropertyServerException - there is a problem access in the property server
        UserNotAuthorizedException - the user does not have access to the properties
      • getAssetsByToken

        java.util.List<java.lang.String> getAssetsByToken​(java.lang.String userId,
                                                          java.lang.String assetToken,
                                                          int startFrom,
                                                          int pageSize)
                                                   throws InvalidParameterException,
                                                          PropertyServerException,
                                                          UserNotAuthorizedException
        Returns a list of assets that match the token which may be the GUID or the qualified name.
        Parameters:
        userId - userId of user making request.
        assetToken - token used to find the Asset - may be a name or GUID
        startFrom - starting element (used in paging through large result sets)
        pageSize - maximum number of results to return
        Returns:
        a list of unique identifiers for the matching assets
        Throws:
        InvalidParameterException - one of the parameters is null or invalid.
        PropertyServerException - there is a problem retrieving the asset properties from the property servers).
        UserNotAuthorizedException - the requesting user is not authorized to issue this request.