OSB_CORBA::PersProdNodeWriter_i Class Reference

Inheritance diagram for OSB_CORBA::PersProdNodeWriter_i:

[legend]Collaboration diagram for OSB_CORBA::PersProdNodeWriter_i:

[legend]List of all members.

---

Detailed Description

Servant for CORBA interface PersProdNodeWriter.

Definition at line 79 of file persprodnode_i.h.

Public Member Functions

• PersProdNodeWriter_i (ContractAdmin_i &cadmin, PersProductWriter_i &ppServant, const OSB_LIB::ProductNode *pn, OSB_LIB::PersProductNode *ppn)

  Constructor.
  

• virtual ~PersProdNodeWriter_i ()
• const Locators::Key & key () const

  Get the servant key.
  

• virtual PersNodeId id () throw (CORBA::SystemException)

  Return unique personalised product node id.
  

• virtual ProductPartId prodPartId () throw (CORBA::SystemException)

  Return product part id of personalised product node.
  

• virtual Utf8String * name () throw (CORBA::SystemException, OsbCorbaException)

  Return name of product node used to create persprodnode.
  

• virtual Utf8String * desc () throw (CORBA::SystemException, OsbCorbaException)
• virtual PpTypeId type () throw (CORBA::SystemException, OsbCorbaException)

  Return type of underlying product item.
  

• virtual DateTime * createdDate () throw (CORBA::SystemException)

  Date at which personalised product is created.
  

• virtual Status effStatus () throw (CORBA::SystemException)

  Return effective status of personalised product.
  

• virtual Status prefStatus () throw (CORBA::SystemException)

  Return preferred status of associate.
  

• virtual DateTime * effStatusDate () throw (CORBA::SystemException)

  Date at which effective status is in effect.
  

• virtual DateTime * prefStatusDate () throw (CORBA::SystemException)

  Date at which preferred status will take effect.
  

• virtual StatusValue requestedStatus (const DateTime &ts) throw (CORBA::SystemException, OsbCorbaException)

  Get the requested status for a given time.
  

