Interface LogAdminSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

LogBatchAdminSession

public interface LogAdminSession
extends OsidSession

This session creates, updates, and deletes Logs . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Log , a LogForm is requested using getLogFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned LogForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the LogForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each LogForm corresponds to an attempted transaction.

For updates, LogForms are requested to the Log Id that is to be updated using getLogFormForUpdate() . Similarly, the LogForm has metadata about the data that can be updated and it can perform validation before submitting the update. The LogForm can only be used once for a successful update and cannot be reused.

The delete operations delete Logs .

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

Method Summary

Modifier and Type	Method	Description
void	aliasLog(Id logId, Id aliasId)	Adds an Id to a Log for the purpose of creating compatibility.
boolean	canCreateLogs()	Tests if this user can create Logs .
boolean	canCreateLogWithRecordTypes(Type[] logRecordTypes)	Tests if this user can create a single Log using the desired record types.
boolean	canDeleteLogs()	Tests if this user can delete Logs .
boolean	canManageLogAliases()	Tests if this user can manage Id aliases for Logs .
boolean	canUpdateLogs()	Tests if this user can update Logs .
Log	createLog(LogForm logForm)	Creates a new Log .
void	deleteLog(Id logId)	Deletes a Log .
LogForm	getLogFormForCreate(Type[] logRecordTypes)	Gets the log form for creating new logs.
LogForm	getLogFormForUpdate(Id logId)	Gets the log form for updating an existing log.
void	updateLog(LogForm logForm)	Updates an existing log.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canCreateLogs

boolean canCreateLogs()

Tests if this user can create Logs . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Log will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.

Returns:

false if Log creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateLogWithRecordTypes

boolean canCreateLogWithRecordTypes(Type[] logRecordTypes)

Tests if this user can create a single Log using the desired record types. While LoggingManager.getLogRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Log . Providing an empty array tests if a Log can be created with no records.

Parameters:

logRecordTypes - array of log record types

Returns:

true if Log creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - logRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getLogFormForCreate

LogForm getLogFormForCreate(Type[] logRecordTypes)
                     throws OperationFailedException,
PermissionDeniedException

Gets the log form for creating new logs. A new form should be requested for each create transaction.

Parameters:

logRecordTypes - array of log record types

Returns:

the log form

Throws:

NullArgumentException - logRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form with requested record types

Compliance:

mandatory - This method must be implemented.

createLog

Log createLog(LogForm logForm)
       throws OperationFailedException,
PermissionDeniedException

Creates a new Log .

Parameters:

logForm - the form for this Log

Returns:

the new Log

Throws:

IllegalStateException - logForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - logForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - logForm did not originate from getLogFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateLogs

boolean canUpdateLogs()

Tests if this user can update Logs . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Log will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.

Returns:

false if Log modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getLogFormForUpdate

LogForm getLogFormForUpdate(Id logId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the log form for updating an existing log. A new log form should be requested for each update transaction.

Parameters:

logId - the Id of the Log

Returns:

the log form

Throws:

NotFoundException - logId is not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateLog

void updateLog(LogForm logForm)
        throws OperationFailedException,
PermissionDeniedException

Updates an existing log.

Parameters:

logForm - the form containing the elements to be updated

Throws:

IllegalStateException - logForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - logId or logForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - logForm did not originate from getLogFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteLogs

boolean canDeleteLogs()

Tests if this user can delete Logs . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Log will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.

Returns:

false if Log deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteLog

void deleteLog(Id logId)
        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Deletes a Log .

Parameters:

logId - the Id of the Log to remove

Throws:

NotFoundException - logId not found

NullArgumentException - logId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageLogAliases

boolean canManageLogAliases()

Tests if this user can manage Id aliases for Logs . A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

false if Log aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasLog

void aliasLog(Id logId,
 Id aliasId)
       throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an Id to a Log for the purpose of creating compatibility. The primary Id of the Log is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another log, it is reassigned to the given log Id .

Parameters:

logId - the Id of a Log

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - logId not found

NullArgumentException - logId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.