interface SolrDocumentDefinitionInterface in Search API Solr 4.x

Interface for typed data Solr document definitions.

Hierarchy

• interface \Drupal\Core\TypedData\DataDefinitionInterface
  • interface \Drupal\Core\TypedData\ComplexDataDefinitionInterface
    • interface \Drupal\search_api_solr\TypedData\SolrDocumentDefinitionInterface

File

src/TypedData/SolrDocumentDefinitionInterface.php, line 10

Namespace

Drupal\search_api_solr\TypedData

interface SolrDocumentDefinitionInterface extends ComplexDataDefinitionInterface {

  /**
   * Gets the Search API Index ID.
   *
   * @return string|null
   *   The Index ID, or NULL if the Index is unknown.
   */
  public function getIndexId();

  /**
   * Sets the Search API Index ID.
   *
   * @param string $index_id
   *   The Server ID to set.
   *
   * @return $this
   */
  public function setIndexId(string $index_id);

}

Members

Name	Modifiers	Type	Description	Overrides
ComplexDataDefinitionInterface::getMainPropertyName	public	function	Returns the name of the main property, if any.	2
ComplexDataDefinitionInterface::getPropertyDefinition	public	function	Gets the definition of a contained property.	2
ComplexDataDefinitionInterface::getPropertyDefinitions	public	function	Gets an array of property definitions of contained properties.	2
DataDefinitionInterface::addConstraint	public	function	Adds a validation constraint.	2
DataDefinitionInterface::createFromDataType	public static	function	Creates a new data definition object.	2
DataDefinitionInterface::getClass	public	function	Returns the class used for creating the typed data object.	2
DataDefinitionInterface::getConstraint	public	function	Returns a validation constraint.	2
DataDefinitionInterface::getConstraints	public	function	Returns an array of validation constraints.	2
DataDefinitionInterface::getDataType	public	function	Returns the data type of the data.	2
DataDefinitionInterface::getDescription	public	function	Returns a human readable description.	2
DataDefinitionInterface::getLabel	public	function	Returns a human readable label.	2
DataDefinitionInterface::getSetting	public	function	Returns the value of a given setting.	2
DataDefinitionInterface::getSettings	public	function	Returns the array of settings, as required by the used class.	2
DataDefinitionInterface::isComputed	public	function	Determines whether the data value is computed.	3
DataDefinitionInterface::isInternal	public	function	Determines whether the data value is internal.	2
DataDefinitionInterface::isList	public	function	Returns whether the data is multi-valued, i.e. a list of data items.	2
DataDefinitionInterface::isReadOnly	public	function	Determines whether the data is read-only.	3
DataDefinitionInterface::isRequired	public	function	Determines whether a data value is required.	2
SolrDocumentDefinitionInterface::getIndexId	public	function	Gets the Search API Index ID.	1
SolrDocumentDefinitionInterface::setIndexId	public	function	Sets the Search API Index ID.	1