Package com.comsol.api.database.result

Interface BranchResult

All Superinterfaces:

DatabaseApiValue

All Known Subinterfaces:

GetBranchResult, QueryBranchResult

public interface BranchResult
extends DatabaseApiValue

Base interface for results returned when reading and querying data values for branches.

Method Summary

Modifier and Type	Method	Description
BranchKey	branchKey()	Returns the identifying key of the branch.
DatabaseKey	databaseKey()	Returns the identifying key of the database that the branch belongs to.
boolean	isDefault()	Returns true if the branch is set as the default branch in the repository, otherwise false.
boolean	isDeleted()	Returns true if the branch is marked as deleted, otherwise false.
ItemSearchIndexingMode	itemSearchIndexingMode()	Returns the mode used when indexing search data for the latest item versions in the branch.
java.lang.String	name()	Returns the name of the branch.
RepositoryKey	repositoryKey()	Returns the identifying key of the repository that the branch belongs to.

Method Detail

databaseKey

DatabaseKey databaseKey()

Returns the identifying key of the database that the branch belongs to.

Returns:

The identifying key of the database that the branch belongs to.

repositoryKey

RepositoryKey repositoryKey()

Returns the identifying key of the repository that the branch belongs to.

Returns:

The identifying key of the repository that the branch belongs to.

branchKey

BranchKey branchKey()

Returns the identifying key of the branch.

Returns:

The identifying key of the branch.

name

java.lang.String name()

Returns the name of the branch. Note that this name need not be unique in the database.

Returns:

The name of the branch.

isDefault

boolean isDefault()

Returns true if the branch is set as the default branch in the repository, otherwise false.

Returns:

True if the branch is set as the default branch in the repository, otherwise false.

itemSearchIndexingMode

ItemSearchIndexingMode itemSearchIndexingMode()

Returns the mode used when indexing search data for the latest item versions in the branch.

Returns:

The mode used when indexing search data for the latest item versions in the branch.

isDeleted

boolean isDeleted()

Returns true if the branch is marked as deleted, otherwise false.

Returns:

True if the branch is marked as deleted, otherwise false.