org.apache.tuscany.sca.interfacedef.Interface Maven / Gradle / Ivy
/*
* 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
*
* 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 org.apache.tuscany.sca.interfacedef;
import java.util.List;
import java.util.Map;
import org.apache.tuscany.sca.policy.PolicySubject;
/**
* Represents a service interface. This interface will typically be extended to
* support concrete interface type systems, such as Java interfaces, WSDL 1.1
* portTypes and WSDL 2.0 interfaces.
*
* @version $Rev: 1291191 $ $Date: 2012-02-20 02:57:50 -0800 (Mon, 20 Feb 2012) $
* @tuscany.spi.extension.inheritfrom
*/
public interface Interface extends Cloneable, PolicySubject {
/**
* Returns true if the interface is a remotable interface..
*
* @return true if the interface is a remotable interface
*/
boolean isRemotable();
/**
* Sets whether the interface is a remotable or local interface.
*
* @param remotable indicates whether the interface is remotable or local
*/
void setRemotable(boolean remotable);
/**
* Returns true if the interface remotable property is set..
*
* This is used to verify if a @remotable attribute is used in the
* SCDL element. If true, use isRemotable to verify the
* current value
*
* @return
*/
boolean isRemotableSet();
/**
* A flag that indicates if the remotable status has come
* from the attribute
*
* @return
*/
boolean isRemotableSetFromSCDL();
void setRemotableSetFromSCDL();
/**
* Returns the operations defined on this interface.
*
* @return the operations defined on this interface
*/
List getOperations();
/**
* Set the databinding for the interface
* @param dataBinding
* @deprecated Please use resetDataBinding
*/
@Deprecated
void setDefaultDataBinding(String dataBinding);
/**
* Reset the databinding for the interface
* @param dataBinding
*/
void resetDataBinding(String dataBinding);
/**
* Set the interface input types by copying those from the
* interface provided
*
* @param newInterface
*/
public void resetInterfaceInputTypes(Interface newInterface);
/**
* Set the interface output types by copying those from the
* interface provided
*
* @param newInterface
*/
public void resetInterfaceOutputTypes(Interface newInterface);
/**
* Returns true if the Interface is dynamic.
*
* @return true if the Interface is dynamic.
*/
boolean isDynamic();
/**
* Get a map of attributes associated with the interface
* @return A map of attributes
*/
Map