eu.toop.connector.api.dsd.IDSDParticipantIDProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tc-api Show documentation

Contains the TOOP Connector shared API

There is a newer version: 2.1.1

/**
 * Copyright (C) 2018-2020 toop.eu
 *
 * 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 eu.toop.connector.api.dsd;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.collection.impl.ICommonsSet;
import com.helger.peppolid.IDocumentTypeIdentifier;
import com.helger.peppolid.IParticipantIdentifier;

import eu.toop.connector.api.error.ITCErrorHandler;

/**
 * Interface to resolve Country Code and Document Type ID to a set of matching
 * participant identifiers.

 * Am implementation of this class e.g. queries the TOOP Directory for the
 * respective participants.
 *
 * @author Philip Helger
 */
public interface IDSDParticipantIDProvider
{
  /**
   * Get all participant IDs that match the provided country code and document
   * type ID.
   *
   * @param sLogPrefix
   *        The logging prefix to be used. May not be null.
   * @param sDatasetType
   *        Dataset Type to query. May not be null.
   * @param sCountryCode
   *        Country code to use. Must be a 2-digit string. May be
   *        null.
   * @param aDocumentTypeID
   *        Document type ID to query. May not be null.
   * @param aErrorHandler
   *        The error handler to be used. May not be null.
   * @return A non-null but maybe empty set of Participant IDs.
   */
  @Nonnull
  ICommonsSet  getAllParticipantIDs (@Nonnull String sLogPrefix,
                                                             @Nonnull String sDatasetType,
                                                             @Nullable String sCountryCode,
                                                             @Nonnull IDocumentTypeIdentifier aDocumentTypeID,
                                                             @Nonnull ITCErrorHandler aErrorHandler);
}