Interface AntimatroidAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface AntimatroidAdminSession
extends OsidSession

This session creates, updates, and deletes Antimatroids . 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 Antimatroid , an AntimatroidForm is requested using getAntimatroidFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned AntimatroidForm 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 AntimatroidForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each AntimatroidForm corresponds to an attempted transinput.

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

The delete operations delete Antimatroids .

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

Method Summary

Modifier and Type	Method	Description
void	aliasAntimatroid(Id antimatroidId, Id aliasId)	Adds an Id to an Antimatroid for the purpose of creating compatibility.
boolean	canCreateAntimatroids()	Tests if this user can create Antimatroids .
boolean	canCreateAntimatroidWithRecordTypes(Type[] antimatroidRecordTypes)	Tests if this user can create a single Antimatroid using the desired record types.
boolean	canDeleteAntimatroids()	Tests if this user can delete Antimatroids .
boolean	canManageAntimatroidAliases()	Tests if this user can manage Id aliases for Antimatroids .
boolean	canUpdateAntimatroids()	Tests if this user can update Antimatroids .
Antimatroid	createAntimatroid(AntimatroidForm antimatroidForm)	Creates a new Antimatroid .
void	deleteAntimatroid(Id antimatroidId)	Deletes an Antimatroid .
AntimatroidForm	getAntimatroidFormForCreate(Type[] antimatroidRecordTypes)	Gets the antimatroid form for creating new antimatroids.
AntimatroidForm	getAntimatroidFormForUpdate(Id antimatroidId)	Gets the antimatroid form for updating an existing antimatroid.
void	updateAntimatroid(AntimatroidForm antimatroidForm)	Updates an existing antimatroid

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

canCreateAntimatroids

boolean canCreateAntimatroids()

Tests if this user can create Antimatroids . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an Antimatroid . 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 Antimatroid creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateAntimatroidWithRecordTypes

boolean canCreateAntimatroidWithRecordTypes(Type[] antimatroidRecordTypes)

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

Parameters:

antimatroidRecordTypes - array of antimatroid record types

Returns:

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

Throws:

NullArgumentException - antimatroidRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getAntimatroidFormForCreate

AntimatroidForm getAntimatroidFormForCreate(Type[] antimatroidRecordTypes)
                                     throws OperationFailedException,
PermissionDeniedException

Gets the antimatroid form for creating new antimatroids. A new form should be requested for each create transinput.

Parameters:

antimatroidRecordTypes - array of antimatroid record types

Returns:

the antimatroid form

Throws:

NullArgumentException - antimatroidRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createAntimatroid

Antimatroid createAntimatroid(AntimatroidForm antimatroidForm)
                       throws OperationFailedException,
PermissionDeniedException

Creates a new Antimatroid .

Parameters:

antimatroidForm - the form for this Antimatroid

Returns:

the new Antimatroid

Throws:

IllegalStateException - antimatroidForm already used in a create transinput

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - antimatroidForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - antimatroidForm did not originate from getAntimatroidFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateAntimatroids

boolean canUpdateAntimatroids()

Tests if this user can update Antimatroids . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an Antimatroid 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 Antimatroid modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAntimatroidFormForUpdate

AntimatroidForm getAntimatroidFormForUpdate(Id antimatroidId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the antimatroid form for updating an existing antimatroid. A new antimatroid form should be requested for each update transinput.

Parameters:

antimatroidId - the Id of the Antimatroid

Returns:

the antimatroid form

Throws:

NotFoundException - antimatroidId is not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateAntimatroid

void updateAntimatroid(AntimatroidForm antimatroidForm)
                throws OperationFailedException,
PermissionDeniedException

Updates an existing antimatroid

Parameters:

antimatroidForm - the form containing the elements to be updated

Throws:

IllegalStateException - antimatroidForm already used in an update transinput

InvalidArgumentException - the form contains an invalid value

NullArgumentException - antimatroidForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - antimatroidForm did not originate from getAntimatroidFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteAntimatroids

boolean canDeleteAntimatroids()

Tests if this user can delete Antimatroids . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an Antimatroid 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 Antimatroid deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteAntimatroid

void deleteAntimatroid(Id antimatroidId)
                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes an Antimatroid .

Parameters:

antimatroidId - the Id of the Antimatroid to remove

Throws:

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageAntimatroidAliases

boolean canManageAntimatroidAliases()

Tests if this user can manage Id aliases for Antimatroids . 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 Antimatroid aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasAntimatroid

void aliasAntimatroid(Id antimatroidId,
 Id aliasId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to an Antimatroid for the purpose of creating compatibility. The primary Id of the Antimatroid is determined by the provider. The new Id performs as an alias to the primary Id .

Parameters:

antimatroidId - the Id of an Antimatroid

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - antimatroidId not found

NullArgumentException - antimatroidId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.