PublisherController XML Documentation Report

Summary:
Initializes a new instance of the class with injected dependencies.

Parameter: publisherInfo
Service to handle publisher-related business logic.

Exception: T:System.ArgumentNullException
Thrown if required service or config is null.

Summary:
Writes a warning-level log entry using Splunk logging configuration.
This method standardizes logging across all controller methods for consistency and maintainability.

Parameter: methodName
The name of the method where the warning occurred.

Parameter: message
The specific warning message or context to log.

Summary:
Retrieves all available service records from the publisher information source.

Returns:
An HTTP 200 OK response containing the list of services if available;
otherwise, returns an HTTP 200 OK response with a message indicating no services were found.

Summary:
Adds a new publisher record to the system.

Parameter: publisherInfo
The publisher information object received from the request body.

Returns:
Returns an HTTP 200 OK response with the result if the operation succeeds;
returns HTTP 400 Bad Request if the input is null;
returns HTTP 404 Not Found if the publisher could not be added.

Summary:
Adds a new service to the system.

Parameter: service
The service object to be added.

Returns:
Returns 200 OK with the created service on success,
400 Bad Request if the input is null,
or 404 Not Found if the addition fails.

Summary:
Adds a list of subservices to an existing service.

Parameter: subservices
List of subservice objects.

Parameter: serviceId
The ID of the parent service.

Returns:
Returns 200 OK if subservices are added successfully,
400 Bad Request if input is invalid,
or 404 Not Found if the operation fails.

Summary:
Retrieves publisher details by publisher ID.

Parameter: publisherId
The ID of the publisher to retrieve.

Returns:
Returns 200 OK with publisher data if found,
400 Bad Request if ID is invalid,
or 404 Not Found if not found.

Summary:
Retrieves all publisher records with pagination.

Parameter: pagination
Pagination settings including page number and size.

Returns:
Returns 200 OK with paginated data,
400 Bad Request if pagination object is null,
or 404 Not Found if no records are found.

Summary:
Marks a publisher as active.

Parameter: id
Publisher ID to activate.

Parameter: modifiedById
ID of the user performing the operation.

Returns:
Returns 200 OK on success,
400 Bad Request if IDs are invalid,
or 404 Not Found if the operation fails.

Summary:
Marks a publisher as inactive.

Parameter: id
Publisher ID to deactivate.

Parameter: modifiedById
ID of the user performing the operation.

Returns:
Returns 200 OK on success,
400 Bad Request if IDs are invalid,
or 404 Not Found if the operation fails.

Summary:
Searches publisher dashboard data based on a search query.

Parameter: search
Search keyword.

Returns:
Returns 200 OK with matching records,
or 404 Not Found if no match is found.

Summary:
Retrieves detailed publisher information for view-only purposes.

Parameter: publisherId
The ID of the publisher.

Returns:
Returns 200 OK with detailed data,
400 Bad Request if the ID is invalid,
or 404 Not Found if no data is available.

Summary:
Retrieves all publisher data without pagination.

Returns:
Returns 200 OK with data,
or 404 Not Found if no records are found.

Summary:
Helper method to handle null-check and standard response wrapping.

Parameter: response
The object to check and return.

Parameter: failureMessage
Message to return if the object is null.

Returns:
Returns 200 OK if the object is not null,
otherwise returns 404 Not Found with the provided failure message.

Summary:
Deletes a service by its ID.

Parameter: serviceId
The unique identifier of the service to delete.

Returns:
Returns 200 OK if the service was successfully deleted,
400 Bad Request if the provided service ID is invalid,
or 404 Not Found if the deletion operation fails.

Summary:
Deletes a subservice by its ID.

Parameter: subServiceId
The unique identifier of the subservice to delete.

Returns:
Returns 200 OK if the subservice was successfully deleted,
400 Bad Request if the provided subServiceId is invalid,
or 404 Not Found if the deletion operation fails or the subservice does not exist.

Summary:
Updates an existing service based on the provided base entity data.

Parameter: baseEntity
The service entity containing the updated values.
Must include a valid Id (greater than 0) and a non-empty Name.

Returns:
Returns 200 OK if the update is successful,
400 Bad Request if the input data is invalid,
or 404 Not Found if the update operation fails or the service does not exist.

Summary:
Updates an existing subservice with the provided data.

Parameter: baseEntity
The subservice entity containing updated details.
Must include a valid Id (greater than 0) and a non-empty Name.

Returns:
Returns:
- 200 OK with the update result if successful,
- 400 Bad Request if the input data is invalid,
- 404 Not Found if the update operation fails or the subservice does not exist.

Summary:
Checks for the uniqueness of a publisher based on the provided criteria.

Parameter: dto
A object containing the data required to perform the uniqueness check.
Must not be null.

Returns:
Returns:
- 200 OK with the result of the uniqueness check if successful,
- 400 Bad Request if the input DTO is null,
- 404 Not Found if the operation fails or no matching result is found.

Summary:
Retrieves publisher data specifically for journal information purposes.

Returns:
Returns:
- 200 OK with the list of publisher data if found,
- 200 OK with a "Publisher Data not Found" message if no data exists.

Summary:
Performs an advanced search for publishers based on the given search criteria DTO.

Parameter: dto
Data transfer object containing the advanced search criteria.
Must not be null.

Returns:
Returns:
- 200 OK with the search results if found,
- 400 Bad Request if the input DTO is null,
- 404 Not Found if no matching results are found.

Summary:
Adds column information for a publisher based on the provided DTO.

Parameter: dto
Data transfer object containing column information.
The ColumnName property must not be null or empty.

Returns:
Returns:
- 200 OK with the operation result if successful,
- 400 Bad Request if the ColumnName is null or empty,
- 404 Not Found if the add operation fails.

Summary:
Retrieves filter names associated with a specific user and module for publishers.

Parameter: userId
The ID of the user requesting the filters. Must be a positive integer.

Parameter: module
The module name for which the filters are requested. Cannot be null or whitespace.

Returns:
Returns:
- 200 OK with the list of filter names if successful,
- 400 Bad Request if the is invalid or is null or empty,
- 404 Not Found if no filters are found or the operation fails.

Summary:
Deletes a specific column filter associated with a publisher identified by the given filter ID.

Parameter: filterId
The ID of the filter column to be deleted. Must be a positive integer.

Returns:
Returns:
- 200 OK if the deletion is successful,
- 400 Bad Request if the provided is invalid (less than or equal to zero),
- 404 Not Found if the deletion operation fails or the filter is not found.

Summary:
Retrieves the Account Manager's email ID associated with the given publisher name.

Parameter: publisherName
The name of the publisher whose Account Manager's email is requested. Cannot be null or empty.

Returns:
Returns:
- 200 OK with the Account Manager's email if found,
- 400 Bad Request if is null, empty, or whitespace,
- 404 Not Found if no Account Manager email is found for the specified publisher.

Summary:
Deletes all draft publisher-related data associated with the specified publisher ID.

Parameter: publisherId
The unique identifier of the publisher whose draft data is to be deleted. Must be greater than zero.

Returns:
Returns:
- 200 OK if the delete operation succeeds,
- 400 Bad Request if the is invalid (less than or equal to zero),
- 404 Not Found if the delete operation fails or no matching data is found.