corba::cadmin::persprod::PersProductWriter Interface Reference

Collaboration diagram for corba::cadmin::persprod::PersProductWriter:

[legend]List of all members.

---

Detailed Description

Interface to provide read and write access to a personalised product.

Definition at line 94 of file persproduct.idl.

Public Member Functions

• common::Utf8String name () raises (common::OsbCorbaException)

  Name of product.
  

• common::Utf8String desc () raises (common::OsbCorbaException)

  Description of product.
  

• AvailnSubscrPartSeq getAvailnSubscrParts (in pcat::pp::ProductPartId id) raises (common::OsbCorbaException)

  Get a list of children parts that are available and subscribed.
  

• AvailnSubscrPart getAvailnSubscrPart (in pcat::pp::ProductPartId id) raises (common::OsbCorbaException)

  Get a product part that is available or subscribed.
  

• cadmin::persprodnode::PersProdNodeSeq getPersProdNodes () raises (common::OsbCorbaException)

  Retreive list of personalised product node.
  

• cadmin::persprodnode::PersProdNodeWriter getPersProdNode (in pcat::pp::ProductPartId id) raises (common::OsbCorbaException)

  Retrieve a personalised product node.
  

• StatusValue requestedStatus (in common::DateTime ts) raises (common::OsbCorbaException)

  Get the requested status for a given time.
  

• StatusHistory statusHistory (in common::DateTime from, in common::DateTime to, in boolean noWait) raises (common::OsbCorbaException)

  Get status history for a period of time.
  

• boolean addPersProdNode (in pcat::pp::ProductPartId id, in boolean noWait) raises (common::OsbCorbaException)

  Add a new personalised product node.
  

• boolean removePersProdNode (in pcat::pp::ProductPartId id, in boolean noWait) raises (common::OsbCorbaException)

  Remove a new personalised product node.
  

• boolean subscribe (in pcat::pp::ProductPartId id, in boolean noWait) raises (common::OsbCorbaException)

  Subscribe a product part.
  

• void setUserId (in AssociateId id)
• boolean commitChanges (in boolean noWait) raises (common::OsbCorbaException)

  Update changes permanently into database.
  

Status changes:

• boolean changeStatus (inout StatusRequest status, in boolean noWait, out common::CfgErrorSeq errors) raises (common::OsbCorbaException)

  Set the preferred status of the pers. product.
  

• boolean changePartStatus (inout StatusRequest status, in pcat::pp::ProductPartId ppId, in boolean noWait, out common::CfgErrorSeq errors) raises (common::OsbCorbaException)

  Set the preferred status of a pers. product part.
  

Public Attributes

• readonly attribute PersProdId id

  Type-safe unique id of a personalised product.
  

• readonly attribute pcat::pd::ProductId prodId

  Type-safe unique id of product.
  

• readonly attribute cadmin::AssociateId userId
• readonly attribute common::DateTime createdDate

  Date of creation of personalised product.
  

• readonly attribute Status prefStatus

  Preferred status.
  

• readonly attribute common::DateTime prefStatusDate

  Date at which preferred status goes into effect.
  

• readonly attribute Status effStatus

  Effective Status.
  

• readonly attribute common::DateTime effStatusDate

  Date of effective status.
  

• readonly attribute AvailnSubscrPartSeq getNextAvailnSubscrParts

---

Member Function Documentation

