Interface SearchResultsType
-
- All Superinterfaces:
EObject
,Notifier
- All Known Implementing Classes:
SearchResultsTypeImpl
public interface SearchResultsType extends EObject
A representation of the model object 'Search Results Type'. Includes representations of result set members if maxRecords > 0. The items must conform to one of the csw:Record views or a profile-specific representation. resultSetId - id of the result set (a URI). elementSet - The element set that has been returned (i.e., "brief", "summary", "full") recordSchema - schema reference for included records(URI) numberOfRecordsMatched - number of records matched by the query numberOfRecordsReturned - number of records returned to client nextRecord - position of next record in the result set (0 if no records remain). expires - the time instant when the result set expires and is discarded (ISO 8601 format)The following features are supported:
- See Also:
Csw20Package.getSearchResultsType()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description EList<AbstractRecordType>
getAbstractRecord()
Returns the value of the 'Abstract Record' containment reference list.FeatureMap
getAbstractRecordGroup()
Returns the value of the 'Abstract Record Group' attribute list.FeatureMap
getAny()
Returns the value of the 'Any' attribute list.ElementSetType
getElementSet()
Returns the value of the 'Element Set' attribute.Calendar
getExpires()
Returns the value of the 'Expires' attribute.BigInteger
getNextRecord()
Returns the value of the 'Next Record' attribute.BigInteger
getNumberOfRecordsMatched()
Returns the value of the 'Number Of Records Matched' attribute.BigInteger
getNumberOfRecordsReturned()
Returns the value of the 'Number Of Records Returned' attribute.String
getRecordSchema()
Returns the value of the 'Record Schema' attribute.String
getResultSetId()
Returns the value of the 'Result Set Id' attribute.boolean
isSetElementSet()
Returns whether the value of the 'Element Set
' attribute is set.void
setElementSet(ElementSetType value)
Sets the value of the 'Element Set
' attribute.void
setExpires(Calendar value)
Sets the value of the 'Expires
' attribute.void
setNextRecord(BigInteger value)
Sets the value of the 'Next Record
' attribute.void
setNumberOfRecordsMatched(BigInteger value)
Sets the value of the 'Number Of Records Matched
' attribute.void
setNumberOfRecordsReturned(BigInteger value)
Sets the value of the 'Number Of Records Returned
' attribute.void
setRecordSchema(String value)
Sets the value of the 'Record Schema
' attribute.void
setResultSetId(String value)
Sets the value of the 'Result Set Id
' attribute.void
unsetElementSet()
Unsets the value of the 'Element Set
' attribute.
-
-
-
Method Detail
-
getAbstractRecordGroup
FeatureMap getAbstractRecordGroup()
Returns the value of the 'Abstract Record Group' attribute list. The list contents are of typeFeatureMap.Entry
.If the meaning of the 'Abstract Record Group' attribute list isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Abstract Record Group' attribute list.
- See Also:
Csw20Package.getSearchResultsType_AbstractRecordGroup()
-
getAbstractRecord
EList<AbstractRecordType> getAbstractRecord()
Returns the value of the 'Abstract Record' containment reference list. The list contents are of typeAbstractRecordType
.If the meaning of the 'Abstract Record' containment reference list isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Abstract Record' containment reference list.
- See Also:
Csw20Package.getSearchResultsType_AbstractRecord()
-
getAny
FeatureMap getAny()
Returns the value of the 'Any' attribute list. The list contents are of typeFeatureMap.Entry
.If the meaning of the 'Any' attribute list isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Any' attribute list.
- See Also:
Csw20Package.getSearchResultsType_Any()
-
getElementSet
ElementSetType getElementSet()
Returns the value of the 'Element Set' attribute. The literals are from the enumerationElementSetType
.If the meaning of the 'Element Set' attribute isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Element Set' attribute.
- See Also:
ElementSetType
,isSetElementSet()
,unsetElementSet()
,setElementSet(ElementSetType)
,Csw20Package.getSearchResultsType_ElementSet()
-
setElementSet
void setElementSet(ElementSetType value)
Sets the value of the 'Element Set
' attribute.- Parameters:
value
- the new value of the 'Element Set' attribute.- See Also:
ElementSetType
,isSetElementSet()
,unsetElementSet()
,getElementSet()
-
unsetElementSet
void unsetElementSet()
Unsets the value of the 'Element Set
' attribute.
-
isSetElementSet
boolean isSetElementSet()
Returns whether the value of the 'Element Set
' attribute is set.- Returns:
- whether the value of the 'Element Set' attribute is set.
- See Also:
unsetElementSet()
,getElementSet()
,setElementSet(ElementSetType)
-
getExpires
Calendar getExpires()
Returns the value of the 'Expires' attribute.If the meaning of the 'Expires' attribute isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Expires' attribute.
- See Also:
#setExpires(XMLGregorianCalendar)
,Csw20Package.getSearchResultsType_Expires()
-
setExpires
void setExpires(Calendar value)
Sets the value of the 'Expires
' attribute.- Parameters:
value
- the new value of the 'Expires' attribute.- See Also:
getExpires()
-
getNextRecord
BigInteger getNextRecord()
Returns the value of the 'Next Record' attribute.If the meaning of the 'Next Record' attribute isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Next Record' attribute.
- See Also:
setNextRecord(BigInteger)
,Csw20Package.getSearchResultsType_NextRecord()
-
setNextRecord
void setNextRecord(BigInteger value)
Sets the value of the 'Next Record
' attribute.- Parameters:
value
- the new value of the 'Next Record' attribute.- See Also:
getNextRecord()
-
getNumberOfRecordsMatched
BigInteger getNumberOfRecordsMatched()
Returns the value of the 'Number Of Records Matched' attribute.If the meaning of the 'Number Of Records Matched' attribute isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Number Of Records Matched' attribute.
- See Also:
setNumberOfRecordsMatched(BigInteger)
,Csw20Package.getSearchResultsType_NumberOfRecordsMatched()
-
setNumberOfRecordsMatched
void setNumberOfRecordsMatched(BigInteger value)
Sets the value of the 'Number Of Records Matched
' attribute.- Parameters:
value
- the new value of the 'Number Of Records Matched' attribute.- See Also:
getNumberOfRecordsMatched()
-
getNumberOfRecordsReturned
BigInteger getNumberOfRecordsReturned()
Returns the value of the 'Number Of Records Returned' attribute.If the meaning of the 'Number Of Records Returned' attribute isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Number Of Records Returned' attribute.
- See Also:
setNumberOfRecordsReturned(BigInteger)
,Csw20Package.getSearchResultsType_NumberOfRecordsReturned()
-
setNumberOfRecordsReturned
void setNumberOfRecordsReturned(BigInteger value)
Sets the value of the 'Number Of Records Returned
' attribute.- Parameters:
value
- the new value of the 'Number Of Records Returned' attribute.- See Also:
getNumberOfRecordsReturned()
-
getRecordSchema
String getRecordSchema()
Returns the value of the 'Record Schema' attribute.If the meaning of the 'Record Schema' attribute isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Record Schema' attribute.
- See Also:
setRecordSchema(String)
,Csw20Package.getSearchResultsType_RecordSchema()
-
setRecordSchema
void setRecordSchema(String value)
Sets the value of the 'Record Schema
' attribute.- Parameters:
value
- the new value of the 'Record Schema' attribute.- See Also:
getRecordSchema()
-
getResultSetId
String getResultSetId()
Returns the value of the 'Result Set Id' attribute.If the meaning of the 'Result Set Id' attribute isn't clear, there really should be more of a description here...
- Returns:
- the value of the 'Result Set Id' attribute.
- See Also:
setResultSetId(String)
,Csw20Package.getSearchResultsType_ResultSetId()
-
setResultSetId
void setResultSetId(String value)
Sets the value of the 'Result Set Id
' attribute.- Parameters:
value
- the new value of the 'Result Set Id' attribute.- See Also:
getResultSetId()
-
-