Component

Name Component
Usage ComponentService
getComponentByCode getAllComponentsByNamespaceCode getActiveComponentsByNamespaceCode getDerivedComponentSet publishDerivedComponents
Type Complex

Description

An immutable representation of an {@link ComponentContract}.

Use the class {@link Component.Builder} to construct an Component object.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
namespaceCode Namespace Code String This is the namespace for the component. It cannot be null or a blank string.


It is a way of assigning the component to a logical grouping within a rice application or rice ecosystem.

 Required   One No  
code Code String The code value for this object. In general a code value cannot be null or a blank string. Required   One No  
name Name String This is the name value for the component. It cannot be null or a blank string. Required   One No  
componentSetId Component Set Id String Returns the id of the component set this component belongs to if this component was published as part of such
a component set. Will return a null value if this component was not published as part of a component set.		     One No  
active Active boolean The active indicator for an object.     One No  
versionNumber Version Number Long Returns the version number for this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.
This version number is generally used for the purposes of optimistic locking.		     One No  
objectId Object Id String Return the globally unique object id of this object. In general, this value should only
be null if the object has not yet been stored to a persistent data store.		     One No