OSID - osid.journaling.JournalingProfile Service Interface Definition

Interface	osid.journaling.JournalingProfile
Implements	`osid.OsidProfile`
Description	The journaling profile describes the interoperability among journaling services.
Method	supportsVisibleFederation
Description	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.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalEntryLookup
Description	Tests for the availability of a journal entry lookup service.
Return	`boolean`		`true` if journal entry lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalEntryQuery
Description	Tests if querying journal entries is available.
Return	`boolean`		`true` if journal entry query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalEntrySearch
Description	Tests if searching for journal entries is available.
Return	`boolean`		`true` if journal entry search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalEntryAdmin
Description	Tests if searching for journal entries is available.
Return	`boolean`		`true` if journal entry search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalEntryNotification
Description	Tests if journal entry notification is available.
Return	`boolean`		`true` if journal entry notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchLookup
Description	Tests if branch lookup is supported.
Return	`boolean`		`true` if branch lookup is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchQuery
Description	Tests if branch query is supported.
Return	`boolean`		`true` if branch query is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchSearch
Description	Tests if branch search is supported.
Return	`boolean`		`true` if branch search is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchAdmin
Description	Tests if branch administration is supported.
Return	`boolean`		`true` if branch administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchNotification
Description	Tests if branch notification is supported. Messages may be sent when branches are created, modified, or deleted.
Return	`boolean`		`true` if branch notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchSmartJournal
Description	Tests if branch smart journals are available.
Return	`boolean`		`true` if branch smart journals are supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalLookup
Description	Tests for the availability of an journal lookup service.
Return	`boolean`		`true` if journal lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalQuery
Description	Tests if querying journals is available.
Return	`boolean`		`true` if journal query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalSearch
Description	Tests if searching for journals is available.
Return	`boolean`		`true` if journal search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalAdmin
Description	Tests for the availability of a journal administrative service for creating and deleting journals.
Return	`boolean`		`true` if journal administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalNotification
Description	Tests for the availability of a journal notification service.
Return	`boolean`		`true` if journal notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsJournalHierarchy
Description	Tests for the availability of a journal hierarchy traversal service.
Return	`boolean`		`true` if journal hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalHierarchyDesign
Description	Tests for the availability of a journal hierarchy design service.
Return	`boolean`		`true` if journal hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsJournalngBatch
Description	Tests for the availability of a journaling batch service.
Return	`boolean`		`true` if journaling batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	getJournalEntryRecordTypes
Description	Gets the supported `JournalEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported journal entry record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalEntryRecordType
Description	Tests if the given `JournalEntry` record type is supported.
Parameters	`osid.type.Type`	`journalEntryRecordType`	a `Type` indicating a `JournalEntry` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`journalEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getJournalEntrySearchRecordTypes
Description	Gets the supported journal entry search record types.
Return	`osid.type.TypeList`		a list containing the supported journal entry search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalEntrySearchRecordType
Description	Tests if the given journal entry search record type is supported.
Parameters	`osid.type.Type`	`journalEntrySearchRecordType`	a `Type` indicating a journal entry record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`journalEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBranchRecordTypes
Description	Gets all the branch record types supported.
Return	`osid.type.TypeList`		the list of supported branch record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchRecordType
Description	Tests if a given branch record type is supported.
Parameters	`osid.type.Type`	`branchRecordType`	the branch type
Return	`boolean`		`true` if the branch record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`branchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBranchSearchRecordTypes
Description	Gets all the branch search record types supported.
Return	`osid.type.TypeList`		the list of supported branch search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchSearchRecordType
Description	Tests if a given branch search type is supported.
Parameters	`osid.type.Type`	`branchSearchRecordType`	the branch search type
Return	`boolean`		`true` if the branch search record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`branchSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getJournalRecordTypes
Description	Gets the supported `Journal` record types.
Return	`osid.type.TypeList`		a list containing the supported journal record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalRecordType
Description	Tests if the given `Journal` record type is supported.
Parameters	`osid.type.Type`	`journalRecordType`	a `Type` indicating a `Journal` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`journalRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getJournalSearchRecordTypes
Description	Gets the supported journal search record types.
Return	`osid.type.TypeList`		a list containing the supported journal search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsJournalSearchRecordType
Description	Tests if the given journal search record type is supported.
Parameters	`osid.type.Type`	`journalSearchRecordType`	a `Type` indicating a journal record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`journalEntrySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.