corba::cadmin::persprodnode::PersProdNodeWriter

corba::cadmin::persprodnode::PersProdNodeWriter Interface Reference

Collaboration diagram for corba::cadmin::persprodnode::PersProdNodeWriter:

[legend]List of all members.

Detailed Description

Interface provides read and write access to a personalized product node.

Definition at line 43 of file persprodnode.idl.

Public Member Functions

common::Utf8String name () raises (common::OsbCorbaException)
Return name of prodpart used to create persprodnode.
common::Utf8String desc () raises (common::OsbCorbaException)
pcat::pp::PpTypeId type () raises (common::OsbCorbaException)
Return type of underlying product item.
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.
cadmin::persproditem::PersProdItemSeq getConfigs () raises (common::OsbCorbaException)
cadmin::persproditem::PersProdItemWriter getConfig (in cadmin::PersItemId id) raises (common::OsbCorbaException)
Return a configuration.
cadmin::persproditem::PersProdItemWriter currentConfig () raises (common::OsbCorbaException)
Return configuation that is being used currently.
cadmin::persproditem::PersProdItemWriter creNewConfig () raises (common::OsbCorbaException)
Get a new temporary personalised product node writer.
boolean removeConfig (in cadmin::PersItemId id, in boolean noWait) raises (common::OsbCorbaException)
Remove a configuration.

Public Attributes

readonly attribute PersNodeId id
Type-safe unique id of a personalised product part.
readonly attribute pcat::pp::ProductPartId prodPartId
Type-safe unique id of product part.
readonly attribute common::DateTime createdDate
Date of creation of personalised product part.
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.

Member Function Documentation

cadmin::persproditem::PersProdItemWriter corba::cadmin::persprodnode::PersProdNodeWriter::creNewConfig ( ) raises (common::OsbCorbaException)

Get a new temporary personalised product node 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 these library objects are ID_NOT_SET.

Returns:: Return personalised product item writer.

Exceptions:

OsbCorbaException

if operation fails at the gateway or if status is deactivated.

cadmin::persproditem::PersProdItemWriter corba::cadmin::persprodnode::PersProdNodeWriter::currentConfig ( ) raises (common::OsbCorbaException)

Return configuation that is being used currently.

common::Utf8String corba::cadmin::persprodnode::PersProdNodeWriter::desc ( ) raises (common::OsbCorbaException)

Return description of prodpart used to create persprodnode.

cadmin::persproditem::PersProdItemWriter corba::cadmin::persprodnode::PersProdNodeWriter::getConfig ( in cadmin::PersItemId id ) raises (common::OsbCorbaException)

Return a configuration.

cadmin::persproditem::PersProdItemSeq corba::cadmin::persprodnode::PersProdNodeWriter::getConfigs ( ) raises (common::OsbCorbaException)

Return list of configurations which are PersProdItems.

common::Utf8String corba::cadmin::persprodnode::PersProdNodeWriter::name ( ) raises (common::OsbCorbaException)

Return name of prodpart used to create persprodnode.

boolean corba::cadmin::persprodnode::PersProdNodeWriter::removeConfig	(	in cadmin::PersItemId	id,
		in boolean	noWait
	)			raises (common::OsbCorbaException)

Remove a configuration.

Parameters:

	id	Unique personalised product item.
	noWait	Set to false if waiting is desired when lock is already acquired by others. If waiting is not required, set to true.

Returns:: True if operation is successful.

Exceptions:

OsbCorbaException

if operation at the gateway fails.

StatusValue corba::cadmin::persprodnode::PersProdNodeWriter::requestedStatus ( in common::DateTime ts ) raises (common::OsbCorbaException)

Get the requested status for a given time.

Parameters:

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 corba::cadmin::persprodnode::PersProdNodeWriter::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.