public interface InquiryEnablerRuleApplicationSession extends OsidSession
This session provides methods to apply InquiryEnablers
to Inquiries.
An Inquiry
with multiple
InquiryEnablers
means any positive rule evaluation across
the enablers result in an active Inquiry.
Modifier and Type | Method and Description |
---|---|
void |
assignInquiryEnablerToInquiry(Id inquiryEnablerId,
Id inquiryId)
Adds an existing
InquiryEnabler to an Inquiry. |
boolean |
canAssignInquiryEnablers()
Tests if this user can alter inquiry enabler/inquiry mappings.
|
boolean |
canSequenceInquiryEnablers()
Tests if this user can order
InquiryEnablers. |
Inquest |
getInquest()
Gets the
Inquest associated with this session. |
Id |
getInquestId()
Gets the
Inquest Id associated with this
session. |
void |
moveInquiryEnablerAhead(Id inquiryEnablerId,
Id inquiryId,
Id referenceId)
Reorders inquiry enablers for an inquiry by moving the specified
inquiry enabler in front of a reference inquiry enabler.
|
void |
moveInquiryEnablerBehind(Id inquiryEnablerId,
Id inquiryId,
Id referenceId)
Reorders inquiry enablers for an inquiry by moving the specified
inquiry enabler behind a reference inquiry enabler.
|
void |
orderInquiryEnablers(Id[] inquiryEnablerIds,
Id inquiryId)
Reorders a set of inquiry enablers for an inquiry.
|
void |
unassignInquiryEnablerFromInquiry(Id inquiryEnablerId,
Id inquiryId)
Removes an
InquiryEnabler from an Inquiry. |
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 canAssignInquiryEnablers()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. void assignInquiryEnablerToInquiry(Id inquiryEnablerId, Id inquiryId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
InquiryEnabler
to an Inquiry.
inquiryEnablerId
- the Id
of the
InquiryEnabler
inquiryId
- the Id
of the Inquiry
AlreadyExistsException
- inquiryEnablerId
already applied to inquiryId
NotFoundException
- inquiryEnablerId
or
inquiryId
not foundNullArgumentException
- inquiryEnablerId
or inquiryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignInquiryEnablerFromInquiry(Id inquiryEnablerId, Id inquiryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
InquiryEnabler
from an Inquiry.
inquiryEnablerId
- the Id
of the
InquiryEnabler
inquiryId
- the Id
of the Inquiry
NotFoundException
- inquiryEnablerId
or
inquiryId
not found or inquiryEnablerId
not applied to inquiryId
NullArgumentException
- inquiryEnablerId
or inquiryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canSequenceInquiryEnablers()
InquiryEnablers.
A return
of true does not guarantee successful authorization. A return of false
indicates that it is known sequencing operations will result in a
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer sequencing operations to an
unauthorized user. false
if InquiryEnabler
ordering
is not authorized, true
otherwisemandatory
- This method must be implemented. void moveInquiryEnablerAhead(Id inquiryEnablerId, Id inquiryId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquiryEnablerId
- the Id
of an
InquiryEnabler
inquiryId
- the Id
of an Inquiry
referenceId
- the reference inquiry enabler Id
NotFoundException
- inquiryEnablerId, inquiryId,
or referenceId
not found or,
inquiryEnablerId
or referenceId
not
related to inquiryId
NullArgumentException
- inquiryEnablerId,
inquiryId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void moveInquiryEnablerBehind(Id inquiryEnablerId, Id inquiryId, Id referenceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquiryEnablerId
- the Id
of an
InquiryEnabler
inquiryId
- the Id
of an Inquiry
referenceId
- the reference inquiry enabler Id
NotFoundException
- inquiryEnablerId, inquiryId,
or referenceId
not found or,
inquiryEnablerId
or referenceId
not
related to inquiryId
NullArgumentException
- inquiryEnablerId,
inquiryId,
or referenceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void orderInquiryEnablers(Id[] inquiryEnablerIds, Id inquiryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
inquiryEnablerIds
- the Ids
for a set of
InquiryEnablers
inquiryId
- the Id
of an Inquiry
NotFoundException
- inquiryConstraienrId
not found or, an inquiryEnablerId
not related
to inquiryId
NullArgumentException
- inquiryEnablerIds
or inquiryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.