public interface AvailabilityEnablerAdminSession extends OsidSession
This session creates and removes availability enablers. The data for
create and update is provided via the AvailabilityEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasAvailabilityEnabler(Id availabilityEnablerId,
Id aliasId)
Adds an
Id to an AvailabilityEnabler for
the purpose of creating compatibility. |
boolean |
canCreateAvailabilityEnabler()
Tests if this user can create availability enablers.
|
boolean |
canCreateAvailabilityEnablerWithRecordTypes(Type[] availabilityEnablerRecordTypes)
Tests if this user can create a single
AvailabilityEnabler
using the desired record types. |
boolean |
canDeleteAvailabilityEnablers()
Tests if this user can delete availability enablers.
|
boolean |
canManageAvailabilityEnablerAliases()
Tests if this user can manage
Id aliases for
availability enablers. |
boolean |
canUpdateAvailabilityEnablers()
Tests if this user can update availability enablers.
|
AvailabilityEnabler |
createAvailabilityEnabler(AvailabilityEnablerForm availabilityEnablerForm)
Creates a new
AvailabilityEnabler. |
void |
deleteAvailabilityEnabler(Id availabilityEnablerId)
Deletes an
AvailabilityEnabler. |
AvailabilityEnablerForm |
getAvailabilityEnablerFormForCreate(Type[] availabilityEnablerRecordTypes)
Gets the availability enabler form for creating new availability
enablers.
|
AvailabilityEnablerForm |
getAvailabilityEnablerFormForUpdate(Id availabilityEnablerId)
Gets the availability enabler form for updating an existing
availability enabler.
|
Foundry |
getFoundry()
Gets the
Foundry associated with this session. |
Id |
getFoundryId()
Gets the
Foundry Id associated with this
session. |
void |
updateAvailabilityEnabler(AvailabilityEnablerForm availabilityEnablerForm)
Updates an existing availability enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFoundryId()
Foundry
Id
associated with this
session. Foundry Id
associated with this sessionmandatory
- This method must be implemented. Foundry getFoundry() throws OperationFailedException, PermissionDeniedException
Foundry
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateAvailabilityEnabler()
AvailabilityEnabler
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 AvailabilityEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateAvailabilityEnablerWithRecordTypes(Type[] availabilityEnablerRecordTypes)
AvailabilityEnabler
using the desired record types. While
ResourcingRulesManager.getAvailabilityEnablerRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
AvailabilityEnabler.
Providing an empty array tests if an
AvailabilityEnabler
can be created with no records.availabilityEnablerRecordTypes
- array of availability enabler
record types true
if AvailabilityEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
availabilityEnablerRecordTypes
is null
mandatory
- This method must be implemented. AvailabilityEnablerForm getAvailabilityEnablerFormForCreate(Type[] availabilityEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
availabilityEnablerRecordTypes
- array of availability enabler
record typesNullArgumentException
-
availabilityEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form with
requested record typesmandatory
- This method must be implemented. AvailabilityEnabler createAvailabilityEnabler(AvailabilityEnablerForm availabilityEnablerForm) throws OperationFailedException, PermissionDeniedException
AvailabilityEnabler.
availabilityEnablerForm
- the form for this
AvailabilityEnabler
AvailabilityEnabler
IllegalStateException
- availabilityEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- availabilityEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- availabilityEnablerForm
did not originate from
getAvailabilityEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateAvailabilityEnablers()
AvailabilityEnabler
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 AvailabilityEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. AvailabilityEnablerForm getAvailabilityEnablerFormForUpdate(Id availabilityEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
availabilityEnablerId
- the Id
of the
AvailabilityEnabler
NotFoundException
- availabilityEnablerId
is not foundNullArgumentException
- availabilityEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateAvailabilityEnabler(AvailabilityEnablerForm availabilityEnablerForm) throws OperationFailedException, PermissionDeniedException
availabilityEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- availabilityEnablerForm
already used in an jupdate transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- availabilityEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- availabilityEnablerForm
did not originate from
getAvailabilityEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteAvailabilityEnablers()
AvailabilityEnabler
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 AvailabilityEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteAvailabilityEnabler(Id availabilityEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AvailabilityEnabler.
availabilityEnablerId
- the Id
of the
AvailabilityEnabler
to removeNotFoundException
- availabilityEnablerId
not foundNullArgumentException
- availabilityEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageAvailabilityEnablerAliases()
Id
aliases for
availability 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 AvailabilityEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasAvailabilityEnabler(Id availabilityEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an AvailabilityEnabler
for
the purpose of creating compatibility. The primary Id
of the AvailabilityEnabler
is determined by the
provider. The new Id
performs as an alias to the
primary Id
. If the alias is a pointer to another
availability enabler. it is reassigned to the given availability
enabler Id.
availabilityEnablerId
- the Id
of an
AvailabilityEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- availabilityEnablerId
not foundNullArgumentException
- availabilityEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.