View Javadoc
1   /*
2    * JBoss, Home of Professional Open Source
3    * Copyright 2014, Red Hat, Inc. and/or its affiliates, and individual
4    * contributors by the @authors tag. See the copyright.txt in the
5    * distribution for a full listing of individual contributors.
6    *
7    * Licensed under the Apache License, Version 2.0 (the "License");
8    * you may not use this file except in compliance with the License.
9    * You may obtain a copy of the License at
10   * http://www.apache.org/licenses/LICENSE-2.0
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.jboss.as.quickstarts.wsba.participantcompletion.simple.jaxws;
18  
19  import org.jboss.as.quickstarts.wsba.participantcompletion.simple.AlreadyInSetException;
20  import org.jboss.as.quickstarts.wsba.participantcompletion.simple.SetServiceException;
21  import javax.jws.WebMethod;
22  import javax.jws.WebService;
23  import javax.jws.soap.SOAPBinding;
24  
25  /**
26   * Interface implemented by SetServiceBA Web service and Client stub.
27   * 
28   * The Web service represents a simple set collection and this interface provides the basic methods for accessing it.
29   * 
30   * @author paul.robinson@redhat.com, 2011-12-21
31   */
32  @WebService(name = "SetServiceBA", targetNamespace = "http://www.jboss.org/jboss-jdf/jboss-as-quickstart/helloworld/wsba/participantcompletion/set")
33  @SOAPBinding(style = SOAPBinding.Style.RPC)
34  public interface SetServiceBA {
35      /**
36       * Add a value to the set
37       * 
38       * @param value Value to add to the set.
39       * @throws AlreadyInSetException if the item is already in the set.
40       * @throws SetServiceException if an error occurred during the adding of the item to the set.
41       */
42      @WebMethod
43      public void addValueToSet(String value) throws AlreadyInSetException, SetServiceException;
44  
45      /**
46       * Query the set to see if it contains a particular value.
47       * 
48       * @param value the value to check for.
49       * @return true if the value was present, false otherwise.
50       */
51      @WebMethod
52      public boolean isInSet(String value);
53  
54      /**
55       * Empty the set
56       */
57      @WebMethod
58      public void clear();
59  
60  }