/// <summary>
/// Retrieves a generic collection of all filer registration documents on record for the specified candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose filer registration documents are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A generic List collection of all filer registration documents on record for the specified candidate and election cycle.</returns>
public FilerRegistrationHistory GetFilerRegistrationDocuments(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetFilerRegistrations(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves filing dates and requirements for a particular candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose filing dates and requirements are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A collection of all filing dates and requirements on record for the specified candidate and election cycle.</returns>
public FilingDeadlines GetFilingDeadlines(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetFilingDeadlines(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves the CFIS ID of a candidate's primary committee for a specific election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate desired.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>The CFIS ID of the candidate's primary committee if found, else null.</returns>
public char?GetPrimaryCommitteeID(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetPrimaryCommitteeID(candidateID, electionCycle)); }
}
/// <summary>
/// Creates a new extension request and adds it to the persistence storage medium.
/// </summary>
/// <param name="candidateID">The ID of the candidate requesting the extension.</param>
/// <param name="electionCycle">The election cycle in which the extension is being requested.</param>
/// <param name="type">The type of extension requested.</param>
/// <param name="reviewNumber">The number of the audit review for which the extension is being requested.</param>
/// <param name="date">The date of the extension request.</param>
/// <param name="requestedDueDate">The requested extension due date.</param>
/// <param name="reason">The reason for the extension.</param>
/// <returns>A new <see cref="ExtensionRequest"/> object if the extension request was added successfully; otherwise, null.</returns>
public ExtensionRequest AddExtensionRequest(string candidateID, string electionCycle, ExtensionType type, byte reviewNumber, DateTime date, DateTime requestedDueDate, string reason)
{
using (DataClient client = new DataClient()) { return(client.AddExtensionRequest(candidateID, electionCycle, type, reviewNumber, date, requestedDueDate, reason)); }
}
/// <summary>
/// Retrieves an attachment.
/// </summary>
/// <param name="uniqueID">The unique ID of the attachment to retrieve.</param>
/// <returns>The requested <see cref="CmoAttachment"/> if found; otherwise, null.</returns>
public CmoAttachment GetCmoAttachment(string uniqueID)
{
using (DataClient client = new DataClient()) { return(client.GetCmoAttachment(uniqueID)); }
}
/// <summary>
/// Retrieves a collection of all completed statement reviews on record for the principal committee of the specified candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose statement reviews are to be retrieved.</param>
/// <param name="election">The election cycle in which to search.</param>
/// <returns>A collection of all completed statement reviews for the specified candidate and election cycle.</returns>
public StatementReviews GetStatementReviews(string candidateID, Election election)
{
using (DataClient client = new DataClient()) { return(client.GetStatementReviews(candidateID, election != null ? election.Cycle : null)); }
}
/// <summary>
/// Returns profile information for a candidate who is active in an election cycle.
/// </summary>
/// <param name="candidateID">The desired candidate's CFIS ID.</param>
/// <param name="electionCycle">The desired election cycle.</param>
/// <returns>The specified candidate's profile for the specified election cycle.</returns>
public ActiveCandidate GetActiveCandidate(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetActiveCandidate(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves messages from a candidate's CMO mailbox.
/// </summary>
/// <param name="candidateID">The CFIS ID of the desired candidate.</param>
/// <param name="view">The mailbox view type.</param>
/// <param name="elections">A collection of election cycles to filter against.</param>
/// <returns>A collection of <see cref="CmoMessage"/> objects for the specified mailbox sorted according to the properties of the mailbox.</returns>
public List <CmoMessage> GetMailboxMessages(string candidateID, CmoMailboxView view, HashSet <string> elections)
{
using (DataClient client = new DataClient()) { return(client.GetMailboxMessages(candidateID, view, elections == null ? null : elections.ToList())); }
}
/// <summary>
/// Gets the total number of unread messages in a candidate's CMO mailbox.
/// </summary>
/// <param name="candidateID">The CFIS ID of the desired candidate.</param>
/// <param name="elections">A collection of election cycles to filter against.</param>
/// <returns>The total number of unread messges in the specified candidate's mailbox.</returns>
public uint CountUnopenedMailboxMessages(string candidateID, HashSet <string> elections)
{
using (DataClient client = new DataClient()) { return(client.CountUnopenedMailboxMessages(candidateID, elections == null ? null : elections.ToList())); }
}
/// <summary>
/// Retrieves all campaign liaisons on record for the specified candidate and committee.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose liaisons are to be retrieved.</param>
/// <param name="committeeID">The ID of the committee whose liaisons are to be retrieved.</param>
/// <returns>A collection of all campaign liaisons on record for the specified candidate and committee, indexed by liaison ID.</returns>
public Dictionary <byte, Liaison> GetLiaisonsByCommittee(string candidateID, char committeeID)
{
using (DataClient client = new DataClient()) { return(client.GetLiaisons(candidateID, committeeID)); }
}
/// <summary>
/// Retrieves a collection of statement dates for an election cycle.
/// </summary>
/// <param name="electionCycle">The desired election cycle.</param>
/// <returns>A collection of statement dates for the election cycle specified, sorted and indexed by statement number.</returns>
public Dictionary <byte, Statement> GetStatements(string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetStatements(electionCycle)); }
}
/// <summary>
/// Retrieves a web transfer date for a specific election cycle.
/// </summary>
/// <returns>A web transfer date for a specific election cycle.</returns>
public DateTime?GetWebTransferDate(string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetWebTransferDate(electionCycle)); }
}
/// <summary>
/// Retrieves all bank accounts on record for the specified candidate, election cycle, and committee.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose bank accounts are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <param name="committeeID">The ID of the committee whose bank accounts are to be retrieved.</param>
/// <returns>A collection of all bank accounts on record for the specified candidate, election cycle, and committee, indexed by bank account ID.</returns>
public Dictionary <byte, BankAccount> GetBankAccountsByCommittee(string candidateID, string electionCycle, char committeeID)
{
using (DataClient client = new DataClient()) { return(client.GetBankAccounts(candidateID, electionCycle, committeeID)); }
}
/// <summary>
/// Retrieves committees for a candidate.
/// </summary>
/// <param name="candidateID">The ID of the candidate desired.</param>
/// <param name="committeeID">The ID of a committee to search for.</param>
/// <returns>A collection of all committees on record for the specified candidate with the specified committee ID (if provided).</returns>
public List <Committee> GetCommittees(string candidateID, char?committeeID = null)
{
using (DataClient client = new DataClient()) { return(client.GetCommittees(candidateID, committeeID)); }
}
/// <summary>
/// Retrieves a generic collection of all verifications of terminated candidacy on record for the specified candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose verifications of terminated candidacy are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A generic List collection of all verifications of terminated candidacy on record for the specified candidate and election cycle.</returns>
public TerminationHistory GetTerminationVerifications(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetTerminationVerifications(candidateID, electionCycle)); }
}
/// <summary>
/// Gets a collection of IDs for all compliance visit messages for a specific candidate and election cycle.
/// </summary>
/// <param name="candidateID">The CFIS ID of the reviewed candidate.</param>
/// <param name="electionCycle">The election cycle of the reviews.</param>
/// <returns>A collection of unique IDs for all compliance visit CMO messages found.</returns>
public Dictionary <byte, string> GetComplianceVisitMessageIDs(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetComplianceVisitMessageIDs(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves a generic collection of all pre-election disclosure statements on record for the specified candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose pre-election disclosure statements are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A generic List collection of all pre-election disclosure statements on record for the specified candidate and election cycle.</returns>
public PreElectionDisclosureHistory GetPreElectionDisclosures(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetPreElectionDisclosures(candidateID, electionCycle)); }
}
/// <summary>
/// Gets a collection of IDs for all Doing Business review messages for a specific candidate and election cycle.
/// </summary>
/// <param name="candidateID">The CFIS ID of the reviewed candidate.</param>
/// <param name="electionCycle">The election cycle of the reviews.</param>
/// <returns>A collection of unique IDs for all Doing Business review CMO messages found.</returns>
public Dictionary <byte, string> GetDoingBusinessReviewMessageIDs(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetDoingBusinessReviewMessageIDs(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves a generic collection of all statements of need on record for the specified candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose statements of need are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A generic List collection of all statements of need on record for the specified candidate and election cycle.</returns>
public StatementOfNeedHistory GetStatementsOfNeed(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetStatementsOfNeed(candidateID, electionCycle)); }
}
/// <summary>
/// Gets a collection of IDs for all post election audit reports for a specific candidate and election cycle.
/// </summary>
/// <param name="candidateID">The CFIS ID of the reviewed candidate.</param>
/// <param name="electionCycle">The election cycle of the reviews.</param>
/// <returns>A collection of unique IDs for all post election audit report CMO messages found.</returns>
public Dictionary <AuditReportType, string> GetAuditReportMessageIDs(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetAuditReportMessageIDs(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves a specific extension request.
/// </summary>
/// <param name="candidateID">The ID of the candidate who requested the extension.</param>
/// <param name="electionCycle">The election cycle in which the extension was requested.</param>
/// <param name="type">The type of extension requested.</param>
/// <param name="reviewNumber">The number of the audit review for which the extension was requested.</param>
/// <param name="iteration">The iteration of the extension request.</param>
/// <returns>An <see cref="ExtensionRequest"/> representing the specified extension request if found; otherwise, false.</returns>
public ExtensionRequest GetExtensionRequest(string candidateID, string electionCycle, ExtensionType type, byte reviewNumber, byte iteration)
{
using (DataClient client = new DataClient()) { return(client.GetExtensionRequest(candidateID, electionCycle, type, reviewNumber, iteration)); }
}
/// <summary>
/// Retrieves a generic collection of all C-SMART/IDS requests on record for the specified candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose C-SMART/IDS requests are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A generic List collection of all C-SMART/IDS requests on record for the specified candidate and election cycle.</returns>
public CsmartIdsRequestHistory GetCsmartIdsRequests(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetCsmartIdsRequests(candidateID, electionCycle)); }
}
/// <summary>
/// Adds a CMO message attachment.
/// </summary>
/// <param name="candidateID">The CFIS ID of the candidate recipient of the message.</param>
/// <param name="messageID">The message ID.</param>
/// <param name="data">The raw binary attachment data.</param>
/// <param name="name">The attachment file name to be use for display.</param>
/// <returns>A <see cref="CmoAttachment"/> that represents the newly added attachment.</returns>
public CmoAttachment AddCmoAttachment(string candidateID, int messageID, byte[] data, string name)
{
using (DataClient client = new DataClient()) { return(client.AddCmoAttachment(candidateID, messageID, data, name)); }
}
/// <summary>
/// Retrieves a generic collection of all Conflict of Interest Board receipts on record for the specified candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose Conflict of Interest Board receipts are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A generic List collection of all Conflict of Interest Board receipts on record for the specified candidate and election cycle.</returns>
public CoibReceiptHistory GetCoibReceipts(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetCoibReceipts(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves the full system file path to an attachment.
/// </summary>
/// <param name="candidateID">The ID of the candidate the attachment is for.</param>
/// <param name="messageID">The ID of the message the attachment is for.</param>
/// <param name="id">The ID of the attachment to retrieve.</param>
/// <returns>A system file path to the requested attachment if found; otherwise, null.</returns>
/// <remarks>A UNC file path should be returned, provided the application configuration file defines the CMO repository location as a UNC file share location.</remarks>
public string GetCmoAttachmentPath(string candidateID, int messageID, byte id)
{
using (DataClient client = new DataClient()) { return(client.GetCmoAttachmentPath(candidateID, messageID, id)); }
}
/// <summary>
/// Retrieves a generic collection of all certification documents on record for the specified candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose certification documents are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A generic List collection of all certification documents on record for the specified candidate and election cycle.</returns>
public CertificationHistory GetCertificationDocuments(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetCertificationDocuments(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves the current training tracking status for a specific candidate and election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose training tracking status is to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>The current training tracking status for the specified candidate and election cycle.</returns>
public TrainingStatus GetTrainingStatus(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetTrainingStatus(candidateID, electionCycle)); }
}
/// <summary>
/// Retrieves all authorized committees for a candidate in a specific election cycle.
/// </summary>
/// <param name="candidateID">The ID of the candidate whose authorized committees are to be retrieved.</param>
/// <param name="electionCycle">The election cycle in which to search.</param>
/// <returns>A collection of all authorized committees on record for the specified candidate and election cycle.</returns>
public AuthorizedCommittees GetAuthorizedCommittees(string candidateID, string electionCycle)
{
using (DataClient client = new DataClient()) { return(client.GetAuthorizedCommittees(candidateID, electionCycle)); }
}