org.osid.journaling

Interface JournalingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

JournalingManager, JournalingProxyManager

public interface JournalingProfile
extends OsidProfile

The journaling profile describes the interoperability among journaling services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getBranchRecordTypes() Gets all the branch record types supported.
TypeList	getBranchSearchRecordTypes() Gets all the branch search record types supported.
TypeList	getJournalEntryRecordTypes() Gets the supported JournalEntry record types.
TypeList	getJournalEntrySearchRecordTypes() Gets the supported journal entry search record types.
TypeList	getJournalRecordTypes() Gets the supported Journal record types.
TypeList	getJournalSearchRecordTypes() Gets the supported journal search record types.
boolean	supportsBranchAdmin() Tests if branch administration is supported.
boolean	supportsBranchLookup() Tests if branch lookup is supported.
boolean	supportsBranchNotification() Tests if branch notification is supported.
boolean	supportsBranchQuery() Tests if branch query is supported.
boolean	supportsBranchRecordType(Type branchRecordType) Tests if a given branch record type is supported.
boolean	supportsBranchSearch() Tests if branch search is supported.
boolean	supportsBranchSearchRecordType(Type branchSearchRecordType) Tests if a given branch search type is supported.
boolean	supportsBranchSmartJournal() Tests if branch smart journals are available.
boolean	supportsJournalAdmin() Tests for the availability of a journal administrative service for creating and deleting journals.
boolean	supportsJournalEntryAdmin() Tests if searching for journal entries is available.
boolean	supportsJournalEntryLookup() Tests for the availability of a journal entry lookup service.
boolean	supportsJournalEntryNotification() Tests if journal entry notification is available.
boolean	supportsJournalEntryQuery() Tests if querying journal entries is available.
boolean	supportsJournalEntryRecordType(Type journalEntryRecordType) Tests if the given JournalEntry record type is supported.
boolean	supportsJournalEntrySearch() Tests if searching for journal entries is available.
boolean	supportsJournalEntrySearchRecordType(Type journalEntrySearchRecordType) Tests if the given journal entry search record type is supported.
boolean	supportsJournalHierarchy() Tests for the availability of a journal hierarchy traversal service.
boolean	supportsJournalHierarchyDesign() Tests for the availability of a journal hierarchy design service.
boolean	supportsJournalLookup() Tests for the availability of an journal lookup service.
boolean	supportsJournalngBatch() Tests for the availability of a journaling batch service.
boolean	supportsJournalNotification() Tests for the availability of a journal notification service.
boolean	supportsJournalQuery() Tests if querying journals is available.
boolean	supportsJournalRecordType(Type journalRecordType) Tests if the given Journal record type is supported.
boolean	supportsJournalSearch() Tests if searching for journals is available.
boolean	supportsJournalSearchRecordType(Type journalSearchRecordType) Tests if the given journal search record type is supported.
boolean	supportsVisibleFederation() Tests if any journal federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any journal federation is exposed. Federation is exposed when a specific journal may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of journals appears as a single journal.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalEntryLookup

boolean supportsJournalEntryLookup()

Tests for the availability of a journal entry lookup service.

Returns:

true if journal entry lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalEntryQuery

boolean supportsJournalEntryQuery()

Tests if querying journal entries is available.

Returns:

true if journal entry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalEntrySearch

boolean supportsJournalEntrySearch()

Tests if searching for journal entries is available.

Returns:

true if journal entry search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalEntryAdmin

boolean supportsJournalEntryAdmin()

Tests if searching for journal entries is available.

Returns:

true if journal entry search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalEntryNotification

boolean supportsJournalEntryNotification()

Tests if journal entry notification is available.

Returns:

true if journal entry notification is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBranchLookup

boolean supportsBranchLookup()

Tests if branch lookup is supported.

Returns:

true if branch lookup is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBranchQuery

boolean supportsBranchQuery()

Tests if branch query is supported.

Returns:

true if branch query is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBranchSearch

boolean supportsBranchSearch()

Tests if branch search is supported.

Returns:

true if branch search is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBranchAdmin

boolean supportsBranchAdmin()

Tests if branch administration is supported.

Returns:

true if branch administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBranchNotification

boolean supportsBranchNotification()

Tests if branch notification is supported. Messages may be sent when branches are created, modified, or deleted.

Returns:

