org.restcomm.protocols.ss7.tcapAnsi.api.ComponentPrimitiveFactory Maven / Gradle / Ivy

Go to download
/*
 * Mobius Software LTD
 * Copyright 2019, Mobius Software LTD and individual contributors
 * by the @authors tag.
 *
 * This program is free software: you can redistribute it and/or modify
 * under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation; either version 3 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see 
 */

package org.restcomm.protocols.ss7.tcapAnsi.api;

import org.restcomm.protocols.ss7.tcapAnsi.api.asn.comp.Invoke;
import org.restcomm.protocols.ss7.tcapAnsi.api.asn.comp.Reject;
import org.restcomm.protocols.ss7.tcapAnsi.api.asn.comp.Return;
import org.restcomm.protocols.ss7.tcapAnsi.api.asn.comp.ReturnError;
import org.restcomm.protocols.ss7.tcapAnsi.api.tc.component.InvokeClass;

/**
 *
 * @author amit bhayani
 * @author baranowb
 * @author yulianoifa
 */
public interface ComponentPrimitiveFactory {

    /**
     * Create a new Invoke. Class of this Invoke will be 1
     *
     * @return return new instance of ({@link Invoke}
     */
    Invoke createTCInvokeRequestNotLast();

    Invoke createTCInvokeRequestLast();

    /**
     * 
     * Create a new {@link Invoke}. Set the {@link InvokeClass} as per bellow consideration
     * 
     * 
     * Class 1 – Both success and failure are reported.
     * Class 2 – Only failure is reported.
     * Class 3 – Only success is reported.
     * Class 4 – Neither success, nor failure is reported.
     * 
     *
     * @param invokeClass The Class of Operation
     * @return new instance of ({@link Invoke}
     */
    Invoke createTCInvokeRequestNotLast(InvokeClass invokeClass);

    Invoke createTCInvokeRequestLast(InvokeClass invokeClass);

    Reject createTCRejectRequest();

    Return createTCResultLastRequest();

    Return createTCResultNotLastRequest();

    ReturnError createTCReturnErrorRequest();
}