The ICartellaPagedRelations<(Of <(<'TOwner, TTarget>)>)> type exposes the following members.

Methods

  NameDescription
Public methodAddRelation
Add a relation entry to the collection. If the collection is not editable, exception will be thrown. If the target unique ID already exists in the keys collection, exception will be thrown. It will also fire the "TargetAdded" event if successful
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public methodConvert<(Of <<'(TNewOwner, TNewTarget>)>>)
Casting operation, convert both owner and target objects to a differnt types. If casting of the owner or targets to new types are not successful, exception will be thrown
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public methodConvertOwner<(Of <<'(TNewOwner>)>>)
Casting operation, convert the owner object to a differnt type. If casting of the owner to new type is not successful, exception will be thrown
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public methodConvertTarget<(Of <<'(TNewTarget>)>>)
Casting operation, convert the target objects to a differnt type. If casting of the targets to new type are not successful, exception will be thrown
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public methodGetAll<(Of <<'(TTargetObject>)>>)
Retrieve all records in the relations, with specific way to providing a composite owner ID parameter
Public methodGetPage<(Of <<'(TTargetObject>)>>)
Get target objects in specific page. Page number starts with 1. If page number is outside of the total pages in the relations, empty dictionary is returned
Public methodRemoveRelation
Remove a target off the relation. If collection is not editable, exception will be thrown. Target doesn't exist will not cause any exceptions. It will fire the "TargetRemoved" event is removal is successful.
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public methodSetupDelegates(InsertRelationsProcedure, RemoveRelationsProcedure)
Setup the data procedure delegates for insert and removal of targets
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public methodSetupDelegates(SelectPagedRelationsProcedure, SelectRelationsProcedure, InsertRelationsProcedure, RemoveRelationsProcedure)
Setup all data communication delegate methods for this Relations object

Properties

  NameDescription
Public propertyAdditionalProperties
Get additional properties of the relations.
Public propertyAscendSorting
Get/set the sorting order, true to be Ascending
Public propertyCollectionOwner
Get the owner of the collection
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public propertyCount
Get the target item count.
Public propertyEditable
Get the information is the collection editable. Non-Editable relations will throw exception, when AddRelation and RemoveRelation methods are called.
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public propertyManager
Get the manager of current object type. e.g. Folio object will return IFolioManager type, cast down to ICartellaObjectManager
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public propertyPageCount
Get the page counts
Public propertyPageSize
Get the page size (number of target objects per page)
Public propertyShowOnlyDeleted
Get/set if only show objects marked as deleted
Public propertyShowOnlyUnapproved
Get/set if only show objects that are not yet apporved
Public propertySiteManager
Get the Site Manager of current instance. This site manager is the one created all the object manager instances
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public propertySortingFieldName
Get/set the Database field name for sorting Normally get be retrieve from field definition
Public propertyTargetType
Get the object type definition of the target
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)

Events

  NameDescription
Public eventTargetAdded
Event to fire, when a target is added to the collection
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)
Public eventTargetRemoved
Event to fire, when a target is removed from the collection
(Inherited from IBaseRelations<(Of <(<'TOwner, TTarget>)>)>.)

See Also