OSID Logo
OSID Specifications
transaction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.transaction.batch.AliasResponse
Implementsosid.OsidCapsule
Description

AliasResponses are returned from bulk alias operations. Batch-oriented methods are executed on a best effort basis unless wrapped in Transaction that supports an atomic commit(). Batch methods may be invoked outside of a Transaction where some of the items supplied may fail.

Bulk alias operations accept a list of AliasRequests. There is one AliasResponse returned for every AliasRequest but not necessarily in the same order. The created Id in the response is the newly created Id is the create item was successful.

MethodgetReferenceId
Description

Gets the reference Id.

Returnosid.id.Idthe reference Id
CompliancemandatoryThis method must be implemented.
MethodgetAliasId
Description

Gets the alias Id.

Returnosid.id.Idthe alias Id
CompliancemandatoryThis method must be implemented.
MethodisSuccessful
Description

Tests if this item within the create operation was successful.

Returnboolean true if the alias operation was successful, false if it was not successful
CompliancemandatoryThis method must be implemented.
MethodgetErrorMessage
Description

Gets the error message for an unsuccessful item within the create operation.

Returnosid.locale.DisplayTextthe message
ErrorsILLEGAL_STATE isSuccessful() is true
CompliancemandatoryThis method must be implemented.