OSB_LIB::StatusReasons Class Reference

Collaboration diagram for OSB_LIB::StatusReasons:

Collaboration graph
[legend]
List of all members.

Detailed Description

List of status reasons.

The class maintains the list of status reasons.

Definition at line 312 of file status.h.

Public Types

STL container type definitions.

Public Member Functions

Pure wrappers to the STL container
Remarks:
Do not add an STL operation to this group if the function does more than just wrapping!
All functions return the STL operation on list_.

Private Attributes


Member Typedef Documentation

typedef Cont::const_iterator OSB_LIB::StatusReasons::ConstIterator

STL const_iterator.

Definition at line 321 of file status.h.

typedef std::list<StatusReason> OSB_LIB::StatusReasons::Cont

STL container to hold a list StatusReason.

Definition at line 317 of file status.h.

typedef Cont::iterator OSB_LIB::StatusReasons::Iterator

STL iterator.

Definition at line 319 of file status.h.

typedef Cont::size_type OSB_LIB::StatusReasons::SizeType

STL container size_type.

Definition at line 323 of file status.h.


Member Function Documentation

void OSB_LIB::StatusReasons::add ( const StatusReason reason  )  [inline]

Add a status reason to the list.

Definition at line 371 of file status.h.

References reasons_.

ConstIterator OSB_LIB::StatusReasons::begin (  )  const [inline]

Const iterator to the beginning of the list.

Definition at line 346 of file status.h.

References reasons_.

Iterator OSB_LIB::StatusReasons::begin (  )  [inline]

Iterator to the beginning of the list.

Definition at line 336 of file status.h.

References reasons_.

ConstIterator OSB_LIB::StatusReasons::end (  )  const [inline]

Const iterator to the end of the list.

Definition at line 351 of file status.h.

References reasons_.

Iterator OSB_LIB::StatusReasons::end (  )  [inline]

Iterator to the end of the list.

Definition at line 341 of file status.h.

References reasons_.

const StatusReason* OSB_LIB::StatusReasons::find ( const StatusReason::Oid oid  ) 

Find a status reason by its id.

Parameters:
oid Id of status reason to find.
Returns:
Pointer to the searched status reason, NULL if not found.

bool OSB_LIB::StatusReasons::get ( StatusReason dest,
const StatusReason::Oid oid 
)

Find a status reason by id and copy.

Parameters:
dest StatusReason to populate. The the status reason is not found in the list, the buffer is not modified.
oid Id of status reason to find.
Returns:
true if the reason was found false if the reason was not found.

const StatusReason& OSB_LIB::StatusReasons::get ( const StatusReason::Oid oid  ) 

Get a status reason by its id.

Parameters:
oid Id of status reason to get.
Returns:
Reference to the searched status reason.
Exceptions:
OsbException 450 if not found.

long OSB_LIB::StatusReasons::read ( const OSB_DB::Session session  ) 

Read all status reasons from the database.

Parameters:
session Database session to use.
Returns:
Number of status reasons read.

const Cont& OSB_LIB::StatusReasons::reasons (  )  const [inline]

Read access to the whole list of status reasons.

Definition at line 377 of file status.h.

References reasons_.

SizeType OSB_LIB::StatusReasons::size (  )  const [inline]

The size of the list.

Definition at line 356 of file status.h.

References reasons_.


Member Data Documentation

Cont OSB_LIB::StatusReasons::reasons_ [private]

The list of status reasons.

Definition at line 414 of file status.h.

Referenced by add(), begin(), end(), reasons(), and size().


The documentation for this class was generated from the following file:
Generated on Sat Sep 2 14:13:06 2006 for OSB Library by  doxygen 1.4.7