OSID Logo
OSID Specifications
journaling package
Version 3.0.0
Release Candidate Preview
Interfaceosid.journaling.BranchSearch
Implementsosid.OsidSearch
Description

The search interface for governing branch searches.

MethodsearchAmongBranches
Description

Execute this search among the given list of branches.

Parametersosid.id.IdListbranchIdslist of branch Ids
ErrorsNULL_ARGUMENT branchIds is null
CompliancemandatoryThis method must be implemented.
MethodorderBranchResults
Description

Specify an ordering to the search results.

Parametersosid.journaling.BranchSearchOrderbranchSearchOrderbranch search order
ErrorsNULL_ARGUMENT order is null
UNSUPPORTED order is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetBranchSearchRecord
Description

Gets the branch search record corresponding to the given branch search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypebranchSearchRecordTypea branch search record type
Returnosid.journaling.records.BranchSearchRecordthe branch search record
ErrorsNULL_ARGUMENT branchSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordTypeType(branchSearchRecordType) is false
CompliancemandatoryThis method must be implemented.