Interface IdAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

IdBatchAdminSession

public interface IdAdminSession
extends OsidSession

This session is used to manually create new Ids .

Method Summary

Modifier and Type	Method	Description
void	aliasId(Id id, Id aliasId)	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 id, Id aliasId)	Removes an alias.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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 id,
 Id aliasId)
      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

id - the primary Id

aliasId - the Id alias

Throws:

NotFoundException - id or aliasId is not found

NullArgumentException - id or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeAlias

void removeAlias(Id id,
 Id aliasId)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an alias.

Parameters:

id - the primary Id

aliasId - the alias Id

Throws:

NotFoundException - id or aliasId is not found or aliasId not mapped to id

NullArgumentException - id or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.