org.osid.transaction.batch

Interface AliasResponse

All Superinterfaces:

OsidCapsule

public interface AliasResponse
extends OsidCapsule

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.

Method Summary

Methods

Modifier and Type	Method and Description
Id	getAliasId() Gets the alias Id.
DisplayText	getErrorMessage() Gets the error message for an unsuccessful item within the create operation.
Id	getReferenceId() Gets the reference Id.
boolean	isSuccessful() Tests if this item within the create operation was successful.

Method Detail

getReferenceId

Id getReferenceId()

Gets the reference Id.

Returns:

the reference Id

Compliance:

mandatory - This method must be implemented.

getAliasId

Id getAliasId()

Gets the alias Id.

Returns:

the alias Id

Compliance:

mandatory - This method must be implemented.

isSuccessful

boolean isSuccessful()

Tests if this item within the create operation was successful.

Returns:

true if the alias operation was successful, false if it was not successful

Compliance:

mandatory - This method must be implemented.

getErrorMessage

DisplayText getErrorMessage()

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

Returns:

the message

Throws:

IllegalStateException - isSuccessful() is true

Compliance:

mandatory - This method must be implemented.