FRAModelsFromDatabase.h revision 7c51d54f23c5581d2cf894f9eafb9798e3febd22
1008N/A/*
1008N/A * The contents of this file are subject to the terms of the Common Development and
1008N/A * Distribution License (the License). You may not use this file except in compliance with the
1008N/A * License.
1008N/A *
1008N/A * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
1008N/A * specific language governing permission and limitations under the License.
1008N/A *
1008N/A * When distributing Covered Software, include this CDDL Header Notice in each file and include
1008N/A * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
1008N/A * Header, with the fields enclosed by brackets [] replaced by your own identifying
1008N/A * information: "Portions copyright [year] [name of copyright owner]".
1008N/A *
1008N/A * Copyright 2016 ForgeRock AS.
1008N/A */
1008N/A
1008N/A@class FRAIdentity;
1008N/A@class FRAFMDatabaseConnectionHelper;
1008N/A
1008N/A/*!
1008N/A * Defines all configuration needed to locate the SQLite Database.
1008N/A */
1008N/A@interface FRAModelsFromDatabase : NSObject
1008N/A
1008N/A/*!
1008N/A * Read all Identities, Mechanisms and Notifications from the database
1008N/A * and generate the object tree.
1008N/A *
1008N/A * @param sqlDatabase The SQL Database to read the identities from.
1008N/A * @param identityDatabase Assigned to the model objects created.
1008N/A * @param identityModel The identity model which contains the list of identities.
1008N/A * @param error If an error occurs, upon returns contains an NSError object that describes the problem. If you are not interested in possible errors, you may pass in NULL.
1008N/A * @return A non null, possibly empty list of FRAIdentity read from the database.
1008N/A */
1008N/A+ (NSArray<FRAIdentity*> *)getAllIdentitiesFrom:(FRAFMDatabaseConnectionHelper *)sqlDatabase including:(FRAIdentityDatabase *)identityDatabase identityModel:(FRAIdentityModel *)identityModel catchingErrorsWith:(NSError *__autoreleasing *)error;
1008N/A
1008N/A@end