public interface AuthorizationEnablerAdminSession extends OsidSession
This session creates and removes authorization enablers. The data for
create and update is provided via the AuthorizationEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasAuthorizationEnabler(Id authorizationEnablerId,
Id aliasId)
Adds an
Id to an AuthorizationEnabler
for the purpose of creating compatibility. |
boolean |
canCreateAuthorizationEnabler()
Tests if this user can create authorization enablers.
|
boolean |
canCreateAuthorizationEnablerWithRecordTypes(Type[] authorizationEnablerRecordTypes)
Tests if this user can create a single
AuthorizationEnabler
using the desired record types. |
boolean |
canDeleteAuthorizationEnablers()
Tests if this user can delete authorization enablers.
|
boolean |
canManageAuthorizationEnablerAliases()
Tests if this user can manage
Id aliases for
authorization enablers. |
boolean |
canUpdateAuthorizationEnablers()
Tests if this user can update authorization enablers.
|
AuthorizationEnabler |
createAuthorizationEnabler(AuthorizationEnablerForm authorizationEnablerForm)
Creates a new
AuthorizationEnabler. |
void |
deleteAuthorizationEnabler(Id authorizationEnablerId)
Deletes an
AuthorizationEnabler. |
AuthorizationEnablerForm |
getAuthorizationEnablerFormForCreate(Type[] authorizationEnablerRecordTypes)
Gets the authorization enabler form for creating new authorization
enablers.
|
AuthorizationEnablerForm |
getAuthorizationEnablerFormForUpdate(Id authorizationEnablerId)
Gets the authorization enabler form for updating an existing
authorization enabler.
|
Vault |
getVault()
Gets the
Vault associated with this session. |
Id |
getVaultId()
Gets the
Vault Id associated with this
session. |
void |
updateAuthorizationEnabler(AuthorizationEnablerForm authorizationEnablerForm)
Updates an existing authorization enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getVaultId()
Vault
Id
associated with this
session. Vault Id
associated with this sessionmandatory
- This method must be implemented. Vault getVault() throws OperationFailedException, PermissionDeniedException
Vault
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateAuthorizationEnabler()
AuthorizationEnabler
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 AuthorizationEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateAuthorizationEnablerWithRecordTypes(Type[] authorizationEnablerRecordTypes)
AuthorizationEnabler
using the desired record types. While
AuthorizationRulesManager.getAuthorizationEnablerRecordTypes()
can be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
AuthorizationEnabler.
Providing an empty array tests if an
AuthorizationEnabler
can be created with no records.authorizationEnablerRecordTypes
- array of authorization enabler
record types true
if AuthorizationEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
authorizationEnablerRecordTypes
is null
mandatory
- This method must be implemented. AuthorizationEnablerForm getAuthorizationEnablerFormForCreate(Type[] authorizationEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
authorizationEnablerRecordTypes
- array of authorization enabler
record typesNullArgumentException
-
authorizationEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. AuthorizationEnabler createAuthorizationEnabler(AuthorizationEnablerForm authorizationEnablerForm) throws OperationFailedException, PermissionDeniedException
AuthorizationEnabler.
authorizationEnablerForm
- the form for this
AuthorizationEnabler
AuthorizationEnabler
IllegalStateException
- authorizationEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- authorizationEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- authorizationEnablerForm
did not originate from
getAuthorizationEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateAuthorizationEnablers()
AuthorizationEnabler
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 AuthorizationEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. AuthorizationEnablerForm getAuthorizationEnablerFormForUpdate(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
authorizationEnablerId
- the Id
of the
AuthorizationEnabler
NotFoundException
- authorizationEnablerId
is not foundNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateAuthorizationEnabler(AuthorizationEnablerForm authorizationEnablerForm) throws OperationFailedException, PermissionDeniedException
authorizationEnablerForm
- the form containing the elements to
be updatedIllegalStateException
- authorizationEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- authorizationEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- authorizationEnablerForm
did not originate from
getAuthorizationEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteAuthorizationEnablers()
AuthorizationEnabler
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 AuthorizationEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteAuthorizationEnabler(Id authorizationEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuthorizationEnabler.
authorizationEnablerId
- the Id
of the
AuthorizationEnabler
to removeNotFoundException
- authorizationEnablerId
not foundNullArgumentException
- authorizationEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageAuthorizationEnablerAliases()
Id
aliases for
authorization 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 AuthorizationEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasAuthorizationEnabler(Id authorizationEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an AuthorizationEnabler
for the purpose of creating compatibility. The primary Id
of the AuthorizationEnabler
is determined by
the provider. The new Id
performs as an alias to the
primary Id
. If the alias is a pointer to another
authorization enabler. it is reassigned to the given authorization
enabler Id.
authorizationEnablerId
- the Id
of an
AuthorizationEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- authorizationEnablerId
not foundNullArgumentException
- authorizationEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.