|
| |
|
| java.lang.Object
 com.metaboss.enterprise.ps.STCollectionDetails
| STCollectionDetails | | final public class STCollectionDetails implements Serializable(Code) | | This structure contains the details of the required collection.
It (or more precisely array of these) is passed to a storage record retrieval methods, like getAll() and
getCount(). Passing it is in effect filtering down set of entities. Note that
the actual search implementation details is not passed in this structure, so
underlying storage implementation makes use of addtional collection metadata
either at generation time or at run time or both). Each collection can define
zero or more filtering criterias and zero or more ordering instructions.
Collection itself can be arrived at in a number of different ways:
- By executing a set operation. Union, Intersection and Difference are supported.
Union - all elements from both collections, Intersection - all elements found in both collections
and Difference - all elements only found in first collection. In this case of set operations EntityRef, SetOperationName and
FirstSetDetails and SecondSetDetails are populated.
- By selection of all domain entities associated with another entity.
In this case only EntityRef, AssociationRef, AssociationRoleRef and AssociationRoleEntityInstanceId fields are populated
- By casting of one entity type to the other up and down along inheritance hierarchy.
In this case only EntityRef and CastingSourceEntityRef are populated
Note that DataTypes passed in this structure (as with all data fields passed
to the storage layer) can not be concealed as this does not make any sence in selection process.
|
| AllEntitiesInDomain | | public boolean AllEntitiesInDomain(Code) | | Optional flag specifying that this collection has been created as full collection of all the entities in the domain
|
| AssociationRoleEntityInstanceId | | public DataType AssociationRoleEntityInstanceId(Code) | | Optional instance identifier of the entity, where association comes from.
If it is present it is include in the selection, selection is made of entities related to the given one
|
| AssociationRoleRef | | public String AssociationRoleRef(Code) | | Optional reference of the role within given entity.
Its presence makes this selector an association role selector.
|
| CastingSourceEntityRef | | public String CastingSourceEntityRef(Code) | | Populated for cast operations. Contains the entity ref from which to cast
|
| EntityRef | | public String EntityRef(Code) | | Mandatory reference of the entity - type of this collection
|
| FirstSetDetails | | public STCollectionDetails[] FirstSetDetails(Code) | | Collection details describing the first set.
Only populated if this collection has been created as the result of set operation
which is requiring the first set details
|
| ResultMaximumSize | | public DataType ResultMaximumSize(Code) | | This field together with ResultStartOffset is used to limit this result
set. This pair of fields is different to the
SubsetStartOffset and SubsetMaximumSize in that this pair describes
the narrowing of the filan result set where as the other describes the narrowing of the
source result set
|
| ResultStartOffset | | public DataType ResultStartOffset(Code) | | This field together with ResultMaximumSize is used to limit this result
set. This pair of fields is different to the
SubsetStartOffset and SubsetMaximumSize in that this pair describes
the narrowing of the filan result set where as the other describes the narrowing of the
source result set
|
| SETOPERATION_DIFFERENCE | | final public static String SETOPERATION_DIFFERENCE(Code) | | Describes operation on two collections, result of which is collection containing all
elements present in first collection and not present in the second
|
| SETOPERATION_INTERSECTION | | final public static String SETOPERATION_INTERSECTION(Code) | | Describes operation on two collections, result of which is collection containing all
elements present in both collection (present in one and present in the other)
|
| SETOPERATION_SUBSET | | final public static String SETOPERATION_SUBSET(Code) | | Describes operation on one collection, result of which is collection containing subset
of elements present in the original collection
|
| SETOPERATION_UNION | | final public static String SETOPERATION_UNION(Code) | | Describes operation on two collections, result of which is collection containing all
elements present in either (present in at least one of the two) collection
|
| SecondSetDetails | | public STCollectionDetails[] SecondSetDetails(Code) | | Collection details describing the second set.
Only populated if this collection has been created as the result of set operation
which is requiring the second set details
|
| SetOperationName | | public String SetOperationName(Code) | | Optional specific set operation name.
Only populated if this collection has been created as the result of set operation
|
| STCollectionDetails | | public STCollectionDetails()(Code) | | Default constructor
|
|
|
|