org.opencrx.kernel.activity1.jdo2
Class ProductReference

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.activity1.jdo2.ProductReference

All Implemented Interfaces:

Serializable, ProductReference, SecureObject, ConfiguredProduct, ProductConfigurationSet, ProductDescriptor, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable

public class ProductReference
extends org.w3c.jdo2.AbstractObject
implements ProductReference

Class ProductReference

See Also:

Serialized Form

Nested Class Summary

static class	ProductReference.Identity The object's application identity
static class	ProductReference.Slice Slice object hold the ProductReference's multivalued attributes

Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject

org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

Field Summary

static List<String>	BASE_CLASS Define this class as base class
static List<String>	CLASS Define the model class org::opencrx::kernel::activity1::ProductReference

Constructor Summary

ProductReference()

Method Summary

void	addConfiguration(boolean idIsPersistent, String id, ProductConfiguration configuration) Adds the specified element to the set of the values for the reference configuration.
ModifySecureObjectResult	addOwningGroup(PrincipalGroup group, short mode)
void	addToActivity(Activity activity) Sets a new value for the reference activity.
void	addToActivity(Activity activity, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:activity1:ActivityHasProductReference.
CheckPermissionsResult	checkPermissions(String principalName)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
ProductConfigurationTypeSet	getConfigType() Retrieves the value for the reference configType.
<T extends ProductConfiguration> Collection<T>	getConfiguration() Retrieves a set containing all the elements for the reference configuration.
ProductConfiguration	getConfiguration(boolean idIsPersistent, String id) Retrieves the value for the reference configuration for the specified qualifier attribute value.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy() Retrieves a set containing all the elements for the attribute createdBy.
ProductConfiguration	getCurrentConfig() Retrieves the value for the reference currentConfig.
String	getIdentity() Retrieves the value for the attribute identity.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
Set<String>	getModifiedBy() Retrieves a set containing all the elements for the attribute modifiedBy.
List<String>	getOwner() Retrieves a list containing all the elements for the attribute owner.
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
User	getOwningUser() Retrieves the value for the reference owningUser.
Product	getProduct() Retrieves the value for the reference product.
Set<String>	getProductSerialNumber() Retrieves a set containing all the elements for the attribute productSerialNumber.
<T extends org.openmdx.compatibility.view1.cci2.View> Collection<T>	getView() Retrieves a set containing all the elements for the reference view.
org.openmdx.compatibility.view1.cci2.View	getView(boolean namespaceIsPersistent, String namespace) Retrieves the value for the reference view for the specified qualifier attribute value.
static ProductReference.Identity	newIdentity(Activity.Identity activity, boolean idIsPersistent, String id)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected String	openmdxjdoGetObjectId() Retrieve the object's JDO identity key
static CloseableCollection<ProductReference>	openmdxjdoGetObjectsByParent(Activity activity) Navigate through an object's composite association
protected int	openmdxjdoGetSize(int field)
protected <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
static ProductReference.Identity	openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)
ModifySecureObjectResult	removeAllOwningGroup(short mode)
ModifySecureObjectResult	removeOwningGroup(PrincipalGroup group, short mode)
ModifySecureObjectResult	setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
void	setAccessLevelBrowse(short accessLevelBrowse) Sets a new value for the attribute accessLevelBrowse.
void	setAccessLevelDelete(short accessLevelDelete) Sets a new value for the attribute accessLevelDelete.
void	setAccessLevelUpdate(short accessLevelUpdate) Sets a new value for the attribute accessLevelUpdate.
void	setCurrentConfig(ProductConfiguration currentConfig) Sets a new value for the reference currentConfig.
ModifySecureObjectResult	setOwningUser(short mode, User user)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
void	setProduct(Product product) Sets a new value for the reference product.
void	setProductSerialNumber(String... productSerialNumber) Clears productSerialNumber and adds the given value(s).
org.openmdx.base.cci2.Void	unsetConfigurationType()

Methods inherited from class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::opencrx::kernel::activity1::ProductReference

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

ProductReference.CLASS

Constructor Detail

ProductReference

public ProductReference()

Method Detail

openmdxjdoGetObjectId

protected String openmdxjdoGetObjectId()

Retrieve the object's JDO identity key

Specified by:

openmdxjdoGetObjectId in class org.oasisopen.jdo2.Identifiable

Returns:

the value of the object's JDO identity key

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

Overrides:

openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getCurrentConfig

public ProductConfiguration getCurrentConfig()

Retrieves the value for the reference currentConfig.

Specified by:

getCurrentConfig in interface ConfiguredProduct

Returns:

The – possibly null – value for this reference.

setCurrentConfig

public void setCurrentConfig(ProductConfiguration currentConfig)

Sets a new value for the reference currentConfig.

Specified by:

setCurrentConfig in interface ConfiguredProduct

Parameters:

currentConfig - The non-null new value for this reference.

getAccessLevelDelete

public short getAccessLevelDelete()

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

setAccessLevelDelete

public void setAccessLevelDelete(short accessLevelDelete)

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

accessLevelDelete - The non-null new value for attribute accessLevelDelete.

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute modifiedAt.

getModifiedBy

public final Set<String> getModifiedBy()

Retrieves a set containing all the elements for the attribute modifiedBy.

Specified by:

getModifiedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getAccessLevelBrowse

public short getAccessLevelBrowse()

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

setAccessLevelBrowse

public void setAccessLevelBrowse(short accessLevelBrowse)

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

accessLevelBrowse - The non-null new value for attribute accessLevelBrowse.

getIdentity

public String getIdentity()

Retrieves the value for the attribute identity.

