Interface Salient\Contract\Sync\SyncEntityInterface

`extends`	`HasId, HasName, ProvidableEntityInterface<SyncProviderInterface, SyncContextInterface>, Relatable, JsonSerializable`

Represents the state of an entity in an external system

Salient\Contract\Sync\SyncEntityInterface extends HasId, HasName, ProvidableEntityInterface<SyncProviderInterface, SyncContextInterface>, Relatable, JsonSerializable
- Salient\Sync\AbstractSyncEntity implements SyncEntityInterface, NormaliserFactory uses ConstructibleTrait, HasReadableProperties, HasWritableProperties, ExtensibleTrait, ProvidableTrait, HasNormaliser, RequiresContainer

Located at Toolkit/Contract/Sync/SyncEntityInterface.php

Methods
`public static`	`getDefaultProvider(ContainerInterface $container): SyncProviderInterface` Get the entity's default provider Get the entity's default provider Implemented by `Salient\Sync\AbstractSyncEntity::getDefaultProvider()`	#
`public static`	`withDefaultProvider( ContainerInterface $container, ?SyncContextInterface $context = null, ): SyncEntityProviderInterface<static>` Perform sync operations on the entity using its default provider Perform sync operations on the entity using its default provider Implemented by `Salient\Sync\AbstractSyncEntity::withDefaultProvider()`	#
`public static`	`getSerializeRules(): SyncSerializeRulesInterface<static>` Get the entity's serialization rules Get the entity's serialization rules Implemented by `Salient\Sync\AbstractSyncEntity::getSerializeRules()`	#
`public static`	`getPlural(): ?string` Get the plural form of the entity's unqualified name Get the plural form of the entity's unqualified name If this method returns a value other than `null`, an empty string, or the unqualified name of the entity, it may be used to identify provider methods that implement sync operations on the entity. For example, if `Faculty::getPlural()` returns `null`, a provider may implement `Faculty` sync operations via one or more of the following: `create_faculty()` `get_faculty()` `update_faculty()` `delete_faculty()` `createList_faculty()` `getList_faculty()` `updateList_faculty()` `deleteList_faculty()` If the same method returns `"Faculties"`, these are also recognised as `Faculty` sync implementations: `createFaculty()` `getFaculty()` `updateFaculty()` `deleteFaculty()` `createFaculties()` `getFaculties()` `updateFaculties()` `deleteFaculties()` Implemented by `Salient\Sync\AbstractSyncEntity::getPlural()`	#
`public`	`getId()` Get the unique identifier assigned to the entity by its provider Get the unique identifier assigned to the entity by its provider	#
`public`	`getCanonicalId(): int\|string\|null` Get the unique identifier assigned to the entity by its canonical backend Get the unique identifier assigned to the entity by its canonical backend If a provider is bound to the service container as the default implementation of the entity's underlying provider interface, it is regarded as its canonical backend. To improve the accuracy and performance of sync operations, providers should propagate this value to and from backends capable of storing it. Implemented by `Salient\Sync\AbstractSyncEntity::getCanonicalId()`	#
`public`	`getName(): string` Get the name of the entity Get the name of the entity	#
`public static`	`idFromNameOrId( int\|string\|null $nameOrId, SyncProviderInterface\|SyncContextInterface $providerOrContext, ?float $uncertaintyThreshold = null, ?string $nameProperty = null, ?float &$uncertainty = null, ): int\|string\|null` Resolve a name or entity ID to the entity ID of one matching entity Resolve a name or entity ID to the entity ID of one matching entity Returns: `null` if `$nameOrId` is `null` `$nameOrId` if it is a valid identifier for the entity in the given provider (see {@see SyncProviderInterface::isValidIdentifier()}), or the entity ID of the entity to which `$nameOrId` resolves A {@see SyncEntityNotFoundExceptionInterface} is thrown if: there are no matching entities, or there are multiple matching entities Implemented by `Salient\Sync\AbstractSyncEntity::idFromNameOrId()`	#
`public`	`toArray(?SyncStoreInterface $store = null): array<string, mixed>` Serialize the entity and any nested entities Serialize the entity and any nested entities Rules returned by {@see SyncEntityInterface::getSerializeRules()} are used. Implemented by `Salient\Sync\AbstractSyncEntity::toArray()`	#
`public`	`toArrayWith(SyncSerializeRulesInterface<static> $rules, ?SyncStoreInterface $store = null): array<string, mixed>` Use the given serialization rules to serialize the entity and any nested entities Use the given serialization rules to serialize the entity and any nested entities Implemented by `Salient\Sync\AbstractSyncEntity::toArrayWith()`	#
`public`	`toLink( ?SyncStoreInterface $store = null, SyncEntityLinkType::* $type = SyncEntityLinkType::DEFAULT, bool $compact = true, ): array<string, int\|string>` Get the entity's canonical location in the form of an array Get the entity's canonical location in the form of an array Inspired by JSON-LD. Implemented by `Salient\Sync\AbstractSyncEntity::toLink()`	#
`public`	`getUri(?SyncStoreInterface $store = null, bool $compact = true): string` Get the entity's canonical location in the form of a URI Get the entity's canonical location in the form of a URI Inspired by OData. Implemented by `Salient\Sync\AbstractSyncEntity::getUri()`	#

Methods inherited from Salient\Contract\Core\Normalisable
`normalise()`

Methods inherited from Salient\Contract\Core\Constructible
`construct(), constructList()`

Methods inherited from Salient\Contract\Core\Readable
`getReadableProperties(), __get(), __isset()`

Methods inherited from Salient\Contract\Core\Writable
`getWritableProperties(), __set(), __unset()`

Methods inherited from Salient\Contract\Core\Extensible
`setMetaProperty(), getMetaProperty(), isMetaPropertySet(), unsetMetaProperty(), getMetaProperties(), clearMetaProperties(), __set(), __get(), __isset(), __unset()`

Methods inherited from Salient\Contract\Core\Temporal
`getDateProperties()`

Methods inherited from Salient\Contract\Core\Providable
`provide(), provideList(), postLoad()`

Methods inherited from Salient\Contract\Core\ProviderAwareInterface
`setProvider()`

Methods inherited from Salient\Contract\Core\HasProvider
`getProvider()`

Methods inherited from Salient\Contract\Container\ServiceAwareInterface
`setService(), getService()`

Methods inherited from Salient\Contract\Core\ProviderContextAwareInterface
`setContext(), getContext()`

Methods inherited from Salient\Contract\Core\Relatable
`getRelationships()`

Methods inherited from JsonSerializable
`jsonSerialize()`