C# Class EPiCode.Relations.Core.RelationProviders.RelationProviderBase

Inheritance: System.Configuration.Provider.ProviderBase

Mostrar archivo Open project: BVNetwork/Relations Class Usage Examples

Protected Properties

Property	Type	Description
_description	string
_name	string

Public Methods

Method	Description
AddRelation ( string rule, int pageLeft, int pageRight ) : void	Create a new relation between two pages in EPi
DeleteAll ( ) : void	Delete all rules
DeleteAll ( string rule ) : void	Delete all relations of a given rule
DeleteRelation ( Relation relationToDelete ) : void	Delete single relation
GetAllRelations ( string rule ) : List	Get all relations of a given rule
GetRelation ( Identity id ) : Relation	Get single relation
GetRelation ( string rule, int pageLeft, int pageRight ) : Relation	Get single relation
GetRelationPagesForPage ( int pageID, Rule rule ) : List	Get related page IDs for page
GetRelationPagesForPage ( int pageID, Rule rule, Rule direction ) : List	Get a list of all related pages through one direction of a given rule
GetRelationsCount ( string rule ) : int	Get number of relations for a rule
GetRelationsForPage ( int pageID ) : List	Get relations for given page
GetRelationsForPage ( int pageID, Rule rule ) : List	Get relations for given page
GetRelationsForPage ( int pageID, Rule rule, Rule dir ) : List	Get all page relations for the rule through a specific direction
GetRelationsForPageTwoHop ( int pageID, Rule firstRule, Rule firstDirection, Rule secondRule, Rule secondDirection ) : List	Get a list of all related pages through one direction of two given rules
RaiseOnAddedRelation ( RelationEventArgs e ) : void
RaiseOnAddingRelation ( RelationEventArgs e ) : void
RaiseOnDeletedRelation ( RelationEventArgs e ) : void
RaiseOnDeletingRelation ( RelationEventArgs e ) : void
RelationExists ( string rule, int pageLeft, int pageRight ) : bool	Check if a relation already exists
Save ( Relation relation ) : void	Save relation

Method Details

AddRelation() public abstract method

Create a new relation between two pages in EPi

public abstract AddRelation ( string rule, int pageLeft, int pageRight ) : void
rule	string	Rule to use for new relation
pageLeft	int	Left side page
pageRight	int	Right side page
return	void

DeleteAll() public abstract method

Delete all rules

public abstract DeleteAll ( ) : void
return	void

DeleteAll() public abstract method

Delete all relations of a given rule

public abstract DeleteAll ( string rule ) : void
rule	string
return	void

DeleteRelation() public abstract method

Delete single relation

public abstract DeleteRelation ( Relation relationToDelete ) : void
relationToDelete	Relation	Relation to be deleted
return	void

GetAllRelations() public abstract method

Get all relations of a given rule

public abstract GetAllRelations ( string rule ) : List
rule	string	Name of rule
return	List

GetRelation() public abstract method

Get single relation

public abstract GetRelation ( Identity id ) : Relation
id	Identity	Relation ID
return	Relation

GetRelation() public abstract method

Get single relation

public abstract GetRelation ( string rule, int pageLeft, int pageRight ) : Relation
rule	string	Rule
pageLeft	int	Left page
pageRight	int	Right page
return	Relation

GetRelationPagesForPage() public abstract method

Get related page IDs for page

public abstract GetRelationPagesForPage ( int pageID, Rule rule ) : List
pageID	int	Page ID to get relations from
rule	Rule	Rule to get relations through
return	List

GetRelationPagesForPage() public abstract method

Get a list of all related pages through one direction of a given rule

public abstract GetRelationPagesForPage ( int pageID, Rule rule, Rule direction ) : List
pageID	int	Page ID to get relations from
rule	Rule	Rule to get relations through
direction	Rule	Direction to search through
return	List

GetRelationsCount() public abstract method

Get number of relations for a rule

public abstract GetRelationsCount ( string rule ) : int
rule	string	Rule to get number of relations of
return	int

GetRelationsForPage() public abstract method

Get relations for given page

public abstract GetRelationsForPage ( int pageID ) : List
pageID	int	Page ID to fetch relations from
return	List

GetRelationsForPage() public abstract method

Get relations for given page

public abstract GetRelationsForPage ( int pageID, Rule rule ) : List
pageID	int	Page ID to fetch relations from
rule	Rule	Relation rule to use
return	List

GetRelationsForPage() public abstract method

Get all page relations for the rule through a specific direction

public abstract GetRelationsForPage ( int pageID, Rule rule, Rule dir ) : List
pageID	int	Page ID to get relations from
rule	Rule	Rule to get relations through
dir	Rule
return	List

GetRelationsForPageTwoHop() public abstract method

Get a list of all related pages through one direction of two given rules

public abstract GetRelationsForPageTwoHop ( int pageID, Rule firstRule, Rule firstDirection, Rule secondRule, Rule secondDirection ) : List
pageID	int
firstRule	Rule
firstDirection	Rule
secondRule	Rule
secondDirection	Rule
return	List

RaiseOnAddedRelation() public method

public RaiseOnAddedRelation ( RelationEventArgs e ) : void
e	RelationEventArgs
return	void

RaiseOnAddingRelation() public method

public RaiseOnAddingRelation ( RelationEventArgs e ) : void
e	RelationEventArgs
return	void

RaiseOnDeletedRelation() public method

public RaiseOnDeletedRelation ( RelationEventArgs e ) : void
e	RelationEventArgs
return	void

RaiseOnDeletingRelation() public method

public RaiseOnDeletingRelation ( RelationEventArgs e ) : void
e	RelationEventArgs
return	void

RelationExists() public abstract method

Check if a relation already exists

public abstract RelationExists ( string rule, int pageLeft, int pageRight ) : bool
rule	string	Rule to check
pageLeft	int	Left page to check
pageRight	int	Right page to check
return	bool

Save() public abstract method

Save relation

public abstract Save ( Relation relation ) : void
relation	Relation	Relation to be saved
return	void

Property Details

_description protected_oe property

protected string _description
return	string

_name protected_oe property

protected string _name
return	string