com.helger.smpclient.bdxr2.IBDXR2ServiceGroupProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of peppol-smp-client Show documentation

Peppol and OASIS BDXR SMP client

There is a newer version: 9.6.0

/*
 * Copyright (C) 2015-2024 Philip Helger
 * philip[at]helger[dot]com
 *
 * 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 com.helger.smpclient.bdxr2;

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

import com.helger.peppolid.IParticipantIdentifier;
import com.helger.smpclient.exception.SMPClientException;
import com.helger.xsds.bdxr.smp2.ServiceGroupType;

/**
 * Abstract interface to retrieve a service group instance.
 *
 * @author Philip Helger
 * @since 7.0.6
 */
public interface IBDXR2ServiceGroupProvider
{
  /**
   * Returns a service group. A service group references to the service
   * metadata. This is a specification compliant method.
   *
   * @param aServiceGroupID
   *        The ID of the service group to retrieve. May not be
   *        null.
   * @return The service group. Maybe null.
   * @throws SMPClientException
   *         in case something goes wrong
   */
  @Nullable
  ServiceGroupType getServiceGroupOrNull (@Nonnull IParticipantIdentifier aServiceGroupID) throws SMPClientException;
}