Retrieve Table Reference for Passport


Use Case ID: RetrievePassportTableReference
Classification: Value | Reference | TableReference
Version: 1.1.0
Extends: RetrieveTableReference
Description:
	
	This use case returns TableReference object consisting of a url which points to a csv file that contains passport data.
	

	Each such simple feature contains one search criterion. The
	ID and the name of the simple feature is left blank (or ignored by the
	data source), and the ID of the feature type specifies an ontology term
	whose value is in the feature's valueString. The term's ID and the
	valueString establish what to search for.

	It is possible to specify more simple features as search criteria.


	The option "wantedFeatures" contains a comma-separated list of
	ontology terms (their IDs) that are wanted by the data source user. If
	not used, the number of returned features is decided by the data
	source itself. Using this option allows to limit the size of returned
	data only to those wanted by the user.
	
	The option "FILEPATH" is inherited from the parent usecase. This will contain the directory on where
	the datasource user wants to save the csv file that will be created. If "FILEPATH" option is not specified,
	default directory for temporary files will be used. This option allows the user to choose which directory the
	csv files will be saved.

		
        

Datatype: TableReference
Referenceorg.generationcp.ontology.core.value.TabularDataReferenceBaseConstants.DATATYPE_ID
NameTableReference
				Simple Reference that has url information of a file that is in CSV.
			
At least one searchable attribute must be used

Searchable Attributes
Referenceorg.generationcp.ontology.core.value.TabularDataBaseConstants.COLUMN_HEADER_LIST_DATATYPE_ATTRIBUTE_ID +
org.generationcp.core.ontology.LSID.ATTRIBUTE_DELIMITER +
org.generationcp.ontology.core.feature.SimpleFeatureBaseConstants.TYPE_DATATYPE_ATTRIBUTE_ID
NameSimple Feature object
Operatorsorg.generationcp.core.ontology.Operator.EQUAL
org.generationcp.core.ontology.Operator.IN
org.generationcp.core.ontology.Operator.GT
org.generationcp.core.ontology.Operator.LT
					The uniqueIdentifier and the name of this attribute is left blank (or
					ignored by the data source), and the ID of this feature type specifies
					an ontology term whose value is in the feature's valueString. The
					term's ID and the valueString establish what to search for.
		
					If a search filter contains more values (of type SimpleFeature) then
					all of them should be "of the same kind" - meaning that all of them
					should have the same type's ID.

					If there are more search filters, each of them should contain only
					features with different type's IDs.

					The search value (a field "valueString" of the SimpleFeature) can
					contain a star. The star is treated literally if the operator "EQUAL"
					is used, and it is treated as a wild-character if the operator "LIKE"
					is used. The latter means a case- and accent- insensitive search, as
					well.
        		  		

Available Attributes
All

General Options
ValueID
put here a comma-separated list of ontology terms identifying featureswantedFeatures