Interface CommitmentAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

CommitmentBatchAdminSession

public interface CommitmentAdminSession
extends OsidSession

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

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

The delete operations delete Commitment . To unmap a Commitment from the current Calendar , the CommitmentCalendarAssignmentSession should be used. These delete operations attempt to remove the Commitment itself thus removing it from all known Calendar catalogs.

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	aliasCommitment(Id commitmentId, Id aliasId)	Adds an Id to a Commitment for the purpose of creating compatibility.
boolean	canCreateCommitments()	Tests if this user can create Commitments .
boolean	canCreateCommitmentWithRecordTypes(Type[] commitmentRecordTypes)	Tests if this user can create a single Commitment using the desired record types.
boolean	canDeleteCommitments()	Tests if this user can delete Commitments .
boolean	canManageCommitmentAliases()	Tests if this user can manage Id aliases for Commitments .
boolean	canUpdateCommitments()	Tests if this user can update Commitments .
Commitment	createCommitment(CommitmentForm commitmentForm)	Creates a new Commitment .
void	deleteCommitment(Id commitmentId)	Deletes the Commitment identified by the given Id .
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
CommitmentForm	getCommitmentFormForCreate(Id eventId, Id resourceId, Type[] commitmentRecordTypes)	Gets the commitment form for creating new commitments.
CommitmentForm	getCommitmentFormForUpdate(Id commitmentId)	Gets the commitment form for updating an existing commitment.
void	updateCommitment(CommitmentForm commitmentForm)	Updates an existing commitment.

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

getCalendarId

Id getCalendarId()

Gets the Calendar Id associated with this session.

Returns:

the Calendar Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendar

Calendar getCalendar()
              throws OperationFailedException,
PermissionDeniedException

Gets the Calendar associated with this session.

Returns:

the Calendar associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateCommitments

boolean canCreateCommitments()

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

Compliance:

mandatory - This method must be implemented.

canCreateCommitmentWithRecordTypes

boolean canCreateCommitmentWithRecordTypes(Type[] commitmentRecordTypes)

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

Parameters:

commitmentRecordTypes - array of comitment record types

Returns:

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

Throws:

NullArgumentException - commitmentRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getCommitmentFormForCreate

CommitmentForm getCommitmentFormForCreate(Id eventId,
 Id resourceId,
 Type[] commitmentRecordTypes)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the commitment form for creating new commitments. A new form should be requested for each create transaction.

Parameters:

eventId - the Id of the Event

resourceId - the Id of the Resource

commitmentRecordTypes - array of comitment record types

Returns:

the commitment form

Throws:

NotFoundException - eventId or resourceId is not found

NullArgumentException - eventId or resourceId or commitmentRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested recod types

Compliance:

mandatory - This method must be implemented.

createCommitment

Commitment createCommitment(CommitmentForm commitmentForm)
                     throws OperationFailedException,
PermissionDeniedException

Creates a new Commitment .

Parameters:

commitmentForm - the forms for this Commitment

Returns:

the new Commitment

Throws:

IllegalStateException - commitmentForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - commitmentForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - commitmentForm did not originate from getCommitmentFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateCommitments

boolean canUpdateCommitments()

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

Compliance:

mandatory - This method must be implemented.

getCommitmentFormForUpdate

CommitmentForm getCommitmentFormForUpdate(Id commitmentId)
                                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

commitmentId - the Id of the Commitment

Returns:

the commitment form

Throws:

NotFoundException - commitmentId is not found

NullArgumentException - commitmentid is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateCommitment

void updateCommitment(CommitmentForm commitmentForm)
               throws OperationFailedException,
PermissionDeniedException

Updates an existing commitment.

Parameters:

commitmentForm - the form containing the elements to be updated

Throws:

IllegalStateException - commitmentForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - commitmentForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - commitmentForm did not originate from getCommitmentFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteCommitments

boolean canDeleteCommitments()

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

Compliance:

mandatory - This method must be implemented.

deleteCommitment

void deleteCommitment(Id commitmentId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes the Commitment identified by the given Id .

Parameters:

commitmentId - the Id of the Commitment to delete

Throws:

NotFoundException - a Commitment was not found identified by the given Id

NullArgumentException - commitmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageCommitmentAliases

boolean canManageCommitmentAliases()

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

Compliance:

mandatory - This method must be implemented.

aliasCommitment

void aliasCommitment(Id commitmentId,
 Id aliasId)
              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

commitmentId - the Id of a Commitment

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - commitmentId not found

NullArgumentException - commitmentId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.