public interface HoldEnablerAdminSession extends OsidSession
This session creates and removes hold enablers. The data for create and
update is provided via the HoldEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasHoldEnabler(Id holdEnablerId,
Id aliasId)
Adds an
Id to a HoldEnabler for the
purpose of creating compatibility. |
boolean |
canCreateHoldEnabler()
Tests if this user can create hold enablers.
|
boolean |
canCreateHoldEnablerWithRecordTypes(Type[] holdEnablerRecordTypes)
Tests if this user can create a single
HoldEnabler
using the desired record types. |
boolean |
canDeleteHoldEnablers()
Tests if this user can delete hold enablers.
|
boolean |
canManageHoldEnablerAliases()
Tests if this user can manage
Id aliases for hold
enablers. |
boolean |
canUpdateHoldEnablers()
Tests if this user can update hold enablers.
|
HoldEnabler |
createHoldEnabler(HoldEnablerForm holdEnablerForm)
Creates a new
HoldEnabler. |
void |
deleteHoldEnabler(Id holdEnablerId)
Deletes a
HoldEnabler. |
HoldEnablerForm |
getHoldEnablerFormForCreate(Type[] holdEnablerRecordTypes)
Gets the hold enabler form for creating new hold enablers.
|
HoldEnablerForm |
getHoldEnablerFormForUpdate(Id holdEnablerId)
Gets the hold enabler form for updating an existing hold enabler.
|
Oubliette |
getOubliette()
Gets the
Oubliette associated with this session. |
Id |
getOublietteId()
Gets the
Oubliette Id associated with
this session. |
void |
updateHoldEnabler(HoldEnablerForm holdEnablerForm)
Updates an existing hold enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteId()
Oubliette
Id
associated with
this session. Oubliette Id
associated with this sessionmandatory
- This method must be implemented. Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
Oubliette
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateHoldEnabler()
HoldEnabler
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 HoldEnabler
creation is
not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateHoldEnablerWithRecordTypes(Type[] holdEnablerRecordTypes)
HoldEnabler
using the desired record types. While
HoldRulesManager.getHoldEnablerRecordTypes()
can be used to
examine which records are supported, this method tests which record(s)
are required for creating a specific HoldEnabler.
Providing an empty array tests if a HoldEnabler
can be
created with no records.holdEnablerRecordTypes
- array of hold enabler record types true
if HoldEnabler
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- holdEnablerRecordTypes
is null
mandatory
- This method must be implemented. HoldEnablerForm getHoldEnablerFormForCreate(Type[] holdEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
holdEnablerRecordTypes
- array of hold enabler record typesNullArgumentException
- holdEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. HoldEnabler createHoldEnabler(HoldEnablerForm holdEnablerForm) throws OperationFailedException, PermissionDeniedException
HoldEnabler.
holdEnablerForm
- the form for this HoldEnabler
HoldEnabler
IllegalStateException
- holdEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- holdEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- holdEnablerForm
did not originate from getHoldEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateHoldEnablers()
HoldEnabler
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 HoldEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. HoldEnablerForm getHoldEnablerFormForUpdate(Id holdEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
holdEnablerId
- the Id
of the HoldEnabler
NotFoundException
- holdEnablerId
is not
foundNullArgumentException
- holdEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateHoldEnabler(HoldEnablerForm holdEnablerForm) throws OperationFailedException, PermissionDeniedException
holdEnablerForm
- the form containing the elements to be updatedIllegalStateException
- holdEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- holdEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- holdEnablerForm
did not originate from getHoldEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteHoldEnablers()
HoldEnabler
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 HoldEnabler
deletion is
not authorized, true
otherwisemandatory
- This method must be implemented. void deleteHoldEnabler(Id holdEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
HoldEnabler.
holdEnablerId
- the Id
of the HoldEnabler
to removeNotFoundException
- holdEnablerId
not
foundNullArgumentException
- holdEnablerId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageHoldEnablerAliases()
Id
aliases for hold
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 HoldEnabler
aliasing is
not authorized, true
otherwisemandatory
- This method must be implemented. void aliasHoldEnabler(Id holdEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a HoldEnabler
for the
purpose of creating compatibility. The primary Id
of
the HoldEnabler
is determined by the provider. The new
Id
performs as an alias to the primary Id
. If the alias is a pointer to another hold enabler. it is
reassigned to the given hold enabler Id.
holdEnablerId
- the Id
of a HoldEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- holdEnablerId
not
foundNullArgumentException
- holdEnablerId
or
aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.