oa::Status

Status class in the OA Core public surface.

ClC++ public headers

Public Methods

StatusCode oa::Status::getCode()

StringView oa::Status::getCodeName()

const String & oa::Status::getMessage()

bool oa::Status::isError()

bool oa::Status::isOk()

bool oa::Status::operator bool()

String oa::Status::toString()

Static Public Methods

static Status oa::Status::cancelled(String inMessage = "Operation cancelled")

static Status oa::Status::error(StatusCode inCode, String inMessage = "")

static Status oa::Status::error(String inMessage)

static Status oa::Status::invalidArgument(String inMessage)

static Status oa::Status::notFound(String inMessage)

static Status oa::Status::ok()

static Status oa::Status::unimplemented(String inMessage = "Not implemented")

Constructor & Destructor Documentation

oa::Status::Status()

Constructors.

oa::Status::Status(
	StatusCode inCode,
	String inMessage = ""
)

No public source comment is attached to this declaration.

Parameters

inCode

StatusCode

—

inMessage

String

Default: ""

Public Method Documentation

StatusCode oa::Status::getCode()

No public source comment is attached to this declaration.

Returns

StatusCode

The declared return value.

StringView oa::Status::getCodeName()

No public source comment is attached to this declaration.

Returns

StringView

The declared return value.

const String & oa::Status::getMessage()

No public source comment is attached to this declaration.

Returns

const String &

The declared return value.

bool oa::Status::isError()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::Status::isOk()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::Status::operator bool()

Operators.

Returns

bool

The declared return value.

String oa::Status::toString()

No public source comment is attached to this declaration.

Returns

String

The declared return value.

static Status oa::Status::cancelled(
	String inMessage = "Operation cancelled"
)

No public source comment is attached to this declaration.

Parameters

inMessage

String

Default: "Operation cancelled"

Returns

Status

The declared return value.

static Status oa::Status::error(
	StatusCode inCode,
	String inMessage = ""
)

No public source comment is attached to this declaration.

Parameters

inCode

StatusCode

—

inMessage

String

Default: ""

Returns

Status

The declared return value.

static Status oa::Status::error(
	String inMessage
)

No public source comment is attached to this declaration.

Parameters

inMessage

String

—

Returns

Status

The declared return value.

static Status oa::Status::invalidArgument(
	String inMessage
)

No public source comment is attached to this declaration.

Parameters

inMessage

String

—

Returns

Status

The declared return value.

static Status oa::Status::notFound(
	String inMessage
)

No public source comment is attached to this declaration.

Parameters

inMessage

String

—

Returns

Status

The declared return value.

static Status oa::Status::ok()

Methods.

Returns

Status

The declared return value.

static Status oa::Status::unimplemented(
	String inMessage = "Not implemented"
)

No public source comment is attached to this declaration.

Parameters

inMessage

String

Default: "Not implemented"

Returns

Status

The declared return value.