org.osid.id

Interface IdAdminSession

All Superinterfaces:

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

All Known Subinterfaces:

IdBatchAdminSession

public interface IdAdminSession
extends OsidSession

This session is used to manually create new Ids.

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasId(Id primaryId, Id equivalentId) Makes two Ids equivalent.
boolean	canAliasIds() Tests if this user can alias Ids.
boolean	canCreateIds() Tests if this user can create Ids.
Id	createId(IdForm idForm) Creates a new Id.
IdForm	getIdFormForCreate() Gets the Id form for creating new Ids.
void	removeAlias(Id primaryId, Id equivalentId) Removes equivalence from two Ids.

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

canCreateIds

boolean canCreateIds()

Tests if this user can create Ids. A return of true does not guarantee successful authorization. A return of false indicates that it is known create methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations.

Returns:

false if create methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getIdFormForCreate

IdForm getIdFormForCreate()
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets the Id form for creating new Ids. A new form should be requested for each create transaction.

Returns:

the Id form

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

createId

Id createId(IdForm idForm)
            throws AlreadyExistsException,
                   OperationFailedException,
                   PermissionDeniedException

Creates a new Id. A new IdForm should be requested for each create transaction.

Parameters:

idForm - the Id form

Returns:

the created Id

Throws:

AlreadyExistsException - an Id for the authority, namespace, and identifier already exists

IllegalStateException - idForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - idForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - idForm did not originate from getIdFormForCreate()

Compliance:

mandatory - This method must be implemented.

canAliasIds

boolean canAliasIds()

Tests if this user can alias Ids. A return of true does not guarantee successful authorization. A return of false indicates that it is known add methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations.

Returns:

false if alias methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasId

void aliasId(Id primaryId,
           Id equivalentId)
             throws NotFoundException,
                    OperationFailedException,
                    PermissionDeniedException

Makes two Ids equivalent. The primary and equivalent Ids are already known to this service . If the external Id is already mapped to another Id, it is changed to map to the given primary Id. Calls to IdLookupSession.getId(equivalentId) return the primaryId.

Parameters:

primaryId - the primary Id

equivalentId - an Id to be made equivalent

Throws:

NotFoundException - primaryId or equivalentId is not found

NullArgumentException - primaryId or equivalentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeAlias

void removeAlias(Id primaryId,
               Id equivalentId)
                 throws NotFoundException,
                        OperationFailedException,
                        PermissionDeniedException

Removes equivalence from two Ids.

Parameters:

primaryId - the primary Id

equivalentId - the equivalent Id

Throws:

NotFoundException - primaryId or equivalentId is not found or equivalentId not mapped to primaryId

NullArgumentException - primaryId or equivalentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.