Package org.forgerock.openig.fapi.apiclient.service

Interface ApiClientOrganisationService

All Known Implementing Classes:

IdmApiClientOrganisationService

public interface ApiClientOrganisationService

Service which handles managing ApiClientOrganisation objects in a data store.

Currently only supports Creates.

Reads are handled by fetching an ApiClient using the ApiClientService, the returned ApiClient will have the organisation field populated.

Full CRUD support can be added in the future when it is needed.

Method Summary

Modifier and Type	Method	Description
Promise<ApiClientOrganisation,ApiClientServiceException>	create(Context context, SoftwareStatement softwareStatement)	Creates an ApiClientOrganisation in the data store.

Method Details

create

Promise<ApiClientOrganisation,ApiClientServiceException> create(Context context,
 SoftwareStatement softwareStatement)

Creates an ApiClientOrganisation in the data store.

Parameters:

context - the current context within which the operation is being performed

softwareStatement - SoftwareStatement belonging to the organisation to create

Returns:

Promise containing either the created ApiClientOrganisation or an ApiClientServiceException if an error occurs.