org.osid.personnel

Interface AppointmentRealmSession

All Superinterfaces:

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

public interface AppointmentRealmSession
extends OsidSession

This session provides methods to retrieve Appointment to Realm mappings. An Appointment may appear in multiple Realms. Each Realm may have its own authorizations governing who is allowed to look at it.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAppointmentRealmMappings() Tests if this user can perform lookups of appointment/realm mappings.
IdList	getAppointmentIdsByRealm(Id realmId) Gets the list of Appointment Ids associated with a Realm.
IdList	getAppointmentIdsByRealms(IdList realmIds) Gets the list of Appointment Ids corresponding to a list of Realm objects.
AppointmentList	getAppointmentsByRealm(Id realmId) Gets the list of Appointments associated with a Realm.
AppointmentList	getAppointmentsByRealms(IdList realmIds) Gets the list of Appointments corresponding to a list of Realms.
IdList	getRealmIdsByAppointment(Id appointmentId) Gets the list of Realm Ids mapped to an Appointment.
RealmList	getRealmsByAppointment(Id appointmentId) Gets the list of Realm objects mapped to an Appointment.
void	useComparativeRealmView() 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	usePlenaryRealmView() A complete view of the Appointment and Realm 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

canLookupAppointmentRealmMappings

boolean canLookupAppointmentRealmMappings()

Tests if this user can perform lookups of appointment/realm 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 intendedas 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.

useComparativeRealmView

void useComparativeRealmView()

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.

usePlenaryRealmView

void usePlenaryRealmView()

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

getAppointmentIdsByRealm

IdList getAppointmentIdsByRealm(Id realmId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of Appointment Ids associated with a Realm.

Parameters:

realmId - Id of a Realms.

Returns:

list of related appointment Ids

Throws:

NotFoundException - realmId is not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAppointmentsByRealm

AppointmentList getAppointmentsByRealm(Id realmId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the list of Appointments associated with a Realm.

Parameters:

realmId - Id of a Realm

Returns:

list of related appointments

Throws:

NotFoundException - realmId is not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAppointmentIdsByRealms

IdList getAppointmentIdsByRealms(IdList realmIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Gets the list of Appointment Ids corresponding to a list of Realm objects.

Parameters:

realmIds - list of realm Ids

Returns:

list of appointment Ids

Throws:

NullArgumentException - realmIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAppointmentsByRealms

AppointmentList getAppointmentsByRealms(IdList realmIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets the list of Appointments corresponding to a list of Realms.

Parameters:

realmIds - list of realm Ids

Returns:

list of appointments

Throws:

NullArgumentException - realmIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRealmIdsByAppointment

IdList getRealmIdsByAppointment(Id appointmentId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of Realm Ids mapped to an Appointment.

Parameters:

appointmentId - Id of an Appointment

Returns:

list of realm Ids

Throws:

NotFoundException - appointmentId is not found

NullArgumentException - appointmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRealmsByAppointment

RealmList getRealmsByAppointment(Id appointmentId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Gets the list of Realm objects mapped to an Appointment.

Parameters:

appointmentId - Id of an Appointment

Returns:

list of realms

Throws:

NotFoundException - appointmentId is not found

NullArgumentException - appointmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.