public interface CommitmentEnablerRuleLookupSession extends OsidSession
This session provides methods to retrieve CommitmentEnabler
to Commitment
mappings. A Commitment
with multiple CommitmentEnablers
means any positive rule
evaluation across the enablers result in an enabled Commitment.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupCommitmentEnablerRules()
Tests if this user can perform lookups of commitment
enabler/commitment mappings.
|
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
IdList |
getCommitmentEnablerIdsForCommitment(Id commitmentId)
Gets the
CommitmentEnabler Id associated with a
Commitment. |
CommitmentEnablerList |
getCommitmentEnablersForCommitment(Id commitmentId)
Gets the
CommitmentEnabler associated with a
Commitment. |
IdList |
getCommitmentIdsForCommitmentEnabler(Id commitmentEnablerId)
Gets the
Commitment Ids mapped to a
CommitmentEnabler. |
CommitmentList |
getCommitmentsForCommitmentEnabler(Id commitmentEnablerId)
Gets the
Commitments mapped to a
CommitmentEnabler. |
void |
useComparativeCommitmentEnablerRuleView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
void |
usePlenaryCommitmentEnablerRuleView()
A complete view of the
CommitmentEnabler and
Commitment returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupCommitmentEnablerRules()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeCommitmentEnablerRuleView()
mandatory
- This method is must be implemented. void usePlenaryCommitmentEnablerRuleView()
CommitmentEnabler
and
Commitment
returns is desired. Methods will return what is
requested or result in an error. This view is used when greater
precision is desired at the expense of interoperability.mandatory
- This method is must be implemented. void useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. IdList getCommitmentEnablerIdsForCommitment(Id commitmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommitmentEnabler Id
associated with a
Commitment.
commitmentId
- Id
of the Commitment
Ids
NotFoundException
- commitmentId
is not
foundNullArgumentException
- commitmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentEnablerList getCommitmentEnablersForCommitment(Id commitmentId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CommitmentEnabler
associated with a
Commitment.
commitmentId
- Id
of the Commitment
NotFoundException
- commitmentId
is not
foundNullArgumentException
- commitmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getCommitmentIdsForCommitmentEnabler(Id commitmentEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Commitment
Ids
mapped to a
CommitmentEnabler.
commitmentEnablerId
- Id
of a
CommitmentEnabler
Ids
NotFoundException
- commitmentEnablerId
is not foundNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CommitmentList getCommitmentsForCommitmentEnabler(Id commitmentEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Commitments
mapped to a
CommitmentEnabler.
commitmentEnablerId
- Id
of a
CommitmentEnabler
NotFoundException
- commitmentEnablerId
is not foundNullArgumentException
- commitmentEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.