public interface JournalingProfile extends OsidProfile
The journaling profile describes the interoperability among journaling services.
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.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalEntryLookup()
true
if journal entry lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalEntryQuery()
true
if journal entry query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalEntrySearch()
true
if journal entry search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalEntryAdmin()
true
if journal entry search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalEntryNotification()
true
if journal entry notification is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsBranchLookup()
true
if branch lookup is supported ,
false
otherwisemandatory
- This method must be implemented. boolean supportsBranchQuery()
true
if branch query is supported ,
false
otherwisemandatory
- This method must be implemented. boolean supportsBranchSearch()
true
if branch search is supported ,
false
otherwisemandatory
- This method must be implemented. boolean supportsBranchAdmin()
true
if branch administration is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsBranchNotification()
true
if branch notification is supported
,
false
otherwisemandatory
- This method must be implemented. boolean supportsBranchSmartJournal()
true
if branch smart journals are supported
,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalLookup()
true
if journal lookup is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalQuery()
true
if journal query is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalSearch()
true
if journal search is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalAdmin()
true
if journal administration is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsJournalNotification()
true
if journal notification is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsJournalHierarchy()
true
if journal hierarchy traversal is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsJournalHierarchyDesign()
true
if journal hierarchy design is available,
false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsJournalngBatch()
true
if journaling batch service is available,
false
otherwisemandatory
- This method must be implemented in all
providers. TypeList getJournalEntryRecordTypes()
JournalEntry
record types.mandatory
- This method must be implemented. boolean supportsJournalEntryRecordType(Type journalEntryRecordType)
JournalEntry
record type is
supported.journalEntryRecordType
- a Type
indicating a
JournalEntry
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- journalEntryRecordType
is null
mandatory
- This method must be implemented. TypeList getJournalEntrySearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsJournalEntrySearchRecordType(Type journalEntrySearchRecordType)
journalEntrySearchRecordType
- a Type
indicating
a journal entry record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
journalEntrySearchRecordType
is null
mandatory
- This method must be implemented. TypeList getBranchRecordTypes()
mandatory
- This method must be implemented. boolean supportsBranchRecordType(Type branchRecordType)
branchRecordType
- the branch type true
if the branch record type is supported
,
false
otherwiseNullArgumentException
- branchRecordType
is null
mandatory
- This method must be implemented. TypeList getBranchSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsBranchSearchRecordType(Type branchSearchRecordType)
branchSearchRecordType
- the branch search type true
if the branch search record type is
supported ,
false
otherwiseNullArgumentException
- branchSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getJournalRecordTypes()
Journal
record types.mandatory
- This method must be implemented. boolean supportsJournalRecordType(Type journalRecordType)
Journal
record type is supported.journalRecordType
- a Type
indicating a
Journal
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- journalRecordType
is null
mandatory
- This method must be implemented. TypeList getJournalSearchRecordTypes()
mandatory
- This method must be implemented. boolean supportsJournalSearchRecordType(Type journalSearchRecordType)
journalSearchRecordType
- a Type
indicating a
journal record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
-
journalEntrySearchRecordType
is null
mandatory
- This method must be implemented.