preservica-client-root
API
Generated with
preservica-client-root/uk.gov.nationalarchives.dp.client/Entities

Entities

uk.gov.nationalarchives.dp.client.Entities
object Entities

The Entity case class with helper methods.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Entities.type

Members list

Type members

Classlikes

case class Entity(entityType: Option[EntityType], ref: UUID, title: Option[String], description: Option[String], deleted: Boolean, path: Option[String], securityTag: Option[SecurityTag], parent: Option[UUID])

A Preservica entity

A Preservica entity

Value parameters

deleted

Whether the entity is deleted

description

The description of the entity

entityType

The type of the entity

parent

The ref of the parent entity

path

The path to use in the API call url

ref

The id of the entity

securityTag

The security tag of the entity

title

The title of the entity

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class IdentifierResponse(id: String, identifierName: String, value: String)

Represents an identifier on an Entity

Represents an identifier on an Entity

Value parameters

id

The identifier id

identifierName

The identifier name

value

The identifier value

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Value members

Concrete methods

def fromType[F[_]](entityType: String, ref: UUID, title: Option[String], description: Option[String], deleted: Boolean, securityTag: Option[SecurityTag], parent: Option[UUID])(using me: MonadError[F, Throwable]): F[Entity]

Creates an entity from the IO/SO/CO type returned by Preservica

Creates an entity from the IO/SO/CO type returned by Preservica

Type parameters

F

The effect type

Value parameters

deleted

Whether the entity is deleted

description

The description of the entity

entityType

The type of the entity

me

An implicit instance of MonadError

parent

The ref of the parent entity

ref

The id of the entity

securityTag

The security tag of the entity

title

The title of the entity

Attributes

Returns

An entity wrapped in the F effect

Generated with