org.apache.plc4x.java.api.messages.PlcSubscriptionResponse Maven / Gradle / Ivy

Go to download
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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
 *
 *   https://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 org.apache.plc4x.java.api.messages;

import org.apache.plc4x.java.api.model.PlcSubscriptionHandle;

import java.util.Collection;

public interface PlcSubscriptionResponse extends PlcSubscriptionFieldResponse {

    @Override
    PlcSubscriptionRequest getRequest();

    /**
     * Returns a {@link PlcSubscriptionHandle} associated with a {@code name} from {@link PlcSubscriptionRequest#getField(String)}
     *
     * @param name the field name which a {@link PlcSubscriptionHandle} is required to
     * @return a {@link PlcSubscriptionHandle}
     */
    PlcSubscriptionHandle getSubscriptionHandle(String name);

    /**
     * @return all {@link PlcSubscriptionHandle}s
     */
    Collection getSubscriptionHandles();

}