SICApplicationDescriptor Class Reference

Inherits from	NSObject
Conforms to	SICIDescriptor
Declared in	SICApplicationDescriptor.h SICApplicationDescriptor.m

Overview

Exposes methods to GET and SET Application Descriptor information as per define in ApplicationDescriptor.xml file by application.

Example:

<siminov>

     <!-- General Application Description Properties -->

     <!-- Mandatory Field -->
     <property name="name">application_name</property>

     <!-- Optional Field -->
     <property name="description">application_description</property>

     <!-- Mandatory Field (Default is 0.0) -->
     <property name="version">application_version</property>


     <!-- Database Descriptors Used By Application (zero-to-many) -->
         <!-- Optional Field's -->
     <database-descriptors>
         <database-descriptor>full_path_of_database_descriptor_file</database-descriptor>
     </database-descriptors>


     <!-- Library Descriptors Used By Application (zero-to-many) -->
         <!-- Optional Field's -->
     <library-descriptors>
         <library-descriptor>full_path_of_library_descriptor_file</library-descriptor>
     </library-descriptors>


     <!-- Event Handlers Implemented By Application (zero-to-many) -->

         <!-- Optional Field's -->
     <event-handlers>
         <event-handler>full_class_path_of_event_handler_(ISiminovHandler/IDatabaseHandler)</event-handler>
     </event-handlers>

</siminov>

Other Methods

`– getName`

Get Application Descriptor Name as per defined in ApplicationDescriptor.xml file.

- (NSString *)getName

Return Value

Application Descriptor Name.

Discussion

Get Application Descriptor Name as per defined in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– setName:`

Set Application Descriptor Name as per defined in ApplicationDescriptor.xml file.

- (void)setName:(NSString *const)name

Parameters

`name`	Name of Application Descriptor.

Discussion

Set Application Descriptor Name as per defined in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– getDescription`

Set Description of Application as per defined in ApplicationDescriptor.xml file.

- (NSString *)getDescription

Return Value

Description of application.

Discussion

Set Description of Application as per defined in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– setDescription:`

Set Description of Application as per defined in ApplicationDescriptor.xml file.

- (void)setDescription:(NSString *const)description

Parameters

`description`	Description of application.

Discussion

Set Description of Application as per defined in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– getVersion`

Get Version of Application as per defined in ApplicationDescriptor.xml file.

- (double)getVersion

Return Value

Version of application.

Discussion

Get Version of Application as per defined in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– setVersion:`

Set Version of Application as per defined in ApplicationDescriptor.xml file.

- (void)setVersion:(double const)version

Parameters

`version`	Version of application.

Discussion

Set Version of Application as per defined in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– isDatabaseNeeded`

Check whether database needed by application or not.

- (BOOL)isDatabaseNeeded

Return Value

TRUE: If database needed by application, FALSE: If database is not needed by application.

Discussion

Check whether database needed by application or not.

Declared In

SICApplicationDescriptor.h

`– containsDatabaseDescriptor:`

Check whether database descriptor exists in Resources or not.

- (BOOL)containsDatabaseDescriptor:(SICDatabaseDescriptor *const)databaseDescriptor

Parameters

`databaseDescriptor`	Database Descriptor object.

Return Value

TRUE: If Database Descriptor exists in Resources, FALSE: If Database Descriptor does not exists in Resources.

Discussion

Check whether database descriptor exists in Resources or not.

Declared In

SICApplicationDescriptor.h

`– containsDatabaseDescriptorBasedOnPath:`

Check whether database descriptor exists in Resources or not, based on database descriptor path.

- (BOOL)containsDatabaseDescriptorBasedOnPath:(NSString *const)containDatabaseDescriptorPath

Parameters

`containDatabaseDescriptorPath`	Database Descriptor path.

Return Value

TRUE: If Database Descriptor exists in Resources, FALSE: If Database Descriptor does not exists in Resources.

Discussion

Check whether database descriptor exists in Resources or not, based on database descriptor path.

Declared In

SICApplicationDescriptor.h

