public interface CommitmentEnablerAdminSession extends OsidSession
This session creates and removes commitment enablers. The data for
create and update is provided via the CommitmentEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasCommitmentEnabler(Id commitmentEnablerId,
Id aliasId)
Adds an
Id to a CommitmentEnabler for
the purpose of creating compatibility. |
boolean |
canCreateCommitmentEnabler()
Tests if this user can create commitment enablers.
|
boolean |
canCreateCommitmentEnablerWithRecordTypes(Type[] commitmentEnablerRecordTypes)
Tests if this user can create a single
CommitmentEnabler
using the desired record types. |
boolean |
canDeleteCommitmentEnablers()
Tests if this user can delete commitment enablers.
|
boolean |
canManageCommitmentEnablerAliases()
Tests if this user can manage
Id aliases for commitment
enablers. |
boolean |
canUpdateCommitmentEnablers()
Tests if this user can update commitment enablers.
|
CommitmentEnabler |
createCommitmentEnabler(CommitmentEnablerForm commitmentEnablerForm)
Creates a new
CommitmentEnabler. |
void |
deleteCommitmentEnabler(Id commitmentEnablerId)
Deletes a
CommitmentEnabler. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
CommitmentEnablerForm |
getCommitmentEnablerFormForCreate(Type[] commitmentEnablerRecordTypes)
Gets the commitment enabler form for creating new commitment enablers.
|
CommitmentEnablerForm |
getCommitmentEnablerFormForUpdate(Id commitmentEnablerId)
Gets the commitment enabler form for updating an existing commitment
enabler.
|
void |
updateCommitmentEnabler(CommitmentEnablerForm commitmentEnablerForm)
Updates an existing commitment enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateCommitmentEnabler()
CommitmentEnabler
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. false
if CommitmentEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateCommitmentEnablerWithRecordTypes(Type[] commitmentEnablerRecordTypes)
CommitmentEnabler
using the desired record types. While
CalendaringRulesManager.getCommitmentEnablerRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
CommitmentEnabler.
Providing an empty array tests if a
CommitmentEnabler
can be created with no records.commitmentEnablerRecordTypes
- array of commitment enabler
record types true
if CommitmentEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
commitmentEnablerRecordTypes
is null
mandatory
- This method must be implemented. CommitmentEnablerForm getCommitmentEnablerFormForCreate(Type[] commitmentEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
commitmentEnablerRecordTypes
- array of commitment enabler
record typesNullArgumentException
-
commitmentEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. CommitmentEnabler createCommitmentEnabler(CommitmentEnablerForm commitmentEnablerForm) throws OperationFailedException, PermissionDeniedException
CommitmentEnabler.
commitmentEnablerForm
- the form for this
CommitmentEnabler
CommitmentEnabler
IllegalStateException
- commitmentEnablerForm
already used in a create trsnactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- commitmentEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commitmentEnablerForm
did not originate from
getCommitmentEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateCommitmentEnablers()
CommitmentEnabler
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. false
if CommitmentEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. CommitmentEnablerForm getCommitmentEnablerFormForUpdate(Id commitmentEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
commitmentEnablerId
- the Id
of the
CommitmentEnabler
NotFoundException
- commitmentEnablerId
is not foundNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateCommitmentEnabler(CommitmentEnablerForm commitmentEnablerForm) throws OperationFailedException, PermissionDeniedException
commitmentEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- commitmentEnablerForm
already used in an update trsnactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- commitmentEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- commitmentEnablerForm
did not originate from
getCommitmentEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteCommitmentEnablers()
CommitmentEnabler
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. false
if CommitmentEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteCommitmentEnabler(Id commitmentEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommitmentEnabler.
commitmentEnablerId
- the Id
of the
CommitmentEnabler
to removeNotFoundException
- commitmentEnablerId
not foundNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageCommitmentEnablerAliases()
Id
aliases for commitment
enablers. 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. false
if CommitmentEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasCommitmentEnabler(Id commitmentEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a CommitmentEnabler
for
the purpose of creating compatibility. The primary Id
of the CommitmentEnabler
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 enabler.
it is reassigned to the given commitment enabler Id.
commitmentEnablerId
- the Id
of a
CommitmentEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- commitmentEnablerId
not foundNullArgumentException
- commitmentEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.