OSB_LIB::ProductItemTypes Class Reference

Collaboration diagram for OSB_LIB::ProductItemTypes:

[legend]List of all members.

---

Detailed Description

Provide information about product item type.

Remarks:

Default and copy constructor, assignment and destructor by compiler.

Definition at line 616 of file productitem.h.

Public Types

• typedef std::vector< Info > List

  STL containter used to store the type information.
  

• typedef List::iterator Iterator

  STL iterator.
  

• typedef List::const_iterator ConstIterator

  STL const_iterator.
  

• typedef List::size_type SizeType

  STL container size_type.
  

Public Member Functions

• const List & list () const

  Read access to the whole list.
  

• long read (const OSB_DB::Session &session)

  Read list from database.
  

• const Info * find (TypeId< ProductItemBase > type) const

  Find Info by type.
  

• const Info & get (TypeId< ProductItemBase > type) const

  Type ProductItemType by type id.
  

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_.

• Iterator begin ()

  Iterator to the beginning of the list.
  

• Iterator end ()

  Iterator to the end of the list.
  

• ConstIterator begin () const

  Const iterator to the beginning of the list.
  

• ConstIterator end () const

  Const iterator to the end of the list.
  

• SizeType size () const

  The size of the list.
  

• void swap (List &other)

  Swap the list.
  

Private Attributes

• List list_

  List product item type information.
  

Classes

• struct Info

  Store information about a product item type. More...
  

---

Member Typedef Documentation

typedef List::const_iterator OSB_LIB::ProductItemTypes::ConstIterator

STL const_iterator.

Definition at line 640 of file productitem.h.

typedef List::iterator OSB_LIB::ProductItemTypes::Iterator

STL iterator.

Definition at line 638 of file productitem.h.

typedef std::vector<Info> OSB_LIB::ProductItemTypes::List

STL containter used to store the type information.

Definition at line 636 of file productitem.h.

typedef List::size_type OSB_LIB::ProductItemTypes::SizeType

STL container size_type.

Definition at line 642 of file productitem.h.

---

Member Function Documentation

ConstIterator OSB_LIB::ProductItemTypes::begin

(

)

const

Const iterator to the beginning of the list.

Iterator OSB_LIB::ProductItemTypes::begin

(

)

Iterator to the beginning of the list.

ConstIterator OSB_LIB::ProductItemTypes::end

(

)

const

Const iterator to the end of the list.

Iterator OSB_LIB::ProductItemTypes::end

(

)

Iterator to the end of the list.

const Info* OSB_LIB::ProductItemTypes::find

(

TypeId< ProductItemBase >

type

)

const

Find Info by type.

Parameters:

type

Identifies the type of product item.

Returns:

Pointer to the information structure about the type. The value is 0 in case of an unsupported or unknown type.

const Info& OSB_LIB::ProductItemTypes::get

(

TypeId< ProductItemBase >

type

)

const

Type ProductItemType by type id.

Parameters:

type

Identifies the type of product item.

Exceptions:

OsbException

in case of an unsupported type.

Returns:

Structure with information about the type.

const List& OSB_LIB::ProductItemTypes::list

(

)

const

Read access to the whole list.

long OSB_LIB::ProductItemTypes::read

(

const OSB_DB::Session &

session

)

Read list from database.

The function calls OSB_DB::ProductGw::fetch to populate its type list with the entries in the database.

Parameters:

session

Database session to use.

Exceptions:

OsbException

as defined in the gateway class.

Returns:

The number of entries in the list.

SizeType OSB_LIB::ProductItemTypes::size

(

)

const

The size of the list.

void OSB_LIB::ProductItemTypes::swap

(

List &

other

)

Swap the list.

---

Member Data Documentation

List OSB_LIB::ProductItemTypes::list_ [private]

List product item type information.

Definition at line 702 of file productitem.h.

---

The documentation for this class was generated from the following file:

• productitem.h

---