org.ogf.graap.wsag.api.client
Interface AgreementClient

All Superinterfaces:
AgreementService, WsClient
All Known Implementing Classes:
AgreementImpl, LocalAgreementClientImpl, RemoteAgreementClientImpl

public interface AgreementClient
extends WsClient, AgreementService

AgreementClient

Author:
Oliver Waeldrich

Method Summary
 AgreementClient clone()
          Returns a copy of the client.
 GuaranteeTermStateType getGuaranteeTermState(String name)
          Returns the guarantee term with the given name.
 ServiceTermStateType getServiceTermState(String name)
          Returns the service description term with the given name.
 void terminate()
          Terminates an agreement.
 
Methods inherited from interface org.ogf.graap.wsag.api.client.WsClient
getEndpoint, getProperties, getSecurityProperties, isUsingTrace, setProperties, setTrace
 
Methods inherited from interface org.ogf.graap.wsag.api.client.AgreementService
destroy, getAgreementId, getContext, getGuaranteeTermStates, getName, getServiceTermStates, getState, getTerms, getWebServiceClient, terminate
 

Method Detail

getServiceTermState

ServiceTermStateType getServiceTermState(String name)
                                         throws ResourceUnknownException,
                                                ResourceUnavailableException
Returns the service description term with the given name.

Parameters:
name - the name of the service description term to retrieve
Returns:
the service description term with the given name
Throws:
ResourceUnknownException - the remote resource is unknown
ResourceUnavailableException - the remote resource is unavailable

getGuaranteeTermState

GuaranteeTermStateType getGuaranteeTermState(String name)
                                             throws ResourceUnknownException,
                                                    ResourceUnavailableException
Returns the guarantee term with the given name.

Parameters:
name - the name of the guarantee term to retrieve
Returns:
the guarantee term with the given name
Throws:
ResourceUnknownException - the remote resource is unknown
ResourceUnavailableException - the remote resource is unavailable

terminate

void terminate()
               throws ResourceUnknownException,
                      ResourceUnavailableException
Terminates an agreement.

Throws:
ResourceUnknownException - the remote resource is unknown
ResourceUnavailableException - the remote resource is unavailable

clone

AgreementClient clone()
                      throws CloneNotSupportedException
Returns a copy of the client.

Returns:
the cloned AgreementClient
Throws:
CloneNotSupportedException - indicates that the client implementation does not support cloning


Copyright © 2008-2012 Fraunhofer Institute SCAI. All Rights Reserved.