oracle.adf.share.sandbox.logging

Class SandboxLoggingSupport

java.lang.Object

oracle.adf.share.sandbox.logging.SandboxLoggingSupport

Direct Known Subclasses:

DefaultSandboxLoggingSupport

public abstract class SandboxLoggingSupport
extends java.lang.Object

Service provider interface for supporting sandbox logging.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SandboxLoggingSupport.PersistableLogType The type of a persistable log.
static class	SandboxLoggingSupport.PersistableRecordType The type of SandboxLogRecord that can be persisted.

Constructor Summary

Constructors

Constructor and Description
SandboxLoggingSupport()

Method Summary

Modifier and Type	Method and Description
abstract void	addSandboxLogRecord(java.lang.Long sandboxLogId, SandboxLogRecord record) Adds a record to a sandbox log.
abstract void	addSandboxLogRecords(java.lang.Long sandboxLogId, java.util.List<? extends SandboxLogRecord> records) Adds a list of records to a sandbox log as one atomic transaction.
abstract java.lang.Long	createSandboxLog(SandboxLog<? extends SandboxLogRecord> log) Creates a sandbox log.
abstract java.lang.Long	createSandboxLog(java.lang.String summary) Creates a sandbox log with no records.
abstract boolean	deleteSandboxLog(java.lang.Long sandboxLogId) Deletes a sandbox log.
static SandboxLoggingSupport	getInstance() Returns an instance of this class.
protected SandboxLoggingSupport.PersistableRecordType	getPersistableRecordType(SandboxLogRecord record) Determines the persistable type of a record.
protected java.util.Map<java.lang.String,java.lang.Object>	getPersistableValues(SandboxLogRecord record) Returns the persistable field values in a log record as a map.
abstract SandboxLog<? extends SandboxLogRecord>	getSandboxLog(java.lang.Long sandboxLogId) Returns the sandbox log specified by its persistence ID.
protected SandboxLogRecord	newSandboxLogRecord(SandboxLoggingSupport.PersistableRecordType type, java.util.Map<java.lang.String,java.lang.Object> values) Returns a new instance of a SandboxLogRecord based on a persistable type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SandboxLoggingSupport

public SandboxLoggingSupport()

Method Detail

getInstance

public static SandboxLoggingSupport getInstance()

Returns an instance of this class.

Returns:

an instance of this class

createSandboxLog

public abstract java.lang.Long createSandboxLog(java.lang.String summary)

Creates a sandbox log with no records.

Parameters:

summary - the summary of the log

Returns:

the persistence ID of the log

getPersistableRecordType

protected SandboxLoggingSupport.PersistableRecordType getPersistableRecordType(SandboxLogRecord record)

Determines the persistable type of a record.

Parameters:

record - the record to be checked

Returns:

the persistable type of the record

getPersistableValues

protected java.util.Map<java.lang.String,java.lang.Object> getPersistableValues(SandboxLogRecord record)

Returns the persistable field values in a log record as a map.

Parameters:

record - the log record

Returns:

the field values in a map where the keys are the field names

Throws:

java.lang.NullPointerException - if the given record is null

newSandboxLogRecord

protected SandboxLogRecord newSandboxLogRecord(SandboxLoggingSupport.PersistableRecordType type,
                                               java.util.Map<java.lang.String,java.lang.Object> values)

Returns a new instance of a SandboxLogRecord based on a persistable type.

Parameters:

type - the persistable type; null if the type cannot be determined. In case of null, an instance of the most generic type is returned.

values - the values to be loaded into the new instance

Returns:

the new instance of the given type with the given values

createSandboxLog

public abstract java.lang.Long createSandboxLog(SandboxLog<? extends SandboxLogRecord> log)

Creates a sandbox log.

Parameters:

log - the log to be created

Returns:

the persistence ID of the sandbox log

getSandboxLog

public abstract SandboxLog<? extends SandboxLogRecord> getSandboxLog(java.lang.Long sandboxLogId)

Returns the sandbox log specified by its persistence ID.

Parameters:

sandboxLogId - the persistence ID of the sandbox log

Returns:

the sandbox log with the persistence ID; null if no sandbox with the ID exists

addSandboxLogRecord

public abstract void addSandboxLogRecord(java.lang.Long sandboxLogId,
                                         SandboxLogRecord record)

Adds a record to a sandbox log.

Parameters:

sandboxLogId - the persistence ID of the sandbox log

record - the record to be added

Throws:

java.lang.IllegalStateException - if the sandbox log with the specified ID does not exist

java.lang.IllegalArgumentException - if the log ID or record is null

addSandboxLogRecords

public abstract void addSandboxLogRecords(java.lang.Long sandboxLogId,
                                          java.util.List<? extends SandboxLogRecord> records)

Adds a list of records to a sandbox log as one atomic transaction.

Parameters:

sandboxLogId - the ID of the sandbox log

records - the list of record to be added

Throws:

java.lang.IllegalStateException - if the sandbox log with the specified ID does not exist

java.lang.IllegalArgumentException - if the log ID or list is null

deleteSandboxLog

public abstract boolean deleteSandboxLog(java.lang.Long sandboxLogId)

Deletes a sandbox log.

Parameters:

sandboxLogId - the persistence ID of the sandbox log

Returns:

true if the sandbox log with the ID exists and is deleted successfully; false otherwise