<SCConfigDelegate> Protocol Reference

Configuration delegate protocol. More...

#import <SCConfigDelegate.h>

Inheritance diagram for <SCConfigDelegate>:

List of all members.

Public Member Functions
(BOOL)	- config:isValidConfigForKey:
(BOOL)	- config:isValidKey:
(BOOL)	- config:isValidType:forKey:
(BOOL)	- config:isValidValue:forKey:
(BOOL)	- config:isAllowedDuplicateValueForKey:
(NSString *)	- config:keyNameForKey:
Configuration Prior Events Methods
(void)	- config:willCreateConfigForKey:
(void)	- config:willAddValue:withType:forKey:
(void)	- config:willAddValuesFromConfig:
(void)	- config:willAddValuesFromText:
(void)	- config:willSetValue:withType:forKey:
(void)	- config:willRemoveValuesForKey:
(void)	- config:willRemoveValue:forKey:
(void)	- config:willRemoveConfigForKey:
(void)	- config:willAddConfig:forKey:
(void)	- config:willSetConfig:forKey:
(void)	- willRemoveAllRecordsFromConfig:
(void)	- willAddDefaultValuesToConfig:
(void)	- willCheckMandatoryKeysForConfig:
Configuration File Prior Events Methods
(void)	- configFile:willReadFromText:
(void)	- configFile:willReadFromStream:
(void)	- configFile:willReadWithPath:
(void)	- configFile:willAppendToText:
(void)	- configFile:willAppendToPath:
(void)	- configFile:willWriteToText:
(void)	- configFile:willWriteToStream:
(void)	- configFile:willWriteToPath:
Configuration Completed Events Methods
(void)	- config:didFinishCreatingConfigForKey:
(void)	- config:didFinishAddingValue:withType:forKey:
(void)	- config:didFinishAddingValuesFromConfig:
(void)	- config:didFinishAddingValuesFromText:
(void)	- config:didFinishSettingValue:withType:forKey:
(void)	- config:didFinishRemovingValuesForKey:
(void)	- config:didFinishRemovingValue:forKey:
(void)	- config:didFinishRemovingConfigForKey:
(void)	- config:didFinishAddingConfig:forKey:
(void)	- config:didFinishSettingConfig:forKey:
(void)	- didFinishRemovingAllRecordsFromConfig:
(void)	- didFinishAddingDefaultValuesToConfig:
(void)	- didFinishCheckingMandatoryKeysForConfig:
Configuration File Completed Events Methods
(void)	- configFile:didFinishReadingFromText:
(void)	- configFile:didFinishReadingFromStream:
(void)	- configFile:didFinishReadingWithPath:
(void)	- configFile:didFinishAppendingToText:
(void)	- configFile:didFinishAppendingToPath:
(void)	- configFile:didFinishWritingToText:
(void)	- configFile:didFinishWritingToStream:
(void)	- configFile:didFinishWritingToPath:

---

Detailed Description

Configuration delegate protocol.

Protocol declares methods for events processing in the configuration classes.
Protocol was introduced in version 1.2.0.

---

Member Function Documentation

- (BOOL) config:		(SCConfig *)	config
isAllowedDuplicateValueForKey:		(NSString *)	key
			[optional]

Returns a boolean value that determines the permission of duplicating record with the specified key in the specified configuration.

Parameters:

config	- receiving configuration
key	- record key

Returns:

YES if the record with the specified key can be duplicated, otherwise NO

- (BOOL) config:		(SCConfig *)	config
isValidConfigForKey:		(NSString *)	key
			[optional]

Returns a boolean value that determines ability adding the subconfiguration with a given key to the specified configuration.

Parameters:

config	- receiving configuration
key	- subconfiguration key

Returns:

YES for ability adding the specified key, otherwise NO

- (BOOL) config:		(SCConfig *)	config
isValidKey:		(NSString *)	key
			[optional]

Returns a boolean value that indicates ability adding the record with a given key to the specified configuration.

Parameters:

config	- receiving configuration
key	- record key

Returns:

YES for ability adding the specified key, otherwise NO

- (BOOL) config:		(SCConfig *)	config
isValidType:		(SCConfigRecordType)	type
forKey:		(NSString *)	key
			[optional]

Returns a boolean value that determines ability adding the record with a given type for the specified key into the specified configuration.

Parameters:

config	- receiving configuration
type	- record type
key	- record key

- (BOOL) config:		(SCConfig *)	config
isValidValue:		(id)	value
forKey:		(NSString *)	key
			[optional]

Returns a boolean value that determines ability adding the record with a given value for the specified key into the specified configuration.

Parameters:

config	- receiving configuration
value	- record value
key	- record key

- (NSString *) config:		(SCConfig *)	config
keyNameForKey:		(NSString *)	key
			[optional]

Returns the name of the specified configuration key.

Parameters:

config	- receiving configuration
key	- existing configuration key

Returns:

Name of the specified key

---

The documentation for this protocol was generated from the following file:

• SCConfigDelegate.h