OSID - osid.journaling.BranchAdminSession Service Interface Definition

Interface	osid.journaling.BranchAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Branches.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Branch,` a `BranchForm` is requested using `getBranchFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `BranchForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `BranchForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `BranchForm` corresponds to an attempted transaction. For updates, `BranchForms` are requested to the `Branch` `Id` that is to be updated using `getBranchFormForUpdate().` Similarly, the `BranchForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `BranchForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Branches.` This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getJournalId
Description	Gets the `Journal` `Id` associated with this session.
Return	`osid.id.Id`		the `Journal Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getJournal
Description	Gets the `Journal` associated with this session.
Return	`osid.journaling.Journal`		the journal
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBranches
Description	Tests if this user can branch a version chain. A return of true does not guarantee successful authorization. A return of false indicates that it is known branching will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if journal branching is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateBranch
Description	Tests if this user can branch a specified `JournalEntry.` A return of true does not guarantee successful authorization. A return of false indicates that it is known branching the `JournalEntry` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Parameters	`osid.id.Id`	`journalEntryId`	the `Id` of the `JournalEntry`
Return	`boolean`		`false` if branching is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`journalEntryId` is `null`
Compliance	`mandatory`		This method must be implemented.
Provider Notes	If the `journalEntryId` is not found, then it is acceptable to return false to indicate the lack of branching available.
Method	canCreateBranchWithRecordTypes
Description	Tests if this user can create a single `Branch` using the desired record types. While `JournalingManager.getBranchRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Branch.` Providing an empty array tests if a `Branch` can be created with no records.
Parameters	`osid.type.Type[]`	`branchRecordTypes`	array of branch record types
Return	`boolean`		`true` if `Branch` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`branchyRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getBranchFormForCreate
Description	Gets the branch form for creating new entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`journalEntryId`	the `Id` of the `JournalEntry`
Parameters	`osid.type.Type[]`	`branchRecordTypes`	array of branch record types
Return	`osid.journaling.BranchForm`		the branch form
Errors	NOT_FOUND		`journalEntryId` is not found
	NULL_ARGUMENT		`journalEntryId` or `branchRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createBranch
Description	Creates a branch.
Parameters	`osid.journaling.BranchForm`	`branchForm`	the branch form
Return	`osid.journaling.Branch`		a the new branch
Errors	ILLEGAL_STATE		`branchForm` already used in a create transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`branchForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`branchForm` did not originate from `getBranchFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateBranches
Description	Tests if this user can update branches. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Branch` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Branch` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBranchFormForUpdate
Description	Gets the branch form for updating an existing branch. A new journal entry form should be requested for each update transaction.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the `Branch`
Return	`osid.journaling.BranchForm`		the branch form
Errors	NOT_FOUND		`branchId` is not found
	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateBranch
Description	Updates an existing branch.
Parameters	`osid.journaling.BranchForm`	`branchForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`branchForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`branchForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`branchForm` did not originate from `getBranchFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canMergeBranches
Description	Tests if this user can merge branches. A return of true does not guarantee successful authorization. A return of false indicates that it is known merging `Branches` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer merging operations to unauthorized users.
Return	`boolean`		`false` if `Branch` merging is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	mergeBranches
Description	Merges the source branch into the destination branch. A new journal entry is created to join the two branches.
Parameters	`osid.id.Id`	`srcBranchId`	the `Id` of the `Branch` to merge from
Parameters	`osid.id.Id`	`dstBranchId`	the `Id` of the `Branch` to merge into
Return	`osid.journaling.JournalEntry`		a the new journal entry
Errors	NOT_FOUND		`branchId` not found
	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSupersedeBranches
Description	Tests if this user can supersede branches. A return of true does not guarantee successful authorization. A return of false indicates that it is known merging `Branches` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer superseding operations to unauthorized users.
Return	`boolean`		`false` if `Branch` superseding is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supersedeBranch
Description	Joins the source branch to the destination branch by creating a new journal entry. The most recent version of the source branch supsrsedes the most recent versiuon of the desitination branch.
Parameters	`osid.id.Id`	`srcBranchId`	the `Id` of the superseding `Branch`
Parameters	`osid.id.Id`	`dstBranchId`	the `Id` of the `Branch` to override
Return	`osid.journaling.JournalEntry`		a the new journal entry
Errors	NOT_FOUND		`branchId` not found
	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteBranches
Description	Tests if this user can delete branches. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Branch` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Branch` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteBranch
Description	Deletes a branch and all associated versions.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the `Branch` to remove
Errors	NOT_FOUND		`branchId` not found
	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageBranchAliases
Description	Tests if this user can manage `Id` aliases for branches. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Branch` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasBranch
Description	Adds an `Id` to a `Branch` for the purpose of creating compatibility. The primary `Id` of the `Branch` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another branch it is reassigned to the given branch `Id.`
Parameters	`osid.id.Id`	`branchId`	the `Id` of a `Branch`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`branchId` not found
	NULL_ARGUMENT		`branchId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.