1 /* 2 * Copyright (c) 2007, Fraunhofer-Gesellschaft 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: 8 * 9 * (1) Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the disclaimer at the end. 11 * Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in 13 * the documentation and/or other materials provided with the 14 * distribution. 15 * 16 * (2) Neither the name of Fraunhofer nor the names of its 17 * contributors may be used to endorse or promote products derived 18 * from this software without specific prior written permission. 19 * 20 * DISCLAIMER 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 * 34 */ 35 package org.ogf.graap.wsag.api.client; 36 37 import org.ogf.graap.wsag.api.exceptions.ResourceUnavailableException; 38 import org.ogf.graap.wsag.api.exceptions.ResourceUnknownException; 39 import org.ogf.schemas.graap.wsAgreement.GuaranteeTermStateType; 40 import org.ogf.schemas.graap.wsAgreement.ServiceTermStateType; 41 42 /** 43 * AgreementClient 44 * 45 * @author Oliver Waeldrich 46 */ 47 public interface AgreementClient 48 extends WsClient, AgreementService 49 { 50 51 /** 52 * Returns the service description term with the given name. 53 * 54 * @param name 55 * the name of the service description term to retrieve 56 * @return the service description term with the given name 57 * @throws ResourceUnknownException 58 * the remote resource is unknown 59 * @throws ResourceUnavailableException 60 * the remote resource is unavailable 61 */ 62 ServiceTermStateType getServiceTermState( String name ) 63 throws ResourceUnknownException, ResourceUnavailableException; 64 65 /** 66 * Returns the guarantee term with the given name. 67 * 68 * @param name 69 * the name of the guarantee term to retrieve 70 * @return the guarantee term with the given name 71 * @throws ResourceUnknownException 72 * the remote resource is unknown 73 * @throws ResourceUnavailableException 74 * the remote resource is unavailable 75 */ 76 GuaranteeTermStateType getGuaranteeTermState( String name ) 77 throws ResourceUnknownException, ResourceUnavailableException; 78 79 /** 80 * Terminates an agreement. 81 * 82 * @throws ResourceUnknownException 83 * the remote resource is unknown 84 * @throws ResourceUnavailableException 85 * the remote resource is unavailable 86 */ 87 void terminate() throws ResourceUnknownException, ResourceUnavailableException; 88 89 /** 90 * Returns a copy of the client. 91 * 92 * @return the cloned AgreementClient 93 * 94 * @throws CloneNotSupportedException 95 * indicates that the client implementation does not support cloning 96 */ 97 AgreementClient clone() throws CloneNotSupportedException; 98 }