public interface AppointmentRealmAssignmentSession extends OsidSession
This session provides methods to re-assign Appointments
to Bilings.
An Appointment
may map to
multiple Realms
and removing the last reference to an
Appointment
is the equivalent of deleting it. Each
Realm
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of an Appointment
to another
Realm
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAppointmentToRealm(Id appointmentId,
Id realmId)
Adds an existing
Appointment to a Realm. |
boolean |
canAssignAppointments()
Tests if this user can alter appointment/realm mappings.
|
boolean |
canAssignAppointmentsToRealm(Id realmId)
Tests if this user can alter appointment/realm mappings.
|
IdList |
getAssignableRealmIds(Id realmId)
Gets a list of realms including and under the given realm node in
which any appointment can be assigned.
|
IdList |
getAssignableRealmIdsForAppointment(Id realmId,
Id appointmentId)
Gets a list of realms including and under the given realm node in
which a specific appointment can be assigned.
|
void |
unassignAppointmentFromRealm(Id appointmentId,
Id realmId)
Removes an
Appointment from a Realm. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAppointments()
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. boolean canAssignAppointmentsToRealm(Id realmId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.realmId
- the Id
of the Realm
false
if mapping is not authorized, true
otherwiseNullArgumentException
- realmId
is
null
mandatory
- This method must be implemented. IdList getAssignableRealmIds(Id realmId) throws OperationFailedException
realmId
- the Id
of the Realm
Ids
NullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableRealmIdsForAppointment(Id realmId, Id appointmentId) throws OperationFailedException
realmId
- the Id
of the Realm
appointmentId
- the Id
of the Appointment
Ids
NullArgumentException
- realmId
or
appointmentId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAppointmentToRealm(Id appointmentId, Id realmId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Appointment
to a Realm.
appointmentId
- the Id
of the Appointment
realmId
- the Id
of the Realm
AlreadyExistsException
- appointmentId
already assigned to realmId
NotFoundException
- appointmentId
or
realmId
not foundNullArgumentException
- appointmentId
or
realmId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAppointmentFromRealm(Id appointmentId, Id realmId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Appointment
from a Realm.
appointmentId
- the Id
of the Appointment
realmId
- the Id
of the Realm
NotFoundException
- appointmentId
or
realmId
not found or appointmentId
not mapped to realmId
NullArgumentException
- appointmentId
or
realmId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.