/*
* TeleStax, Open Source Cloud Communications Copyright 2012.
* and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.mobicents.protocols.ss7.cap.api.service.circuitSwitchedCall;
import org.mobicents.protocols.ss7.cap.api.primitives.CAPExtensions;
import org.mobicents.protocols.ss7.cap.api.service.circuitSwitchedCall.primitive.CollectedInfo;
import org.mobicents.protocols.ss7.cap.api.service.circuitSwitchedCall.primitive.InformationToSend;
/**
*
<code>
promptAndCollectUserInformation {PARAMETERS-BOUND : bound} OPERATION ::= {
ARGUMENT PromptAndCollectUserInformationArg {bound}
RESULT ReceivedInformationArg {bound}
ERRORS {canceled | improperCallerResponse | missingParameter | parameterOutOfRange | systemFailure | taskRefused |
unexpectedComponentSequence | unavailableResource | unexpectedDataValue | unexpectedParameter | unknownCSID}
LINKED {specializedResourceReport} CODE opcode-promptAndCollectUserInformation
}
-- Direction: gsmSCF -> gsmSRF, Timer: T pc
-- This operation is used to interact with a user to collect information.
PromptAndCollectUserInformationArg {PARAMETERS-BOUND : bound}::= SEQUENCE {
collectedInfo [0] CollectedInfo,
disconnectFromIPForbidden [1] BOOLEAN DEFAULT TRUE,
informationToSend [2] InformationToSend {bound} OPTIONAL,
extensions [3] Extensions {bound} OPTIONAL,
callSegmentID [4] CallSegmentID {bound} OPTIONAL,
requestAnnouncementStartedNotification [51] BOOLEAN DEFAULT FALSE,
...
}
CallSegmentID {PARAMETERS-BOUND : bound} ::= INTEGER (1..bound.&numOfCSs)
numOfCSs ::= 127
</code>
*
*
* @author sergey vetyutnev
*
*/
public interface PromptAndCollectUserInformationRequest extends CircuitSwitchedCallMessage {
CollectedInfo getCollectedInfo();
Boolean getDisconnectFromIPForbidden();
InformationToSend getInformationToSend();
CAPExtensions getExtensions();
Integer getCallSegmentID();
Boolean getRequestAnnouncementStartedNotification();
}