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

Class IdmApiClientOrganisationService

java.lang.Object

org.forgerock.openig.fapi.apiclient.service.idm.IdmApiClientOrganisationService

All Implemented Interfaces:

ApiClientOrganisationService

public class IdmApiClientOrganisationService
extends Object
implements ApiClientOrganisationService

Service for managing ApiClientOrganisation entities in IDM.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IdmApiClientOrganisationService.Heaplet	Heaplet for creating IdmApiClientOrganisationService instances.

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Details

create

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

Creates an ApiClientOrganisation in IDM.

If the organisation already exists, this method will return the existing organisation.

Specified by:

create in interface ApiClientOrganisationService

Parameters:

softwareStatement - the software statement containing the organisation details

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

Returns:

a promise that will resolve to the created or existing ApiClientOrganisation or will throw an ApiClientServiceException if an error occurs creating the organisation.