public interface LogEntryLogAssignmentSession extends OsidSession
This session provides methods to re-assign log entries to Logs.
A LogEntry
may map to multiple Log
objects and removing the last reference to a LogEntry
is
the equivalent of deleting it. Each Log
may have its own
authorizations governing who is allowed to operate on it.
Moving or adding a reference of a LogEntry
to another
Log
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignLogEntryToLog(Id logEntryId,
Id logId)
Adds an existing
LogEntry to a Log. |
boolean |
canAssignLogEntries()
Tests if this user can alter log entry/log mappings.
|
boolean |
canAssignLogEntriesToLog(Id logId)
Tests if this user can alter log entry/log mappings.
|
IdList |
getAssignableLogIds(Id logId)
Gets a list of log including and under the given log node in which any
log entry can be assigned.
|
IdList |
getAssignableLogIdsForLogEntry(Id logId,
Id logEntryId)
Gets a list of log including and under the given log node in which a
specific log entry can be assigned.
|
void |
reassignLogEntryToLog(Id logEntryId,
Id fromLogId,
Id toLogId)
Moves a
LogEntry from one Log to
another. |
void |
unassignLogEntryFromLog(Id logEntryId,
Id logId)
Removes a
LogEntry from a Log. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignLogEntries()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignLogEntriesToLog(Id logId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.logId
- the Id
of the Log
false
if mapping is not authorized, true
otherwiseNullArgumentException
- logId
is
null
mandatory
- This method must be implemented. IdList getAssignableLogIds(Id logId) throws OperationFailedException
logId
- the Id
of the Log
Ids
NullArgumentException
- logId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableLogIdsForLogEntry(Id logId, Id logEntryId) throws OperationFailedException
logId
- the Id
of the Log
logEntryId
- the Id
of the LogEntry
Ids
NullArgumentException
- logId
or
logEntryId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignLogEntryToLog(Id logEntryId, Id logId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
LogEntry
to a Log.
logEntryId
- the Id
of the LogEntry
logId
- the Id
of the Log
AlreadyExistsException
- logEntryId
is
already assigned to logId
NotFoundException
- logEntryId
or
logId
not foundNullArgumentException
- logEntryId
or
logId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignLogEntryFromLog(Id logEntryId, Id logId) throws NotFoundException, OperationFailedException, PermissionDeniedException
LogEntry
from a Log.
logEntryId
- the Id
of the LogEntry
logId
- the Id
of the Log
NotFoundException
- logEntryId
or
logId
not found or logEntryId
not
assigned to logId
NullArgumentException
- logEntryId
or
logId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignLogEntryToLog(Id logEntryId, Id fromLogId, Id toLogId) throws NotFoundException, OperationFailedException, PermissionDeniedException
LogEntry
from one Log
to
another. Mappings to other Logs
are unaffected.logEntryId
- the Id
of the LogEntry
fromLogId
- the Id
of the current Log
toLogId
- the Id
of the destination Log
NotFoundException
- logEntryId, fromLogId,
or toLogId
not found or
logEntryId
not mapped to fromLogId
NullArgumentException
- logEntryId, fromLogId,
or toLogId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.