`– containsDatabaseDescriptorBasedOnName:`

Check whether database descriptor exists in Resources or not, based on Database Descriptor name.

- (BOOL)containsDatabaseDescriptorBasedOnName:(NSString *const)databaseDescriptorName

Parameters

`databaseDescriptorName`	Database Descriptor Name.

Return Value

TRUE: If Database Descriptor exists in Resources, FALSE: If Database Descriptor does not exists in Resources.

Discussion

Check whether database descriptor exists in Resources or not, based on Database Descriptor name.

Declared In

SICApplicationDescriptor.h

`– getDatabaseDescriptorBasedOnName:`

Get Database Descriptor based on Database Descriptor Name.

- (SICDatabaseDescriptor *)getDatabaseDescriptorBasedOnName:(NSString *const)databaseDescriptorName

Parameters

`databaseDescriptorName`	Database Desciptor Name.

Return Value

Database Descriptor Object.

Discussion

Get Database Descriptor based on Database Descriptor Name.

Declared In

SICApplicationDescriptor.h

`– getDatabaseDescriptorBasedOnPath:`

Get Database Descriptor based on Database Descriptor Path.

- (SICDatabaseDescriptor *)getDatabaseDescriptorBasedOnPath:(NSString *const)databaseDescriptorPath

Parameters

`databaseDescriptorPath`	Database Descriptor Path.

Return Value

Database Descriptor Object.

Discussion

Get Database Descriptor based on Database Descriptor Path.

Declared In

SICApplicationDescriptor.h

`– getDatabaseDescriptorPaths`

Get all database descriptor paths as per contained in ApplicationDescriptor.xml file.

- (NSEnumerator *)getDatabaseDescriptorPaths

Return Value

Iterator which contains all database descriptor paths.

Discussion

Get all database descriptor paths as per contained in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– getDatabaseDescriptorNames`

Get all database descriptor names as per needed by application.

- (NSEnumerator *)getDatabaseDescriptorNames

Return Value

Iterator which contains all database descriptor names.

Discussion

Get all database descriptor names as per needed by application.

Declared In

SICApplicationDescriptor.h

`– addDatabaseDescriptorPath:`

Add Database Descriptor path as per contained in ApplicationDescriptor.xml file.

- (void)addDatabaseDescriptorPath:(NSString *const)databaseDescriptorPath

Parameters

`databaseDescriptorPath`	DatabaseDescriptor path.

Discussion

Add Database Descriptor path as per contained in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– getDatabaseDescriptors`

Get all database descriptor objects contains by Siminov.

- (NSEnumerator *)getDatabaseDescriptors

Return Value

Iterator which contains all database descriptor objects.

Discussion

Get all database descriptor objects contains by Siminov.

Declared In

SICApplicationDescriptor.h

`– addDatabaseDescriptor:databaseDescriptor:`

Add Database Descriptor object in respect to database descriptor path.

- (void)addDatabaseDescriptor:(NSString *const)databaseDescriptorPath databaseDescriptor:(SICDatabaseDescriptor *const)databaseDescriptor

Parameters

`databaseDescriptorPath`	Database Descriptor Path.
`databaseDescriptor`	Database Descriptor Object.

Discussion

Add Database Descriptor object in respect to database descriptor path.

Declared In

SICApplicationDescriptor.h

`– removeDatabaseDescriptorBasedOnPath:`

Remove Database Descriptor from Resources based on database path provided, as per defined in ApplicationDescriptor.xml file

- (void)removeDatabaseDescriptorBasedOnPath:(NSString *const)databaseDescriptorPath

Parameters

`databaseDescriptorPath`	Database Descriptor Path.

Discussion

Remove Database Descriptor from Resources based on database path provided, as per defined in ApplicationDescriptor.xml file

Declared In

SICApplicationDescriptor.h

`– removeDatabaseDescriptorBasedOnName:`

Remove Database Descriptor from Resources based in database name provided, as per defined in DatabaseDescriptor.xml file

- (void)removeDatabaseDescriptorBasedOnName:(NSString *const)databaseDescriptorName