true if branch notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBranchSmartJournal

boolean supportsBranchSmartJournal()

Tests if branch smart journals are available.

Returns:

true if branch smart journals are supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalLookup

boolean supportsJournalLookup()

Tests for the availability of an journal lookup service.

Returns:

true if journal lookup is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalQuery

boolean supportsJournalQuery()

Tests if querying journals is available.

Returns:

true if journal query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalSearch

boolean supportsJournalSearch()

Tests if searching for journals is available.

Returns:

true if journal search is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalAdmin

boolean supportsJournalAdmin()

Tests for the availability of a journal administrative service for creating and deleting journals.

Returns:

true if journal administration is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalNotification

boolean supportsJournalNotification()

Tests for the availability of a journal notification service.

Returns:

true if journal notification is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsJournalHierarchy

boolean supportsJournalHierarchy()

Tests for the availability of a journal hierarchy traversal service.

Returns:

true if journal hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsJournalHierarchyDesign

boolean supportsJournalHierarchyDesign()

Tests for the availability of a journal hierarchy design service.

Returns:

true if journal hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsJournalngBatch

boolean supportsJournalngBatch()

Tests for the availability of a journaling batch service.

Returns:

true if journaling batch service is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

getJournalEntryRecordTypes

TypeList getJournalEntryRecordTypes()

Gets the supported JournalEntry record types.

Returns:

a list containing the supported journal entry record types

Compliance:

mandatory - This method must be implemented.

supportsJournalEntryRecordType

boolean supportsJournalEntryRecordType(Type journalEntryRecordType)

Tests if the given JournalEntry record type is supported.

Parameters:

journalEntryRecordType - a Type indicating a JournalEntry record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - journalEntryRecordType is null

Compliance:

mandatory - This method must be implemented.

getJournalEntrySearchRecordTypes

TypeList getJournalEntrySearchRecordTypes()

Gets the supported journal entry search record types.

Returns:

a list containing the supported journal entry search record types

Compliance:

mandatory - This method must be implemented.

supportsJournalEntrySearchRecordType

boolean supportsJournalEntrySearchRecordType(Type journalEntrySearchRecordType)

Tests if the given journal entry search record type is supported.

Parameters:

journalEntrySearchRecordType - a Type indicating a journal entry record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - journalEntrySearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getBranchRecordTypes

TypeList getBranchRecordTypes()

Gets all the branch record types supported.

Returns:

the list of supported branch record types

Compliance:

mandatory - This method must be implemented.

supportsBranchRecordType

boolean supportsBranchRecordType(Type branchRecordType)

Tests if a given branch record type is supported.

Parameters:

branchRecordType - the branch type

Returns:

true if the branch record type is supported , false otherwise

Throws:

NullArgumentException - branchRecordType is null

Compliance:

mandatory - This method must be implemented.

getBranchSearchRecordTypes

TypeList getBranchSearchRecordTypes()

Gets all the branch search record types supported.

Returns:

the list of supported branch search record types

Compliance:

mandatory - This method must be implemented.

supportsBranchSearchRecordType

boolean supportsBranchSearchRecordType(Type branchSearchRecordType)

Tests if a given branch search type is supported.

Parameters:

branchSearchRecordType - the branch search type

Returns:

true if the branch search record type is supported , false otherwise

Throws:

NullArgumentException - branchSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getJournalRecordTypes

TypeList getJournalRecordTypes()

Gets the supported Journal record types.

Returns:

a list containing the supported journal record types

Compliance:

mandatory - This method must be implemented.

supportsJournalRecordType

boolean supportsJournalRecordType(Type journalRecordType)

Tests if the given Journal record type is supported.

Parameters:

journalRecordType - a Type indicating a Journal record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - journalRecordType is null

Compliance:

mandatory - This method must be implemented.

getJournalSearchRecordTypes

TypeList getJournalSearchRecordTypes()

Gets the supported journal search record types.

Returns:

a list containing the supported journal search record types

Compliance:

mandatory - This method must be implemented.

supportsJournalSearchRecordType

boolean supportsJournalSearchRecordType(Type journalSearchRecordType)

Tests if the given journal search record type is supported.

Parameters:

journalSearchRecordType - a Type indicating a journal record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - journalEntrySearchRecordType is null

Compliance:

mandatory - This method must be implemented.