org.bonitasoft.engine.api

Interface OrganizationAPI

All Known Subinterfaces:

IdentityAPI

public interface OrganizationAPI

Manages the Organization, that is the users, groups, roles, memberships, through import / export methods.

Author:

Yanyan Liu, Matthieu Chaffotte, Emmanuel Duchastenier

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteOrganization() Deletes the organization.
void	importOrganization(String organizationContent) Imports the organization using the ImportPolicy.MERGE_DUPLICATES policy.
void	importOrganization(String organizationContent, ImportPolicy policy) Imports the organization.

Method Detail

deleteOrganization

void deleteOrganization()
                        throws DeletionException

Deletes the organization. It deletes all user memberships, roles, groups and users.

Throws:

DeletionException - If an exception occurs during the organization deletion

InvalidSessionException - If the session is invalid (expired, unknown, ...)

importOrganization

void importOrganization(String organizationContent)
                        throws OrganizationImportException

Imports the organization using the ImportPolicy.MERGE_DUPLICATES policy. An organization is composed by users, roles, groups and user memberships.

Parameters:

organizationContent - the XML content of the organization

Throws:

OrganizationImportException - If an exception occurs during the organization import

InvalidSessionException - If the session is invalid (expired, unknown, ...)

importOrganization

void importOrganization(String organizationContent,
                      ImportPolicy policy)
                        throws OrganizationImportException

Imports the organization. An organization is composed by users, roles, groups and user memberships.

Parameters:

organizationContent - the XML content of the organization

policy - the import policy

Throws:

OrganizationImportException - If an exception occurs during the organization import

InvalidSessionException - If the session is invalid (expired, unknown, ...)