Parameters

`databaseDescriptorName`	DatabaseDescriptor Name.

Discussion

Remove Database Descriptor from Resources based in database name provided, as per defined in DatabaseDescriptor.xml file

Declared In

SICApplicationDescriptor.h

`– removeDatabaseDescriptor:`

Remove DatabaseDescriptor object from Resources.

- (void)removeDatabaseDescriptor:(SICDatabaseDescriptor *const)databaseDescriptor

Parameters

`databaseDescriptor`	DatabaseDescriptor object which needs to be removed.

Discussion

Remove DatabaseDescriptor object from Resources.

Declared In

SICApplicationDescriptor.h

`– addLibraryDescriptorPath:`

Add library descriptor path

- (void)addLibraryDescriptorPath:(NSString *const)libraryDescriptorPath

Parameters

`libraryDescriptorPath`	Library Descriptor Path

Discussion

Add library descriptor path

Declared In

SICApplicationDescriptor.h

`– getLibraryDescriptorPaths`

Get all library descriptor paths

- (NSEnumerator *)getLibraryDescriptorPaths

Return Value

Library Descriptor Paths

Discussion

Get all library descriptor paths

Declared In

SICApplicationDescriptor.h

`– containLibraryDescriptorPath:`

Check whether it contains library descriptor path or not

- (BOOL)containLibraryDescriptorPath:(NSString *const)libraryDescriptorPath

Parameters

`libraryDescriptorPath`	Path of Library Descriptor

Return Value

(true/false) TRUE: If library descriptor path exists | FALSE: If library descriptor path does not exists.

Discussion

Check whether it contains library descriptor path or not

Declared In

SICApplicationDescriptor.h

`– removeLibraryDescriptorPath:`

Remove library descriptor path

- (void)removeLibraryDescriptorPath:(NSString *const)libraryDescriptorPath

Parameters

`libraryDescriptorPath`	Path of library descriptor

Discussion

Remove library descriptor path

Declared In

SICApplicationDescriptor.h

`– getEvents`

Get all event handlers as per defined in ApplicationDescriptor.xml file.

- (NSEnumerator *)getEvents

Return Value

All event handlers defined in ApplicationDescriptor.xml file

Discussion

Get all event handlers as per defined in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– addEvent:`

Add event as per defined in ApplicationDescriptor.xml file.

- (void)addEvent:(NSString *const)event

Parameters

`event`	Event Handler class name.

Discussion

Add event as per defined in ApplicationDescriptor.xml file.

Declared In

SICApplicationDescriptor.h

`– removeEvent:`

Remove event as per defined event name

- (void)removeEvent:(NSString *const)event

Parameters

`event`	Name of the event

Discussion

Remove event as per defined event name

Declared In

SICApplicationDescriptor.h

Other Methods

`– getProperties`

Get all the properties of descriptor

- (NSEnumerator *)getProperties

Return Value

All properties

Discussion

Get all the properties of descriptor

Declared In

SICIDescriptor.h

`– getProperty:`

Get the property value based on the property name

- (NSString *)getProperty:(NSString *)name

Parameters

`name`	Name of the property

Return Value

Value of the property

Discussion

Get the property value based on the property name

Declared In

SICIDescriptor.h

`– containProperty:`

Check whether property exists or not

- (bool)containProperty:(NSString *)name

Parameters

`name`	Name of the property

Return Value

(true/false) TRUE: If property exists | FALSE: If property does not exists.

Discussion

Check whether property exists or not

Declared In

SICIDescriptor.h

`– addProperty:value:`

Add property to the descriptor

- (void)addProperty:(NSString *)name value:(NSString *)value

Parameters

`name`	Name of the property
`value`	Value of the property

Discussion

Add property to the descriptor

Declared In

SICIDescriptor.h

`– removeProperty:`

Remove property from the descriptor

- (void)removeProperty:(NSString *)name

Parameters

`name`	Name of the property

Discussion

Remove property from the descriptor

Declared In

SICIDescriptor.h