Package com.microsoft.store.partnercenter.agreements

Interface ICustomerAgreementCollection

All Superinterfaces:

IEntireEntityCollectionRetrievalOperations<Agreement,ResourceCollection<Agreement>>, IPartnerComponent<String>, IPartnerComponentString

All Known Implementing Classes:

CustomerAgreementCollectionOperations

public interface ICustomerAgreementCollection
extends IPartnerComponentString, IEntireEntityCollectionRetrievalOperations<Agreement,ResourceCollection<Agreement>>

Encapsulates the operations on the Agreement collection.

Method Summary

Modifier and Type	Method	Description
ICustomerAgreementCollection	byAgreementType(String agreementType)	Retrieves the operations tied with a specified agreement type.
Agreement	create(Agreement newEntity)	Creates an agreement between the partner and customer.
ResourceCollection<Agreement>	get()	Gets the list of agreements between a partner and customer.

Methods inherited from interface com.microsoft.store.partnercenter.IPartnerComponent

getContext, getPartner

Method Details

create

Agreement create(Agreement newEntity)

Creates an agreement between the partner and customer.

Parameters:

newEntity - The agreement to be created.

Returns:

The newly created agreement.

get

ResourceCollection<Agreement> get()

Gets the list of agreements between a partner and customer.

Specified by:

get in interface IEntireEntityCollectionRetrievalOperations<Agreement,ResourceCollection<Agreement>>

Returns:

The list of the customer's agreements.

byAgreementType

ICustomerAgreementCollection byAgreementType(String agreementType)

Retrieves the operations tied with a specified agreement type.

Parameters:

agreementType - The agreement type used to filter.

Returns:

The customer agreement collection operations customized for the given type.