Click or drag to resize

ExplorerOperationsGetMasterProjects Method

Retrieves list of master projects.

Namespace:  Cobra.WebService.ClientAPI.Application.Explorer
Assembly:  Cobra.WebService.ClientAPI (in Cobra.WebService.ClientAPI.dll) Version: 8.4.717.3176 (8.4.0717.3176)
Syntax
C#
Copy
public MasterProjectCollection GetMasterProjects(
	MasterProjectsFilter masterProjectsFilter
)

Parameters

masterProjectsFilter
Type: Cobra.Model.WebServiceMasterProjectsFilter
An instance of MasterProjectsFilter class containing the filters applied to the list of master projects.

Return Value

Type: MasterProjectCollection
An instance of ProjectCollection class containing the list of projects.
Exceptions
ExceptionCondition
InvalidOperationExceptionThrown when state of the instance of the CobraServices that generated the current ExplorerOperations is not in opened state.
Examples
This example shows how to get list of master projects.
C#
Copy
using Cobra.Model.WebService;
using Cobra.WebService.ClientAPI.Application.Explorer;
using Cobra.WebService.ClientAPI.Client;

.
.
.

CobraServices cobraServices = new CobraServices();
cobraServices.ServiceIdentityData.Username = "SYSADMIN";
cobraServices.ServiceIdentityData.SecurePassword = new SecurePassword();
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('P');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('A');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('S');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('S');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('W');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('O');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('R');
cobraServices.ServiceIdentityData.SecurePassword.AppendChar('D');
cobraServices.ServiceIdentityData.DataSourceKey = "COBRA";

LoginResult loginResult = cobraServices.Login();
if (!loginResult.Success) {
    Console.WriteLine("Login failed.");
    return;
}

Console.WriteLine("Login Success.");

ExplorerOperations explorerOperations = cobraServices.CreateServiceOperations<ExplorerOperations>();
MasterProjectsFilter masterProjectsFilter = explorerOperations.CreateExplorerOperationsServiceArguments<MasterProjectsFilter>();
masterProjectsFilter.ProjectFilter = explorerOperations.CreateExplorerOperationsServiceArguments<ProjectFilter>();
masterProjectsFilter.ProjectFilter.Value = "Demos";

Console.WriteLine("Getting master projects...");
MasterProjectCollection masterProjects = explorerOperations.GetMasterProjects(masterProjectsFilter);

bool hasError = false;
foreach (ServiceMessage serviceMessage in masterProjects.GetMessages()) {
    Console.WriteLine("Message Type: {0}", serviceMessage.MessageType);
    Console.WriteLine("Message: {0}", serviceMessage.Message);

    if (serviceMessage.MessageType == MessageType.Error || serviceMessage.MessageType == MessageType.ValidationError) {
        hasError = true;
    }
}

if (!hasError) {
    foreach (MasterProject masterProject in masterProjects) {
        Console.WriteLine("Name: {0}", masterProject.Name);
        Console.WriteLine("Description: {0}", masterProject.Description);
    }

    Console.WriteLine("Getting master projects completed successfully.");
}
else
    Console.WriteLine("Getting master projects did not completed successfully.");

cobraServices.Logout();
See Also