io.proximax.sdk.NamespaceRepository Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-xpx-chain-sdk Show documentation

The ProximaX Sirius Chain Java SDK is a Java library for interacting with the Sirius Blockchain.

The newest version!

/*
 * Copyright 2018 NEM
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.proximax.sdk;

import java.util.List;

import io.proximax.sdk.infrastructure.QueryParams;
import io.proximax.sdk.model.account.Address;
import io.proximax.sdk.model.namespace.NamespaceId;
import io.proximax.sdk.model.namespace.NamespaceInfo;
import io.proximax.sdk.model.namespace.NamespaceName;
import io.reactivex.Observable;

/**
 * Namespace interface repository.
 *
 * @since 1.0
 */
public interface NamespaceRepository {

    /**
     * Gets the NamespaceInfo for a given namespaceId.
     *
     * @param namespaceId NamespaceId
     * @return Observable of {@link NamespaceInfo}
     */
    Observable getNamespace(NamespaceId namespaceId);

    /**
     * Gets list of NamespaceInfo for an account.
     * With pagination.
     *
     * @param address Address
     * @param queryParams   QueryParans
     * @return Observable of {@link NamespaceInfo} list
     */
    Observable> getNamespacesFromAccount(Address address, QueryParams queryParams);

    /**
     * Gets list of NamespaceInfo for an account.
     *
     * @param address Address
     * @return Observable of {@link NamespaceInfo} list
     */
    Observable> getNamespacesFromAccount(Address address);

    /**
     * Gets list of NamespaceInfo for different account.
     * With pagination.
     *
     * @param addresses List of Address
     * @param queryParams    QueryParams
     * @return Observable of {@link NamespaceInfo} list
     */
    Observable> getNamespacesFromAccounts(List addresses, QueryParams queryParams);

    /**
     * Gets list of NamespaceInfo for different account.
     *
     * @param addresses List of Address
     * @return Observable of {@link NamespaceInfo} list
     */
    Observable> getNamespacesFromAccounts(List addresses);

    /**
     * Gets list of NamespaceName for different namespaceIds.
     *
     * @param namespaceIds List of NamespaceId
     * @return Observable of {@link NamespaceName} list
     */
    Observable> getNamespaceNames(List namespaceIds);
}