Skip to content

Commit

Permalink
Review XML comments for exceptions DynamicsValue/fake-xrm-easy#157
Browse files Browse the repository at this point in the history
  • Loading branch information
jordimontana82 committed Aug 10, 2024
1 parent 5c6158b commit 376c0ff
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,17 @@

namespace FakeXrmEasy.Core.Exceptions.Query.FetchXml
{
/// <summary>
/// Exception raised in a query when an attribute value type could not be determined correctly
/// </summary>
public class ArithmeticTypeConversionException: Exception
{
public ArithmeticTypeConversionException(string entityName, string attributeName) :
/// <summary>
/// Default constructor
/// </summary>
/// <param name="entityName"></param>
/// <param name="attributeName"></param>
internal ArithmeticTypeConversionException(string entityName, string attributeName) :
base($"When using arithmetic values in a condition of attribute '{attributeName}' of entity '{entityName}' in a Fetch a ProxyTypesAssembly must be used in order to know which types to cast values to. If you are using early bound types, please make sure the early bound type was generated for entity '{entityName}'")
{

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@

namespace FakeXrmEasy.Core.FileStorage.Db.Exceptions
{
/// <summary>
/// Internal exception used for internal testing only thrown when a file could not be added to the InMemoryFileDb
/// </summary>
public class CouldNotAddFileException: Exception
{
public CouldNotAddFileException(): base("A file could not be added")
/// <summary>
/// Default constructor
/// </summary>
internal CouldNotAddFileException(): base("A file could not be added")
{

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ namespace FakeXrmEasy.Core.FileStorage.Db.Exceptions
/// </summary>
public class CouldNotCommitFileException: Exception
{
public CouldNotCommitFileException(string fileUploadContinuationToken) : base($"The file associated to continuation token '{fileUploadContinuationToken}' could not be committed due to an unknown error")
/// <summary>
/// Default constructor
/// </summary>
/// <param name="fileUploadContinuationToken"></param>
internal CouldNotCommitFileException(string fileUploadContinuationToken) : base($"The file associated to continuation token '{fileUploadContinuationToken}' could not be committed due to an unknown error")
{

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public class DuplicateFileBlockException: Exception
/// </summary>
/// <param name="blockId">The block Id that already existed</param>
/// <param name="fileUploadSessionId">The Id of the FileUploadSession where that block existed</param>
public DuplicateFileBlockException(string blockId, string fileUploadSessionId) : base($"A block was already uploaded with Id {blockId} against the current file continuation token: {fileUploadSessionId}")
internal DuplicateFileBlockException(string blockId, string fileUploadSessionId) : base($"A block was already uploaded with Id {blockId} against the current file continuation token: {fileUploadSessionId}")
{

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public class FileToDownloadNotFoundException: Exception
/// </summary>
/// <param name="entityReference">An entity reference of the record</param>
/// <param name="fileAttributeName">The column where a file was not found</param>
public FileToDownloadNotFoundException(EntityReference entityReference, string fileAttributeName)
internal FileToDownloadNotFoundException(EntityReference entityReference, string fileAttributeName)
: base($"A file was not found for record with logical name '{entityReference.LogicalName}' and Id '{entityReference.Id.ToString()}' in column '{fileAttributeName}'")
{

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ namespace FakeXrmEasy.Core.FileStorage.Db.Exceptions
{
public class FileTokenContinuationNotFoundException: Exception

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2013)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2013)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_9)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_9)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_365)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_365)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2016)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2016)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2015)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'

Check warning on line 5 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/FileTokenContinuationNotFoundException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2015)

Missing XML comment for publicly visible type or member 'FileTokenContinuationNotFoundException'
{
public FileTokenContinuationNotFoundException(string fileContinuationTokenId)
internal FileTokenContinuationNotFoundException(string fileContinuationTokenId)
: base($"The file continuation token with Id '{fileContinuationTokenId}' could not be found or has already been committed")
{

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public class InvalidBlockLengthException: Exception
/// <summary>
/// Default constructor
/// </summary>
public InvalidBlockLengthException() : base($"The BlockLength property must be greater than zero.")
internal InvalidBlockLengthException() : base($"The BlockLength property must be greater than zero.")
{

}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public class MaxSizeExceededException: Exception
/// </summary>
/// <param name="logicalName">The table with the column that has the max file size limitation</param>
/// <param name="attributeName">The column with the max file size limitation</param>
public MaxSizeExceededException(string logicalName, string attributeName, int currentMaxSize) :
internal MaxSizeExceededException(string logicalName, string attributeName, int currentMaxSize) :

Check warning on line 15 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/MaxSizeExceededException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY)

Parameter 'currentMaxSize' has no matching param tag in the XML comment for 'MaxSizeExceededException.MaxSizeExceededException(string, string, int)' (but other parameters do)

Check warning on line 15 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/MaxSizeExceededException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2013)

Parameter 'currentMaxSize' has no matching param tag in the XML comment for 'MaxSizeExceededException.MaxSizeExceededException(string, string, int)' (but other parameters do)

Check warning on line 15 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/MaxSizeExceededException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_9)

Parameter 'currentMaxSize' has no matching param tag in the XML comment for 'MaxSizeExceededException.MaxSizeExceededException(string, string, int)' (but other parameters do)

Check warning on line 15 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/MaxSizeExceededException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_365)

Parameter 'currentMaxSize' has no matching param tag in the XML comment for 'MaxSizeExceededException.MaxSizeExceededException(string, string, int)' (but other parameters do)

Check warning on line 15 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/MaxSizeExceededException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_365)

Parameter 'currentMaxSize' has no matching param tag in the XML comment for 'MaxSizeExceededException.MaxSizeExceededException(string, string, int)' (but other parameters do)

Check warning on line 15 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/MaxSizeExceededException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2016)

Parameter 'currentMaxSize' has no matching param tag in the XML comment for 'MaxSizeExceededException.MaxSizeExceededException(string, string, int)' (but other parameters do)

Check warning on line 15 in src/FakeXrmEasy.Core/FileStorage/Db/Exceptions/MaxSizeExceededException.cs

View workflow job for this annotation

GitHub Actions / build-windows (FAKE_XRM_EASY_2015)

Parameter 'currentMaxSize' has no matching param tag in the XML comment for 'MaxSizeExceededException.MaxSizeExceededException(string, string, int)' (but other parameters do)
base($"Could not commit the file upload because the sum of the block sizes exceeds the current allowed max file size of {currentMaxSize.ToString()}KB for column '{attributeName}' in table '{logicalName}'")
{

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ namespace FakeXrmEasy.Core.FileStorage.Db.Exceptions
/// </summary>
public class RecordNotFoundException: Exception
{
public RecordNotFoundException(EntityReference reference) : base($"The entity reference record for logical name '{reference.LogicalName}' and '{reference.Id}' does not exist.")
/// <summary>
/// Default constructor
/// </summary>
/// <param name="reference"></param>
internal RecordNotFoundException(EntityReference reference) : base($"The entity reference record for logical name '{reference.LogicalName}' and '{reference.Id}' does not exist.")
{

}
Expand Down

0 comments on commit 376c0ff

Please sign in to comment.