public interface AuditEnablerAdminSession extends OsidSession
This session creates and removes audit enablers. The data for create
and update is provided via the AuditEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasAuditEnabler(Id auditEnablerId,
Id aliasId)
Adds an
Id to an AuditEnabler for the
purpose of creating compatibility. |
boolean |
canCreateAuditEnabler()
Tests if this user can create audit enablers.
|
boolean |
canCreateAuditEnablerWithRecordTypes(Type[] auditEnablerRecordTypes)
Tests if this user can create a single
AuditEnabler
using the desired record types. |
boolean |
canDeleteAuditEnablers()
Tests if this user can delete audit enablers.
|
boolean |
canManageAuditEnablerAliases()
Tests if this user can manage
Id aliases for audit
enablers. |
boolean |
canUpdateAuditEnablers()
Tests if this user can update audit enablers.
|
AuditEnabler |
createAuditEnabler(AuditEnablerForm auditEnablerForm)
Creates a new
AuditEnabler. |
void |
deleteAuditEnabler(Id auditEnablerId)
Deletes an
AuditEnabler. |
AuditEnablerForm |
getAuditEnablerFormForCreate(Type[] auditEnablerRecordTypes)
Gets the audit enabler form for creating new audit enablers.
|
AuditEnablerForm |
getAuditEnablerFormForUpdate(Id auditEnablerId)
Gets the audit enabler form for updating an existing audit enabler.
|
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
updateAuditEnabler(AuditEnablerForm auditEnablerForm)
Updates an existing audit enabler.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestId()
Inquest
Id
associated with this
session. Inquest Id
associated with this sessionmandatory
- This method must be implemented. Inquest getInquest() throws OperationFailedException, PermissionDeniedException
Inquest
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateAuditEnabler()
AuditEnabler
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 AuditEnabler
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateAuditEnablerWithRecordTypes(Type[] auditEnablerRecordTypes)
AuditEnabler
using the desired record types. While
InquiryRulesManager.getAuditEnablerRecordTypes()
can be used
to examine which records are supported, this method tests which
record(s) are required for creating a specific AuditEnabler.
Providing an empty array tests if an AuditEnabler
can be created with no records.auditEnablerRecordTypes
- array of audit enabler record types true
if AuditEnabler
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- auditEnablerRecordTypes
is null
mandatory
- This method must be implemented. AuditEnablerForm getAuditEnablerFormForCreate(Type[] auditEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
auditEnablerRecordTypes
- array of audit enabler record typesNullArgumentException
- auditEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. AuditEnabler createAuditEnabler(AuditEnablerForm auditEnablerForm) throws OperationFailedException, PermissionDeniedException
AuditEnabler.
auditEnablerForm
- the form for this AuditEnabler
AuditEnabler
IllegalStateException
- auditEnablerForm
already used in a create transinquiryInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- auditEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auditEnablerForm did not
originate from getAuditEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateAuditEnablers()
AuditEnabler
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 AuditEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. AuditEnablerForm getAuditEnablerFormForUpdate(Id auditEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
auditEnablerId
- the Id
of the
AuditEnabler
NotFoundException
- auditEnablerId
is
not foundNullArgumentException
- auditEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateAuditEnabler(AuditEnablerForm auditEnablerForm) throws OperationFailedException, PermissionDeniedException
auditEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- auditEnablerForm
already used in an update transinquiryInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- auditEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- auditEnablerForm
did not originate from getAuditEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteAuditEnablers()
AuditEnabler
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 AuditEnabler
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteAuditEnabler(Id auditEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AuditEnabler.
auditEnablerId
- the Id
of the
AuditEnabler
to removeNotFoundException
- auditEnablerId
not
foundNullArgumentException
- auditEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageAuditEnablerAliases()
Id
aliases for audit
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 AuditEnabler
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasAuditEnabler(Id auditEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an AuditEnabler
for the
purpose of creating compatibility. The primary Id
of
the AuditEnabler
is determined by the provider. The new
Id
performs as an alias to the primary Id
. If the alias is a pointer to another audit enabler. it is
reassigned to the given audit enabler Id.
auditEnablerId
- the Id
of an AuditEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- auditEnablerId
not
foundNullArgumentException
- auditEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.