Specified by:

getIdentity in interface org.openmdx.base.cci2.ExtentCapable

Returns:

The non-null value for attribute identity.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(short mode)

Specified by:

removeAllOwningGroup in interface SecureObject

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute createdAt.

getProductSerialNumber

public final Set<String> getProductSerialNumber()

Retrieves a set containing all the elements for the attribute productSerialNumber.

Specified by:

getProductSerialNumber in interface ConfiguredProduct

Returns:

A set containing all elements for this attribute.

setProductSerialNumber

public void setProductSerialNumber(String... productSerialNumber)

Clears productSerialNumber and adds the given value(s).

This method is equivalent to

   set.clear();
   set.addAll(Arrays.asList(productSerialNumber));
 

Specified by:

setProductSerialNumber in interface ConfiguredProduct

Parameters:

productSerialNumber - value(s) to be added to productSerialNumber

setOwningUser

public ModifySecureObjectResult setOwningUser(short mode,
                                              User user)

Specified by:

setOwningUser in interface SecureObject

getOwningGroup

public <T extends PrincipalGroup> List<T> getOwningGroup()

Retrieves the Collection of objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The Collection of referenced objects.

addOwningGroup

public ModifySecureObjectResult addOwningGroup(PrincipalGroup group,
                                               short mode)

Specified by:

addOwningGroup in interface SecureObject

unsetConfigurationType

public org.openmdx.base.cci2.Void unsetConfigurationType()

Specified by:

unsetConfigurationType in interface ProductConfigurationSet

getConfigType

public ProductConfigurationTypeSet getConfigType()

Retrieves the value for the reference configType.

Specified by:

getConfigType in interface ProductConfigurationSet

Returns:

The – possibly null – value for this reference.

checkPermissions

public CheckPermissionsResult checkPermissions(String principalName)

Specified by:

checkPermissions in interface SecureObject

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(PrincipalGroup group,
                                                  short mode)

Specified by:

removeOwningGroup in interface SecureObject

getProduct

public Product getProduct()

Retrieves the value for the reference product.

Specified by:

getProduct in interface ProductDescriptor

Returns:

The – possibly null – value for this reference.

setProduct

public void setProduct(Product product)

Sets a new value for the reference product.

Specified by:

setProduct in interface ProductDescriptor

Parameters:

product - The non-null new value for this reference.

getAccessLevelUpdate

public short getAccessLevelUpdate()

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

setAccessLevelUpdate

public void setAccessLevelUpdate(short accessLevelUpdate)

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

accessLevelUpdate - The non-null new value for attribute accessLevelUpdate.

getCreatedBy

public final Set<String> getCreatedBy()

Retrieves a set containing all the elements for the attribute createdBy.

Specified by:

getCreatedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(short accessLevelBrowse,
                                               short accessLevelDelete,
                                               short accessLevelUpdate,
                                               short mode)

Specified by:

setAccessLevel in interface SecureObject

getAccessGrantedByParent

public org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

getOwner

public final List<String> getOwner()

Retrieves a list containing all the elements for the attribute owner.

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getView

public <T extends org.openmdx.compatibility.view1.cci2.View> Collection<T> getView()

Retrieves a set containing all the elements for the reference view.

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.ViewCapable

Returns:

A set containing all the elements for this reference.

getView

public org.openmdx.compatibility.view1.cci2.View getView(boolean namespaceIsPersistent,
                                                         String namespace)

Retrieves the value for the reference view for the specified qualifier attribute value.

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.ViewCapable

Parameters:

namespaceIsPersistent - Defines whether value for the qualifier is persistent or not

namespace - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

getConfiguration

public <T extends ProductConfiguration> Collection<T> getConfiguration()

Retrieves a set containing all the elements for the reference configuration.

Specified by:

getConfiguration in interface ProductConfigurationSet

Returns:

A set containing all the elements for this reference.

getConfiguration

public ProductConfiguration getConfiguration(boolean idIsPersistent,
                                             String id)

Retrieves the value for the reference configuration for the specified qualifier attribute value.

Specified by:

getConfiguration in interface ProductConfigurationSet

Parameters:

idIsPersistent - Defines whether value for the qualifier is persistent or not

id - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

addConfiguration

public void addConfiguration(boolean idIsPersistent,
                             String id,
                             ProductConfiguration configuration)

Adds the specified element to the set of the values for the reference configuration.

Note: This is an extension to the JMI 1 standard.

Specified by:

addConfiguration in interface ProductConfigurationSet

Parameters:

idIsPersistent - true if id is persistent

id - The qualifier attribute value that qualifies the reference to get the element to be appended.

configuration - The element to be appended.

getOwningUser

public User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

public void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

owningUser - The non-null new value for this reference.

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class org.w3c.jdo2.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class org.w3c.jdo2.AbstractObject

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Returns:

the model class

See Also:

ProductReference.CLASS

addToActivity

public void addToActivity(Activity activity)

Sets a new value for the reference activity.

Parameters:

activity - The non-null new value for this reference.

openmdxjdoGetObjectsByParent

public static CloseableCollection<ProductReference> openmdxjdoGetObjectsByParent(Activity activity)

Navigate through an object's composite association

addToActivity

public void addToActivity(Activity activity,
                          boolean idIsPersistent,
                          String id)

Set the object's composite association org:opencrx:kernel:activity1:ActivityHasProductReference.

Parameters:

activity - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.

newIdentity

public static ProductReference.Identity newIdentity(Activity.Identity activity,
                                                    boolean idIsPersistent,
                                                    String id)

openmdxjdoToIdentity

public static ProductReference.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)