public interface InquiryEnablerAdminSession extends OsidSession
This session creates and removes inquiry enablers. The data for create
and update is provided via the InquiryEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasInquiryEnabler(Id inquiryEnablerId,
Id aliasId)
Adds an
Id to an InquiryEnabler for the
purpose of creating compatibility. |
boolean |
canCreateInquiryEnabler()
Tests if this user can create inquiry enablers.
|
boolean |
canCreateInquiryEnablerWithRecordTypes(Type[] inquiryEnablerRecordTypes)
Tests if this user can create a single
InquiryEnabler
using the desired record types. |
boolean |
canDeleteInquiryEnablers()
Tests if this user can delete inquiry enablers.
|
boolean |
canManageInquiryEnablerAliases()
Tests if this user can manage
Id aliases for inquiry
enablers. |
boolean |
canUpdateInquiryEnablers()
Tests if this user can update inquiry enablers.
|
InquiryEnabler |
createInquiryEnabler(InquiryEnablerForm inquiryEnablerForm)
Creates a new
InquiryEnabler. |
void |
deleteInquiryEnabler(Id inquiryEnablerId)
Deletes an
InquiryEnabler. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
InquiryEnablerForm |
getInquiryEnablerFormForCreate(Type[] inquiryEnablerRecordTypes)
Gets the inquiry enabler form for creating new inquiry enablers.
|
InquiryEnablerForm |
getInquiryEnablerFormForUpdate(Id inquiryEnablerId)
Gets the inquiry enabler form for updating an existing inquiry
enabler.
|
void |
updateInquiryEnabler(InquiryEnablerForm inquiryEnablerForm)
Updates an existing inquiry 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 canCreateInquiryEnabler()
InquiryEnabler
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 InquiryEnabler
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateInquiryEnablerWithRecordTypes(Type[] inquiryEnablerRecordTypes)
InquiryEnabler
using the desired record types. While
InquiryRulesManager.getInquiryEnablerRecordTypes()
can be used
to examine which records are supported, this method tests which
record(s) are required for creating a specific InquiryEnabler.
Providing an empty array tests if an InquiryEnabler
can be created with no records.inquiryEnablerRecordTypes
- array of inquiry enabler record
types true
if InquiryEnabler
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
-
inquiryEnablerRecordTypes
is null
mandatory
- This method must be implemented. InquiryEnablerForm getInquiryEnablerFormForCreate(Type[] inquiryEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
inquiryEnablerRecordTypes
- array of inquiry enabler record
typesNullArgumentException
-
inquiryEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. InquiryEnabler createInquiryEnabler(InquiryEnablerForm inquiryEnablerForm) throws OperationFailedException, PermissionDeniedException
InquiryEnabler.
inquiryEnablerForm
- the form for this InquiryEnabler
InquiryEnabler
IllegalStateException
- inquiryEnablerForm
already used in a create transinquiryInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- inquiryEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inquiryEnablerForm did
not originate from getInquiryEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateInquiryEnablers()
InquiryEnabler
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 InquiryEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. InquiryEnablerForm getInquiryEnablerFormForUpdate(Id inquiryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquiryEnablerId
- the Id
of the
InquiryEnabler
NotFoundException
- inquiryEnablerId
is
not foundNullArgumentException
- inquiryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateInquiryEnabler(InquiryEnablerForm inquiryEnablerForm) throws OperationFailedException, PermissionDeniedException
inquiryEnablerForm
- the form containing the elements to be
updatedIllegalStateException
- inquiryEnablerForm
already used in an update transinquiryInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- inquiryEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- inquiryEnablerForm
did not originate from
getInquiryEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteInquiryEnablers()
InquiryEnabler
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 InquiryEnabler
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteInquiryEnabler(Id inquiryEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InquiryEnabler.
inquiryEnablerId
- the Id
of the
InquiryEnabler
to removeNotFoundException
- inquiryEnablerId
not
foundNullArgumentException
- inquiryEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageInquiryEnablerAliases()
Id
aliases for inquiry
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 InquiryEnabler
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasInquiryEnabler(Id inquiryEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to an InquiryEnabler
for the
purpose of creating compatibility. The primary Id
of
the InquiryEnabler
is determined by the provider. The
new Id
performs as an alias to the primary Id
. If the alias is a pointer to another inquiry enabler. it is
reassigned to the given inquiry enabler Id.
inquiryEnablerId
- the Id
of an
InquiryEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- inquiryEnablerId
not
foundNullArgumentException
- inquiryEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.