Interface TypeAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface TypeAdminSession
extends OsidSession

This session is used to create, update and delete Types in the registry.

Method Summary

Modifier and Type	Method	Description
void	addBaseType(Type type, Type baseType)	Adds a base type to a type.
void	addTypeRelation(Type sourceType, Type destinationType, Type relationType)	Adds a relation between two types.
boolean	canCreateTypes()	Tests if this user can create Types .
boolean	canDeleteType(Type type)	Tests if this user can delete the specified type.
boolean	canDeleteTypes()	Tests if this user can delete Types from this ItemBank .
boolean	canUpdateTypes()	Tests if this user can update types.
Type	createType(TypeForm typeForm)	Creates a new Type .
void	deleteType(Type type)	Removes a Type .
TypeForm	getTypeFormForCreate(Type type)	Gets the type form for creating new types.
TypeForm	getTypeFormForUpdate(Type type)	Gets the type form for creating new types.
void	makeEquivalent(Type primaryType, Type equivalentType)	Makes two Types equivalent.
void	removeBaseType(Type type, Type baseType)	Removes a base type from a type.
void	removeTypeRelation(Type sourceType, Type destinationType, Type relationType)	Renoves a relation between two types.
void	updateType(TypeForm typeForm)	Updates a type.

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

canCreateTypes

boolean canCreateTypes()

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

Returns:

false if Type creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getTypeFormForCreate

TypeForm getTypeFormForCreate(Type type)
                       throws OperationFailedException,
PermissionDeniedException

Gets the type form for creating new types. A new form should be requested for each create transaction.

Parameters:

type - the Type to be created

Returns:

the type form

Throws:

NullArgumentException - type is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

createType

Type createType(TypeForm typeForm)
         throws OperationFailedException,
PermissionDeniedException

Creates a new Type .

Parameters:

typeForm - the type form

Returns:

the created Type

Throws:

IllegalStateException - typeForm already used in a create transaction

InvalidArgumentException - one or more of the arguments is invalid

NullArgumentException - typeForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - typeForm did not originate from getTypeFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateTypes

boolean canUpdateTypes()

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

Returns:

false if type modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getTypeFormForUpdate

TypeForm getTypeFormForUpdate(Type type)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the type form for creating new types. A new form should be requested for each create transaction.

Parameters:

type - the Type to be updated

Returns:

the type form

Throws:

NotFoundException - type not found

NullArgumentException - type is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateType

void updateType(TypeForm typeForm)
         throws OperationFailedException,
PermissionDeniedException

Updates a type.

Parameters:

typeForm - the type form

Throws:

IllegalStateException - typeForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - typeForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - typeForm did not originate from getTypeFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteTypes

boolean canDeleteTypes()

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

Returns:

false if Item deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canDeleteType

boolean canDeleteType(Type type)

Tests if this user can delete the specified type. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleteing the Type will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Parameters:

type - the Type to be deleted

Returns:

false if type deletion is not authorized, true otherwise

Throws:

NullArgumentException - type is null

Compliance:

mandatory - This method must be implemented.

deleteType

void deleteType(Type type)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a Type .

Parameters:

type - the Type to remove

Throws:

NotFoundException - type is not found

NullArgumentException - type is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

makeEquivalent

void makeEquivalent(Type primaryType,
 Type equivalentType)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Makes two Types equivalent. Calls to TypeLookupSession.getType(equivalentType) return the primaryType .

Parameters:

primaryType - the primary Type

equivalentType - a Type to be made equivalent

Throws:

NotFoundException - primaryType or equivalentType is not found

NullArgumentException - primaryType or equivalentType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addBaseType

void addBaseType(Type type,
 Type baseType)
          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a base type to a type. A base type is a parent of the type where the type implies support of the base type.

Parameters:

type - a Type

baseType - a base type

Throws:

NotFoundException - type or baseType is not found

NullArgumentException - type or baseType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeBaseType

void removeBaseType(Type type,
 Type baseType)
             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a base type from a type.

Parameters:

type - a Type

baseType - a base type

Throws:

NotFoundException - type or baseType is not found or baseType is not a base of type

NullArgumentException - type or baseType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

addTypeRelation

void addTypeRelation(Type sourceType,
 Type destinationType,
 Type relationType)
              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds a relation between two types. The relationship is a Type in itself.

Parameters:

sourceType - the source type

destinationType - the destination type

relationType - the relation type

Throws:

NotFoundException - sourceType, destinationType , or relationType is not found

NullArgumentException - sourceType, destinationType , or relationType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

removeTypeRelation

void removeTypeRelation(Type sourceType,
 Type destinationType,
 Type relationType)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Renoves a relation between two types.

Parameters:

sourceType - the source type

destinationType - the destination type

relationType - the relation type

Throws:

NotFoundException - sourceType, destinationType , or relationType is not found, or the relationship does not exist

NullArgumentException - sourceType, destinationType , or relationType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.