org.osid.personnel

Interface OrganizationAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

OrganizationBatchAdminSession

public interface OrganizationAdminSession
extends OsidSession

This session creates, updates, and deletes Organizations. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create an Organization, an OrganizationForm is requested using getOrganizationFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned OrganizationForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the OrganizationForm is submitted to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each OrganizationForm corresponds to an attempted transaction.

For updates, OrganizationForms are requested to the Organization Id that is to be updated using getOrganizationFormForUpdate(). Similarly, the OrganizationForm has metadata about the data that can be updated and it can perform validation before submitting the update. The OrganizationForm can only be used once for a successful update and cannot be reused.

The delete operations delete Organizations. To unmap an Organization from the current Realm, the OrganizationRealmAssignmentSession should be used. These delete operations attempt to remove the Organization itself thus removing it from all known Realm catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasOrganization(Id organizationId, Id aliasId) Adds an Id to an Organization for the purpose of creating compatibility.
boolean	canCreateOrganizations() Tests if this user can create organizations.
boolean	canCreateOrganizationWithRecordTypes(Type[] organizationRecordTypes) Tests if this user can create a single Organization using the desired record types.
boolean	canDeleteOrganizations() Tests if this user can delete organizations.
boolean	canManageOrganizationAliases() Tests if this user can manage Id aliases for Organizations.
boolean	canUpdateOrganizations() Tests if this user can update organizations.
Organization	createOrganization(OrganizationForm organizationForm) Creates a new Organization.
void	deleteOrganization(Id organizationId) Deletes an Organization.
OrganizationForm	getOrganizationFormForCreate(Type[] organizationRecordTypes) Gets the organization form for creating new organizations.
OrganizationForm	getOrganizationFormForUpdate(Id organizationId) Gets the organization form for updating an existing organization.
Realm	getRealm() Gets the Realm associated with this session.
Id	getRealmId() Gets the Realm Id associated with this session.
void	updateOrganization(OrganizationForm organizationForm) Updates an existing organization.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getRealmId

Id getRealmId()

Gets the Realm Id associated with this session.

Returns:

the Realm Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRealm

Realm getRealm()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Realm associated with this session.

Returns:

the realm

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateOrganizations

boolean canCreateOrganizations()

Tests if this user can create organizations. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Organization will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.

Returns:

false if Organization creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateOrganizationWithRecordTypes

boolean canCreateOrganizationWithRecordTypes(Type[] organizationRecordTypes)

Tests if this user can create a single Organization using the desired record types. While PersonnelManager.getOrganizationRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Organization. Providing an empty array tests if an Organization can be created with no records.

Parameters:

organizationRecordTypes - array of organization record types

Returns:

true if Organization creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - organizationRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getOrganizationFormForCreate

OrganizationForm getOrganizationFormForCreate(Type[] organizationRecordTypes)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets the organization form for creating new organizations. A new form should be requested for each create transaction.

Parameters:

organizationRecordTypes - array of organization record types to be included in the create operation or an empty list if none

Returns:

the organization form

Throws:

NullArgumentException - organizationRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - cannot get form for requested record types

Compliance:

mandatory - This method must be implemented.

createOrganization

Organization createOrganization(OrganizationForm organizationForm)
                                throws OperationFailedException,
                                       PermissionDeniedException

Creates a new Organization.

Parameters:

organizationForm - the form for this Organization

Returns:

the new Organization

Throws:

IllegalStateException - organizationForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - organizationForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - organizationForm did not originate from getOrganizationFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateOrganizations

boolean canUpdateOrganizations()

Tests if this user can update organizations. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Organization will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.

Returns:

false if Organization modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getOrganizationFormForUpdate

OrganizationForm getOrganizationFormForUpdate(Id organizationId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the organization form for updating an existing organization. A new organization form should be requested for each update transaction.

Parameters:

organizationId - the Id of the Organization

Returns:

the organization form

Throws:

NotFoundException - organizationId is not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateOrganization

void updateOrganization(OrganizationForm organizationForm)
                        throws OperationFailedException,
                               PermissionDeniedException

Updates an existing organization.

Parameters:

organizationForm - the form containing the elements to be updated

Throws:

IllegalStateException - organizationForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - organizationForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - organizationForm did not originate from getOrganizationFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteOrganizations

boolean canDeleteOrganizations()

Tests if this user can delete organizations. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Organization will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.

Returns:

false if Organization deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteOrganization

void deleteOrganization(Id organizationId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Deletes an Organization.

Parameters:

organizationId - the Id of the Organization to remove

Throws:

NotFoundException - organizationId not found

NullArgumentException - organizationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageOrganizationAliases

boolean canManageOrganizationAliases()

Tests if this user can manage Id aliases for Organizations. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Organization aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasOrganization

void aliasOrganization(Id organizationId,
                     Id aliasId)
                       throws AlreadyExistsException,
                              NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Adds an Id to an Organization for the purpose of creating compatibility. The primary Id of the Organization is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another organization, it is reassigned to the given organization Id.

Parameters:

organizationId - the Id of an Organization

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is in use as a primary Id

NotFoundException - organizationId not found

NullArgumentException - organizationId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.