All Classes Namespaces Functions Properties Pages
Public Member Functions | List of all members
CaptureSolutionService Class Reference

Provides methods to manage capture solutions More...

Public Member Functions

CaptureSolutionSummaryCollection GetCaptureSolutions (string sessionId, CaptureSolutionFilter captureSolutionFilter)
 Gets a collection of capturesolution summaries. More...
 
CaptureSolutionValidationResult ValidateCaptureSolutionName (string sessionId, string captureSolutionName, string captureSolutionId, ClassificationGroupIdentity classificationGroupIdentity)
 Validates Capture Solution name entered by user and if invalid then returns a collection of Artefact types with matching name. More...
 

Description

Provides methods to manage capture solutions

Member Functions

CaptureSolutionSummaryCollection GetCaptureSolutions ( string  sessionId,
CaptureSolutionFilter  captureSolutionFilter 
)

Gets a collection of capturesolution summaries.

Parameters
sessionIdA string that uniquely identifies the session for the current logged on user. If the sessionID is invalid then an exception will be raised.
captureSolutionFilterA filter with category identity and search text members to filter list of solutions returned.
Name Type Comment Required
CategoryIdentity If populated, gets capture solutions within this category. No
SearchText String If set, performs search on name of capture solution and returns those matching or part matching No
Status Int16 Value to return published or unpublished capture solutions No
Returns
A collection of type CaptureSolutionSummaryCollection, which holds the summaries of the capture solutions.
CaptureSolutionValidationResult ValidateCaptureSolutionName ( string  sessionId,
string  captureSolutionName,
string  captureSolutionId,
ClassificationGroupIdentity  classificationGroupIdentity 
)

Validates Capture Solution name entered by user and if invalid then returns a collection of Artefact types with matching name.

Parameters
sessionIdA string that uniquely identifies the session for the current logged on user. If the sessionID is invalid then an exception will be raised.
captureSolutionNameEntered name for new Capture Solution
captureSolutionIdEntered name for new Capture Solution Id
classificationGroupIdentityThe ClassificationGroup Identity
Returns
CaptureSolutionValidationResult collection of Artefact types with matching name entered for Capture Solution and isValid flag