Package com.microsoft.store.partnercenter.agreements

Class CustomerAgreementCollectionOperations

java.lang.Object

com.microsoft.store.partnercenter.BasePartnerComponent<String>

com.microsoft.store.partnercenter.BasePartnerComponentString

com.microsoft.store.partnercenter.agreements.CustomerAgreementCollectionOperations

All Implemented Interfaces:

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

public class CustomerAgreementCollectionOperations
extends BasePartnerComponentString
implements ICustomerAgreementCollection

Implements the operations on an Agreement collection.

Constructor Summary

Constructors

Constructor	Description
CustomerAgreementCollectionOperations(IPartner rootPartnerOperations, String customerId)	Initializes a new instance of the CustomerAgreementCollectionOperations class.
CustomerAgreementCollectionOperations(IPartner rootPartnerOperations, String customerId, String agreementType)	Initializes a new instance of the CustomerAgreementCollectionOperations class.

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 class com.microsoft.store.partnercenter.BasePartnerComponent

getContext, getPartner

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getContext, getPartner

Constructor Details

CustomerAgreementCollectionOperations

public CustomerAgreementCollectionOperations(IPartner rootPartnerOperations, String customerId)

Initializes a new instance of the CustomerAgreementCollectionOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.

customerId - The customer identifier.

CustomerAgreementCollectionOperations

public CustomerAgreementCollectionOperations(IPartner rootPartnerOperations, String customerId, String agreementType)

Initializes a new instance of the CustomerAgreementCollectionOperations class.

Parameters:

rootPartnerOperations - The root partner operations instance.

customerId - The customer identifier.

agreementType - The type of the agreement used to filter.

Method Details

create

public Agreement create(Agreement newEntity)

Creates an agreement between the partner and customer.

Specified by:

create in interface ICustomerAgreementCollection

Parameters:

newEntity - The agreement to be created.

Returns:

The newly created agreement.

get

public ResourceCollection<Agreement> get()

Gets the list of agreements between a partner and customer.

Specified by:

get in interface ICustomerAgreementCollection

Specified by:

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

Returns:

The list of the customer's agreements.

byAgreementType

public ICustomerAgreementCollection byAgreementType(String agreementType)

Retrieves the operations tied with a specified agreement type.

Specified by:

byAgreementType in interface ICustomerAgreementCollection

Parameters:

agreementType - The agreement type filter.

Returns:

The available operations for agreement details.