Class RepositorySearchModuleManager

Description
Description | Methods (details)

The RepositorySearchModuleManager is responcible for sending requests for search forms to the appropriate RepositorySearchModule based on their types.

  • copyright: 2004 Middlebury College
  • since: $Date: 2007/09/19 14:04:48 $
  • version: $Id: RepositorySearchModuleManager.class.php,v 1.11 2007/09/19 14:04:48 adamfranco Exp $

Located in /polyphony/main/library/RepositorySearchModules/RepositorySearchModuleManager.class.php (line 29) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

								
				

											object
										RepositorySearchModuleManager
										()
									

								
				

											void
										assignConfiguration
											(object Properties $configuration)
									

								
				

											void
										assignOsidContext
											(mixed $context, object OsidContext $context
)
									

								
				

											string
										createSearchFields
											(object Repository $repository, object $searchType, string $action)
									

								
				

											string
										createSearchForm
											(object Repository $repository, object $searchType, string $action)
									

								
				

											array
										getCurrentValues
											(object $searchType)
									

								
				

											object OsidContext
										getOsidContext
										()
									

								
				

											mixed
										getSearchCriteria
											(mixed $repository, object $searchType)
									

								
				

											array
										setCurrentValues
											(object $searchType, array $values)
									

							

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		Constructor RepositorySearchModuleManager (line 38)
	
 
	
	

Constructor, set up the relations of the Types to Modules

	
    
				
  • since: 10/19/04
    • 
				
  • access: public
    • 
			

	
	

		object
		
			RepositorySearchModuleManager
		
				()
			

	
		
		
	




	
	

		assignConfiguration (line 70)
	
 
	
	

Assign the configuration of this Manager. Valid configuration options are as


follows: 	database_index			integer 	database_name			string

	
    
				
  • access: public
    • 
				
  • throws: object OsidException An exception with one of the following            messages defined in org.osid.OsidException:    OPERATION_FAILED,            PERMISSION_DENIED, CONFIGURATION_ERROR, UNIMPLEMENTED, NULL_ARGUMENT
    • 
			

	
	

		void
		
			assignConfiguration
		
					(object Properties $configuration)
			

	
			
    
					
  • 
				object Properties
				$configuration: (original type: java.util.Properties)			
    • 
				

		
		
	




	
	

		assignOsidContext (line 98)
	
 
	
	

Assign the context of this OsidManager.

	
    
				
  • access: public
    • 
				
  • throws: object OsidException An exception with one of the following            messages defined in org.osid.OsidException:    NULL_ARGUMENT
    • 
			

	
	

		void
		
			assignOsidContext
		
					(mixed $context, object OsidContext $context
)
			

	
			
    
					
  • 
				object OsidContext
				$context
			
    • 
				

		
		
	




	
	

		createSearchFields (line 138)
	
 
	
	

Create a form for searching.

	
    
				
  • since: 10/19/04
    • 
				
  • access: public
    • 
			

	
	

		string
		
			createSearchFields
		
					(object Repository $repository, object $searchType, string $action)
			

	
			
    
					
  • 
				object Repository
				$repository			
    • 
					
  • 
				object
				$searchType			
    • 
					
  • 
				string
				$action: The destination on form submit.			
    • 
				

		
		
	




	
	

		createSearchForm (line 112)
	
 
	
	

Create a form for searching.

	
    
				
  • since: 10/19/04
    • 
				
  • access: public
    • 
			

	
	

		string
		
			createSearchForm
		
					(object Repository $repository, object $searchType, string $action)
			

	
			
    
					
  • 
				object Repository
				$repository			
    • 
					
  • 
				object
				$searchType			
    • 
					
  • 
				string
				$action: The destination on form submit.			
    • 
				

		
		
	




	
	

		getCurrentValues (line 182)
	
 
	
	

Get an array of the current values to be added to a url. The keys of the  arrays are the field-names in the appropriate context.

	
    
				
  • since: 10/28/04
    • 
				
  • access: public
    • 
			

	
	

		array
		
			getCurrentValues
		
					(object $searchType)
			

	
			
    
					
  • 
				object
				$searchType			
    • 
				

		
		
	




	
	

		getOsidContext (line 83)
	
 
	
	

Return context of this OsidManager.

	
    
				
  • access: public
    • 
				
  • throws: object OsidException
    • 
			

	
	

		object OsidContext
		
			getOsidContext
		
				()
			

	
		
		
	




	
	

		getSearchCriteria (line 160)
	
 
	
	

Get the formatted search terms based on the submissions of the form

	
    
				
  • since: 10/28/04
    • 
				
  • access: public
    • 
			

	
	

		mixed
		
			getSearchCriteria
		
					(mixed $repository, object $searchType)
			

	
			
    
					
  • 
				object
				$searchType			
    • 
				

		
		
	




	
	

		setCurrentValues (line 206)
	
 
	
	

Update the current values with data (maybe stored in the session for instance.


The keys of the arrays are the field-names in the appropriate context.  This could have been originally fetched via getCurrentValues

	
    
				
  • since: 10/28/04
    • 
				
  • access: public
    • 
			

	
	

		array
		
			setCurrentValues
		
					(object $searchType, array $values)
			

	
			
    
					
  • 
				object
				$searchType			
    • 
					
  • 
				array
				$values			
    • 
				

		
		
	

						
		

	



	

		Documentation generated on Wed, 19 Sep 2007 10:26:02 -0400 by phpDocumentor 1.3.0RC3