org.osid.calendaring.rules

Interface CommitmentEnablerRuleLookupSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition
• isolated calendar view: All methods in this session operate, retrieve and pertain commitment enablers defined explicitly in the current calendar
• federated calendar view: All methods in this session operate, retrieve and pertain to all commitment enablers defined in this calendar and any other commitment enablers implicitly available in this calendar through calendar inheritence.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getCalendarId

Id getCalendarId()

Gets the Calendar Id associated with this session.

Returns:

the Calendar Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendar

Calendar getCalendar()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Calendar associated with this session.

Returns:

the calendar

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupCommitmentEnablerRules

boolean canLookupCommitmentEnablerRules()

Tests if this user can perform lookups of commitment enabler/commitment mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCommitmentEnablerRuleView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryCommitmentEnablerRuleView

void usePlenaryCommitmentEnablerRuleView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

useFederatedCalendarView

void useFederatedCalendarView()

Federates the view for methods in this session. A federated view will include commitment enablers in calendars which are children of this calendar in the calendar hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCalendarView

void useIsolatedCalendarView()

Isolates the view for methods in this session. An isolated view restricts lookups to this calendar only.

Compliance:

mandatory - This method is must be implemented.

getCommitmentEnablerIdsForCommitment

IdList getCommitmentEnablerIdsForCommitment(Id commitmentId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the CommitmentEnabler Id associated with a Commitment.

Parameters:

commitmentId - Id of the Commitment

Returns:

the commitment enabler Ids

Throws:

NotFoundException - commitmentId is not found

NullArgumentException - commitmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommitmentEnablersForCommitment

CommitmentEnablerList getCommitmentEnablersForCommitment(Id commitmentId)
                                                         throws NotFoundException,
                                                                OperationFailedException,
                                                                PermissionDeniedException

Gets the CommitmentEnabler associated with a Commitment.

Parameters:

commitmentId - Id of the Commitment

Returns:

the commitment enablers

Throws:

NotFoundException - commitmentId is not found

NullArgumentException - commitmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommitmentIdsForCommitmentEnabler

IdList getCommitmentIdsForCommitmentEnabler(Id commitmentEnablerId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the Commitment Ids mapped to a CommitmentEnabler.

Parameters:

commitmentEnablerId - Id of a CommitmentEnabler

Returns:

list of commitment Ids

Throws:

NotFoundException - commitmentEnablerId is not found

NullArgumentException - commitmentEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCommitmentsForCommitmentEnabler

CommitmentList getCommitmentsForCommitmentEnabler(Id commitmentEnablerId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the Commitments mapped to a CommitmentEnabler.

Parameters:

commitmentEnablerId - Id of a CommitmentEnabler

Returns:

list of commitments

Throws:

NotFoundException - commitmentEnablerId is not found

NullArgumentException - commitmentEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.