C# Class Rock.Model.FinancialScheduledTransactionService

Service/Data access class for Rock.Model.FinancialScheduledTransaction entity objects.
Datei anzeigen Open project: SparkDevNetwork/Rock Class Usage Examples

Public Methods

Method Description
Cancel ( FinancialScheduledTransaction scheduledTransaction, string &errorMessages ) : bool

Cancels the specified scheduled transaction.
Delete ( FinancialScheduledTransaction item ) : bool

Deletes the specified item.
Get ( int personId, int givingGroupId, bool includeInactive ) : IQueryable

Gets schedule transactions associated to a person. Includes any transactions associated to person or any other person with same giving group id
GetByScheduleId ( string scheduleId ) : FinancialScheduledTransaction

Gets the by schedule identifier.
GetStatus ( FinancialScheduledTransaction scheduledTransaction, string &errorMessages ) : bool

Sets the status.
ProcessPayments ( FinancialGateway gateway, string batchNamePrefix, List payments, string batchUrlFormat = "", System.Guid receiptEmail = null ) : string

Processes the payments.
Reactivate ( FinancialScheduledTransaction scheduledTransaction, string &errorMessages ) : bool

Reactivates the specified scheduled transaction.

Private Methods

Method Description
CalculateTransactionAmount ( Payment payment, List transactions ) : decimal
LaunchWorkflow ( WorkflowType workflowType, FinancialTransaction transaction ) : void

Method Details

Cancel() public method

Cancels the specified scheduled transaction.
public Cancel ( FinancialScheduledTransaction scheduledTransaction, string &errorMessages ) : bool
scheduledTransaction FinancialScheduledTransaction The scheduled transaction.
errorMessages string The error messages.
return bool

Delete() public method

Deletes the specified item.
public Delete ( FinancialScheduledTransaction item ) : bool
item FinancialScheduledTransaction The item.
return bool

Get() public method

Gets schedule transactions associated to a person. Includes any transactions associated to person or any other person with same giving group id
public Get ( int personId, int givingGroupId, bool includeInactive ) : IQueryable
personId int The person identifier.
givingGroupId int The giving group identifier.
includeInactive bool if set to true [include inactive].
return IQueryable

GetByScheduleId() public method

Gets the by schedule identifier.
public GetByScheduleId ( string scheduleId ) : FinancialScheduledTransaction
scheduleId string The schedule identifier.
return FinancialScheduledTransaction

GetStatus() public method

Sets the status.
public GetStatus ( FinancialScheduledTransaction scheduledTransaction, string &errorMessages ) : bool
scheduledTransaction FinancialScheduledTransaction The scheduled transaction.
errorMessages string The error messages.
return bool

ProcessPayments() public static method

Processes the payments.
public static ProcessPayments ( FinancialGateway gateway, string batchNamePrefix, List payments, string batchUrlFormat = "", System.Guid receiptEmail = null ) : string
gateway FinancialGateway The gateway.
batchNamePrefix string The batch name prefix.
payments List The payments.
batchUrlFormat string The batch URL format.
receiptEmail System.Guid The receipt email.
return string

Reactivate() public method

Reactivates the specified scheduled transaction.
public Reactivate ( FinancialScheduledTransaction scheduledTransaction, string &errorMessages ) : bool
scheduledTransaction FinancialScheduledTransaction The scheduled transaction.
errorMessages string The error messages.
return bool