• StatusHistory * statusHistory (const DateTime &from, const DateTime &to, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Get status history for a period of time.
  

• virtual PersProdItemSeq * getConfigs () throw (CORBA::SystemException, OsbCorbaException)

  Return list of configurations.
  

• virtual PersProdItemWriter * getConfig (const PersItemId &id) throw (CORBA::SystemException, OsbCorbaException)

  Return a coniguration.
  

• virtual PersProdItemWriter * currentConfig () throw (CORBA::SystemException, OsbCorbaException)

  Brief Return a current coniguration.
  

• virtual PersProdItemWriter_ptr creNewConfig () throw (CORBA::SystemException, OsbCorbaException)

  Create a new temporary personalised item writer.
  

• virtual CORBA::Boolean removeConfig (const PersItemId &id, CORBA::Boolean noWait) throw (CORBA::SystemException, OsbCorbaException)

  Remove a personalised item.
  

Static Public Attributes

• static const std::string IFC

Private Types

• typedef std::list< Locators::Key > Servants

  Container to store the generated pers. item servants.
  

Private Member Functions

• OSB_LIB::PersProduct * persProduct ()

  Get the pers. product from ppServant_.
  

Private Attributes

• ContractAdmin_i & cadmin_

  Reference to AnCList object reference.
  

• PersProductWriter_i & ppServant_

  Reference to the servant owner.
  

• const OSB_LIB::ProductNode * pn_

  Product node is needed when creating personalised item.
  

• OSB_LIB::PersProductNode * ppn_

  Pointer to personalised product node.
  

• Servants ppiServants_

  PersProdItem servant id list.
  

• Locators::Key key_

  Servant key of object.
  

---

Member Typedef Documentation

typedef std::list<Locators::Key> OSB_CORBA::PersProdNodeWriter_i::Servants [private]

Container to store the generated pers. item servants.

Definition at line 241 of file persprodnode_i.h.

---

Constructor & Destructor Documentation

OSB_CORBA::PersProdNodeWriter_i::PersProdNodeWriter_i	(	ContractAdmin_i &	cadmin,
		PersProductWriter_i &	ppServant,
		const OSB_LIB::ProductNode *	pn,
		OSB_LIB::PersProductNode *	ppn
	)

Constructor.

virtual OSB_CORBA::PersProdNodeWriter_i::~PersProdNodeWriter_i

(

)

[virtual]

---

Member Function Documentation

virtual DateTime* OSB_CORBA::PersProdNodeWriter_i::createdDate

(

)

throw (CORBA::SystemException) [virtual]

Date at which personalised product is created.

virtual PersProdItemWriter_ptr OSB_CORBA::PersProdNodeWriter_i::creNewConfig

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Create a new temporary personalised item writer.

Operations with the exception of create(), that involves database manipulation are not allowed to be invoked by this corba reference as the underlying library object is temporary without any record in the database, ie. the Oid of this library object is ID_NOT_SET.

Exceptions:

OsbCorbaException

if product part is not one of the children of current product node.

Returns:

Newly created persproduct item corba reference.

virtual PersProdItemWriter* OSB_CORBA::PersProdNodeWriter_i::currentConfig

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Brief Return a current coniguration.

virtual Utf8String* OSB_CORBA::PersProdNodeWriter_i::desc

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Return description of product node used to create persprodnode.

virtual Status OSB_CORBA::PersProdNodeWriter_i::effStatus

(

)

throw (CORBA::SystemException) [virtual]

Return effective status of personalised product.

virtual DateTime* OSB_CORBA::PersProdNodeWriter_i::effStatusDate

(

)

throw (CORBA::SystemException) [virtual]

Date at which effective status is in effect.

virtual PersProdItemWriter* OSB_CORBA::PersProdNodeWriter_i::getConfig

(

const PersItemId &

id

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Return a coniguration.

Parameters:

id

Product part id.

Exceptions:

OsbCorbaException

if personalised product type is undefined.

virtual PersProdItemSeq* OSB_CORBA::PersProdNodeWriter_i::getConfigs

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Return list of configurations.

virtual PersNodeId OSB_CORBA::PersProdNodeWriter_i::id

(

)

throw (CORBA::SystemException) [virtual]

Return unique personalised product node id.

const Locators::Key& OSB_CORBA::PersProdNodeWriter_i::key

(

)

const [inline]

Get the servant key.

Definition at line 98 of file persprodnode_i.h.

References key_.

virtual Utf8String* OSB_CORBA::PersProdNodeWriter_i::name

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Return name of product node used to create persprodnode.

OSB_LIB::PersProduct* OSB_CORBA::PersProdNodeWriter_i::persProduct

(

)

[private]

Get the pers. product from ppServant_.

Exceptions:

OsbCorbaException

if the pers. product is 0.

virtual Status OSB_CORBA::PersProdNodeWriter_i::prefStatus

(

)

throw (CORBA::SystemException) [virtual]

Return preferred status of associate.

virtual DateTime* OSB_CORBA::PersProdNodeWriter_i::prefStatusDate

(

)

throw (CORBA::SystemException) [virtual]

Date at which preferred status will take effect.

virtual ProductPartId OSB_CORBA::PersProdNodeWriter_i::prodPartId

(

)

throw (CORBA::SystemException) [virtual]

Return product part id of personalised product node.

virtual CORBA::Boolean OSB_CORBA::PersProdNodeWriter_i::removeConfig	(	const PersItemId &	id,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException) [virtual]

Remove a personalised item.

Parameters:

	id	Personalised item unqiue id.
	noWait	Set to false if waiting is desired when lock is already acquired by others. If waiting is not desired, set flag to true.

Returns:

True if operation is successful.

Exceptions:

OsbCorbaException

if operation fails at the gateway.

virtual StatusValue OSB_CORBA::PersProdNodeWriter_i::requestedStatus

(

const DateTime &

ts

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Get the requested status for a given time.

Parameters:

ts

Date and time to query, if not set system time is used.

Returns:

The anticipated preferred status at time ts,
the related status request may or may not have been applied.

Exceptions:

OsbCorbaException

in case of a database error.

StatusHistory* OSB_CORBA::PersProdNodeWriter_i::statusHistory	(	const DateTime &	from,
		const DateTime &	to,
		CORBA::Boolean	noWait
	)			throw (CORBA::SystemException, OsbCorbaException)

Get status history for a period of time.

Parameters:

	from	Start period of list to be retrieved(inclusive).
	to	End period of list to be retrieved(exclusive).
	noWait	Wait for database locks: false if yes.

Returns:

list of status changes.

Exceptions:

OsbCorbaException

if operation to retrieve status changes fails at the database.

virtual PpTypeId OSB_CORBA::PersProdNodeWriter_i::type

(

)

throw (CORBA::SystemException, OsbCorbaException) [virtual]

Return type of underlying product item.

---

Member Data Documentation

ContractAdmin_i& OSB_CORBA::PersProdNodeWriter_i::cadmin_ [private]

Reference to AnCList object reference.

Definition at line 244 of file persprodnode_i.h.

const std::string OSB_CORBA::PersProdNodeWriter_i::IFC [static]

Definition at line 84 of file persprodnode_i.h.

Locators::Key OSB_CORBA::PersProdNodeWriter_i::key_ [private]

Servant key of object.

Definition at line 258 of file persprodnode_i.h.

Referenced by key().

const OSB_LIB::ProductNode* OSB_CORBA::PersProdNodeWriter_i::pn_ [private]

Product node is needed when creating personalised item.

Definition at line 249 of file persprodnode_i.h.

Servants OSB_CORBA::PersProdNodeWriter_i::ppiServants_ [private]

PersProdItem servant id list.

Definition at line 255 of file persprodnode_i.h.

OSB_LIB::PersProductNode* OSB_CORBA::PersProdNodeWriter_i::ppn_ [private]

Pointer to personalised product node.

Definition at line 252 of file persprodnode_i.h.

PersProductWriter_i& OSB_CORBA::PersProdNodeWriter_i::ppServant_ [private]

Reference to the servant owner.

Definition at line 246 of file persprodnode_i.h.

---

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

• persprodnode_i.h

---