boolean corba::cadmin::persprod::PersProductWriter::addPersProdNode	(	in pcat::pp::ProductPartId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Add a new personalised product node.

This operation is not allowed if parent is deactivated.

Parameters:

	id	Unqiue product part 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.

boolean corba::cadmin::persprod::PersProductWriter::changePartStatus	(	inout StatusRequest	status,
		in pcat::pp::ProductPartId	ppId,
		in boolean	noWait,
		out common::CfgErrorSeq	errors
	)			raises (common::OsbCorbaException)

Set the preferred status of a pers. product part.

Parameters:

	status	Preferred status to set, see below.
	ppId	Id of the pers. product part to change.
	noWait	Don't wait for database locks?
	errors	Gets encountered errors.

When calling the function, status must have the requested status, reason and cascade flag set; if the status date is not set the system date is used.
If successful the request id, the requested date/time and the entry timestamp will be set.

boolean corba::cadmin::persprod::PersProductWriter::changeStatus	(	inout StatusRequest	status,
		in boolean	noWait,
		out common::CfgErrorSeq	errors
	)			raises (common::OsbCorbaException)

Set the preferred status of the pers. product.

Parameters:

	status	Preferred status to set, see below.
	noWait	Don't wait for database locks?
	errors	Gets encountered errors.

When calling the function, status must have the requested status, reason and cascade flag set; if the status date is not set the system date is used.
If successful the request id, the requested date/time and the entry timestamp will be set.

boolean corba::cadmin::persprod::PersProductWriter::commitChanges

(

in boolean

noWait

)

raises (common::OsbCorbaException)

Update changes permanently into database.

common::Utf8String corba::cadmin::persprod::PersProductWriter::desc

(

)

raises (common::OsbCorbaException)

Description of product.

AvailnSubscrPart corba::cadmin::persprod::PersProductWriter::getAvailnSubscrPart

(

in pcat::pp::ProductPartId

id

)

raises (common::OsbCorbaException)

Get a product part that is available or subscribed.

Parameters:

id

Unique id of product part.

Returns:

A product part that is available or subscribed.

Exceptions:

OsbCorbaException

if AvailnSubscrPart cannot be found.

AvailnSubscrPartSeq corba::cadmin::persprod::PersProductWriter::getAvailnSubscrParts

(

in pcat::pp::ProductPartId

id

)

raises (common::OsbCorbaException)

Get a list of children parts that are available and subscribed.

This function differs from getNextAvailnSubscrPart in that it allows for the retrieval of children of any hierarchy level in the AvailnSubscrPart tree.

Parameters:

id

Unique id of product part.

Returns:

List of subscribed product parts.

Exceptions:

OsbCorbaException

if AvailnSubscrPart cannot be found.

cadmin::persprodnode::PersProdNodeWriter corba::cadmin::persprod::PersProductWriter::getPersProdNode

(

in pcat::pp::ProductPartId

id

)

raises (common::OsbCorbaException)

Retrieve a personalised product node.

Parameters:

id

Unique personalised product node id.

Returns:

Reference to personalised product node.

Exceptions:

OsbCorbaException

if no personalised product node for such a product part exist.

cadmin::persprodnode::PersProdNodeSeq corba::cadmin::persprod::PersProductWriter::getPersProdNodes

(

)

raises (common::OsbCorbaException)

Retreive list of personalised product node.

The list of personalised product node retreived has no hierarchy.

Exceptions:

OsbCorbaException

if any of the personalised product node in the personalised product node list is not found.

common::Utf8String corba::cadmin::persprod::PersProductWriter::name

(

)

raises (common::OsbCorbaException)

Name of product.

boolean corba::cadmin::persprod::PersProductWriter::removePersProdNode	(	in pcat::pp::ProductPartId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Remove a new personalised product node.

This operation is not allowed if parent is dactivated.

Parameters:

	id	Unqiue product part 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 at the gateway fails.

StatusValue corba::cadmin::persprod::PersProductWriter::requestedStatus

(

in common::DateTime

ts

)

raises (common::OsbCorbaException)

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.

void corba::cadmin::persprod::PersProductWriter::setUserId

(

in AssociateId

id

)

brief Change the product user of a personalized product.

Parameters:

id

Unique associate id.

StatusHistory corba::cadmin::persprod::PersProductWriter::statusHistory	(	in common::DateTime	from,
		in common::DateTime	to,
		in boolean	noWait
	)			raises (common::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.

boolean corba::cadmin::persprod::PersProductWriter::subscribe	(	in pcat::pp::ProductPartId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Subscribe a product part.

This function will result in personalised product nodes and items being created as specified by the rules of each product item . This function is different from addPersProdNode as the addPersProdNode function just create a new personalised product node and does not create new personalised product item.

Parameters:

	id	Unqiue product part 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.

---

Member Data Documentation

readonly attribute common::DateTime corba::cadmin::persprod::PersProductWriter::createdDate

Date of creation of personalised product.

Definition at line 115 of file persproduct.idl.

readonly attribute Status corba::cadmin::persprod::PersProductWriter::effStatus

Effective Status.

Definition at line 124 of file persproduct.idl.

readonly attribute common::DateTime corba::cadmin::persprod::PersProductWriter::effStatusDate

Date of effective status.

Definition at line 127 of file persproduct.idl.

readonly attribute AvailnSubscrPartSeq corba::cadmin::persprod::PersProductWriter::getNextAvailnSubscrParts

Get first hierarchy level of subscribed products (both mandatory and personalised product parts ids) and available product parts that has not been subscribed.

Definition at line 135 of file persproduct.idl.

readonly attribute PersProdId corba::cadmin::persprod::PersProductWriter::id

Type-safe unique id of a personalised product.

Definition at line 96 of file persproduct.idl.

readonly attribute Status corba::cadmin::persprod::PersProductWriter::prefStatus

Preferred status.

Definition at line 118 of file persproduct.idl.

readonly attribute common::DateTime corba::cadmin::persprod::PersProductWriter::prefStatusDate

Date at which preferred status goes into effect.

Definition at line 121 of file persproduct.idl.

readonly attribute pcat::pd::ProductId corba::cadmin::persprod::PersProductWriter::prodId

Type-safe unique id of product.

Definition at line 99 of file persproduct.idl.

readonly attribute cadmin::AssociateId corba::cadmin::persprod::PersProductWriter::userId

Type-safe unique id of a user of personalised product.

Definition at line 104 of file persproduct.idl.

---

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

• persproduct.idl

---