Saltar al contenido principal
pdf?stylesheet=default
Blackboard Help

Arquitectura de API dirigida por eventos

Una API es una colección de clases y objetos Java que mueven datos de los sistemas de la institución a Blackboard Learn. Los datos específicos de los sistemas de la institución se encapsulan como objetos Java y los métodos contenidos en las clases Java determinan cómo se introducen los datos en Blackboard Learn. La entrada de datos la controlan almacenadores que procesan el método adecuado, convierten el objeto en datos que pueden introducirse en la base de datos de Blackboard Learn y finalmente introducen los datos según el método al que se ha llamado.

Entidades y almacenadores

Hay dos tipos principales de objetos en la API: entidades (objetos) y almacenadores (acciones). Las entidades son objetos que representan datos del sistema, como los usuarios. Los almacenadores son métodos que actúan en segundo plano y controlan el almacenamiento de las entidades en un almacén persistente o en un formato de datos temporal.

Operaciones

Todas las clases de datos tienen métodos para controlar acciones de persistencia. Se admiten las siguientes operaciones de persistencia:

  • Insertar: inserta un registro en la base de datos de Blackboard Learn.
  • Actualizar: actualiza un registro existente de la base de datos de Blackboard Learn.
  • Guardar: actualiza un registro existente si ya existe. Si no existe, lo inserta en la base de datos de Blackboard Learn.
  • Eliminar: elimina el registro de la base de datos de Blackboard Learn.
  • Cambiar clave: (persona y grupo, curso y organización) cambia la clave principal. Esto actualiza automáticamente todas las afiliaciones relacionadas con las claves cambiadas.

Cómo crear un objeto

Para crear un objeto en el sistema, cree una entidad correspondiente, defina atributos en el objeto y llame a un método de persistencia (insertar, actualizar, guardar, eliminar).

Almacenadores

La API dirigida por eventos dispone de los almacenadores siguientes:

CourseSitePersister
OrganizationPersister
EnrollmentPersister
OrganizationMembershipPersister
StaffStudentPersister
PersonPersister
CourseCategoryPersister
OrganizationCategoryPersister
CourseCategoryMembershipPersister
OrganizationCategoryMembershipPersister
PortalRolePersister

Se incluyen métodos de persistencia para cambiar la clave, insertar, eliminar, guardar, actualizar y clonar. El método para cambiar la clave no es relevante para elementos de tipo de afiliación. El método para clonar solo es relevante para el sitio del curso o la organización. Dispone de más información sobre los métodos de persistencia en las especificaciones de la API.

Cargadores

La API dirigida por eventos dispone de los cargadores siguientes:

SourseSiteLoader
OrganizationLoader
EnrollmentLoader
OrganizationMembershipLoader
StaffStudentLoader
PersonLoader
CourseCategoryLoader
OrganizationCategoryLoader
CourseCategoryMembershipLoader
OrganizationCategoryMembershipLoader
PortalRoleLoader

Los métodos de carga incluyen carga por lote_uid y por plantilla. Dispone de más información sobre los métodos de carga en las especificaciones de la API.

Almacenador y cargador del origen de datos

La API dirigida por eventos dispone del almacenador y del cargador del origen de datos siguientes:

DataSourceLoader
  loadAll()

  loadAdminObjectCount()
  loadAllAdminObjectCounts()
  loadByBatchUid()
DataSourcePersister
  create()
  disableAdminObjectsByDataType()
  disableAllAdminObjects()
  modify()
  purgeAdminObjectsByDataType()
  purgeAllAdmiObjects()
  purgeSnapshotSessions()
  removeByBatchUid()