public interface AgendaEngineAssignmentSession extends OsidSession
This session provides methods to re-assign Agendas
to
Engine
mappings. An Agenda
may appear in
multiple Engine
objects and removing the last reference to
an Agenda
is the equivalent of deleting it. Each
Engine
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of an Agenda
to another
Engine
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignAgendaToEngine(Id agendaId,
Id engineId)
Adds an existing
Agenda to a Engine. |
boolean |
canAssignAgendas()
Tests if this user can alter agenda/engine mappings.
|
boolean |
canAssignAgendasToEngine(Id engineId)
Tests if this user can alter agenda/engine mappings.
|
IdList |
getAssignableEngineIds(Id engineId)
Gets a list of engines including and under the given engine node in
which any agenda can be assigned.
|
IdList |
getAssignableEngineIdsForAgenda(Id engineId,
Id agendaId)
Gets a list of engines including and under the given engine node in
which a specific agenda can be assigned.
|
void |
unassignAgendaFromEngine(Id agendaId,
Id engineId)
Removes an
Agenda from a Engine. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignAgendas()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if check is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignAgendasToEngine(Id engineId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users.engineId
- the Id
of the Engine
false
if mapping is not authorized, true
otherwiseNullArgumentException
- engineId
is
null
mandatory
- This method must be implemented. IdList getAssignableEngineIds(Id engineId) throws OperationFailedException
engineId
- the Id
of the Engine
Ids
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableEngineIdsForAgenda(Id engineId, Id agendaId) throws OperationFailedException
engineId
- the Id
of the Engine
agendaId
- the Id
of the Agenda
Ids
NullArgumentException
- engineId
or
agendaId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignAgendaToEngine(Id agendaId, Id engineId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Agenda
to a Engine.
agendaId
- the Id
of the Agenda
engineId
- the Id
of the Engine
AlreadyExistsException
- agendaId
is
already assigned to engineId
NotFoundException
- agendaId
or
engineId
not foundNullArgumentException
- agendaId
or
engineId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignAgendaFromEngine(Id agendaId, Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Agenda
from a Engine.
agendaId
- the Id
of the Agenda
engineId
- the Id
of the Engine
NotFoundException
- agendaId
or
engineId
not found or agendaId
not
assigned to engineId
NullArgumentException
- agendaId
or
engineId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.