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

All Known Subinterfaces:

AgreementClient

public interface AgreementService

AgreementService

Author:

Oliver Waeldrich

Method Summary

void	destroy() Destroys agreement instance.
String	getAgreementId() Returns the id of the agreement instance.
AgreementContextType	getContext() Returns the context of the agreement instance.
GuaranteeTermStateType[]	getGuaranteeTermStates() Returns the state for the individual guarantee terms of the agreement instance.
String	getName() Returns the name of the agreement instance.
ServiceTermStateType[]	getServiceTermStates() Returns the state for the individual service terms of the agreement instance.
AgreementStateType	getState() Returns the state of the agreement instance.
TermTreeType	getTerms() Returns the terms of the agreement instance.
WsClient	getWebServiceClient() Returns the web-service client used for communication with the SLA management server.
void	terminate(TerminateInputType reason) Terminates the agreement instance.

Method Detail

getWebServiceClient

WsClient getWebServiceClient()

Returns the web-service client used for communication with the SLA management server.

Returns:

the web service client for this service.

getName

String getName()
               throws ResourceUnknownException,
                      ResourceUnavailableException

Returns the name of the agreement instance.

Returns:

the agreement name

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

getAgreementId

String getAgreementId()
                      throws ResourceUnknownException,
                             ResourceUnavailableException

Returns the id of the agreement instance.

Returns:

the agreement id

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

getContext

AgreementContextType getContext()
                                throws ResourceUnknownException,
                                       ResourceUnavailableException

Returns the context of the agreement instance.

Returns:

the agreement context

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

getTerms

TermTreeType getTerms()
                      throws ResourceUnknownException,
                             ResourceUnavailableException

Returns the terms of the agreement instance.

Returns:

the agreement terms

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

terminate

void terminate(TerminateInputType reason)
               throws ResourceUnknownException,
                      ResourceUnavailableException

Terminates the agreement instance.

Parameters:

reason - a domain-specific termination reason

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

getState

AgreementStateType getState()
                            throws ResourceUnknownException,
                                   ResourceUnavailableException

Returns the state of the agreement instance.

Returns:

the agreement state

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

getGuaranteeTermStates

GuaranteeTermStateType[] getGuaranteeTermStates()
                                                throws ResourceUnknownException,
                                                       ResourceUnavailableException

Returns the state for the individual guarantee terms of the agreement instance.

Returns:

the guarantee term states

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

getServiceTermStates

ServiceTermStateType[] getServiceTermStates()
                                            throws ResourceUnknownException,
                                                   ResourceUnavailableException

Returns the state for the individual service terms of the agreement instance.

Returns:

the service term states

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable

destroy

void destroy()
             throws ResourceUnknownException,
                    ResourceUnavailableException

Destroys agreement instance.

Throws:

ResourceUnknownException - the remote resource is unknown

ResourceUnavailableException - the remote resource is unavailable