API Docs for: 1.3.12
Show:

EcAlignment Class

Implementation of an alignment object with methods for interacting with CASS services on a server.

Item Index

Methods

Methods

_delete

(
  • success
  • [failure]
)

Deletes the alignment from the server corresponding to its ID

Parameters:

  • success Callback1

    Callback triggered on successfully deleting the alignment

  • [failure] Callback1 optional
                           Callback triggered if error while deleting alignment

get

(
  • id
  • success
  • [failure]
)
static

Retrieves the alignment specified with the ID from the server

Parameters:

  • id String

    ID of the alignment to retrieve

  • success Callback1

    Callback triggered on successfully retrieving the alignment, returns the alignment

  • [failure] Callback1 optional
                                Callback triggered if error while retrieving alignment

get

(
  • id
  • success
  • failure
)
static

Retrieves a concept from it's server asynchronously

Parameters:

  • id String

    ID of the concept to retrieve from the server

  • success Callback1

    Callback triggered after retrieving the concept, returns the concept retrieved

  • failure Callback1

    Callback triggered if error retrieving concept

get

(
  • id
  • success
  • failure
)
static

Retrieves a concept scheme from the server, specified by the ID

Parameters:

  • id String

    ID of the concept scheme to retrieve

  • success Callback1

    Callback triggered after successfully retrieving the concept scheme, returns the retrieved concept scheme

  • failure Callback1

    Callback triggered if an error occurs while retrieving the concept scheme

getBlocking

(
  • id
)
static

Retrieves a concept from it's server synchronously, the call blocks until it is successful or an error occurs

Parameters:

  • id String

    ID of the concept to retrieve

Returns:

EcConcept The concept retrieved

getBlocking

(
  • id
  • success
  • failure
)
static

Retrieves a concept scheme from the server in a blocking fashion, specified by the ID

Parameters:

  • id String

    ID of the concept scheme to retrieve

  • success Callback1

    Callback triggered after successfully retrieving the concept scheme, returns the retrieved concept scheme

  • failure Callback1

    Callback triggered if an error occurs while retrieving the concept scheme

getBlocking

(
  • id
)
static

Retrieves an alignment from it's server synchronously, the call blocks until it is successful or an error occurs

Parameters:

  • id String

    ID of the alignment to retrieve

Returns:

EcAlignment The alignment retrieved

save

(
  • success
  • [failure]
)

Saves this alignment details on the server corresponding to its ID

Parameters:

  • success Callback1

    Callback triggered on successfully saving the alignment

  • [failure] Callback1 optional
                           Callback triggered if error while saving alignment

searchByCompetency

(
  • repo
  • competencyId
  • success
  • [failure]
  • [paramObj]
)
static

Searches the repository for alignments with a specific ID in the target field

Parameters:

  • repo EcRepository

    Repository to search for alignments with the source specified

  • competencyId String

    ID in the target field of the alignments to find

  • success Callback1>

    Callback triggered on successful search return

  • [failure] Callback1 optional
                                       Callback triggered if error searching
  • [paramObj] Object optional
                                       Parameters to include in the search

searchBySource

(
  • repo
  • sourceId
  • success
  • [failure]
  • [paramObj]
)
static

Searches the repository for alignments with one of an array of IDs in the source field

Parameters:

  • repo EcRepository

    Repository to search for alignments with the source specified

  • sourceId String

    ID in the source field of the alignments to find

  • success Callback1>

    Callback triggered on successful search return

  • [failure] Callback1 optional
                                       Callback triggered if error searching
  • [paramObj] Object optional
                                       Parameters to include in the search

searchBySource

(
  • repo
  • sourceId
  • success
  • [failure]
  • [paramObj]
)
static

Searches the repository for alignments with a specific ID in the source field

Parameters:

  • repo EcRepository

    Repository to search for alignments with the source specified

  • sourceId String

    ID in the source field of the alignments to find

  • success Callback1>

    Callback triggered on successful search return

  • [failure] Callback1 optional
                                       Callback triggered if error searching
  • [paramObj] Object optional
                                       Parameters to include in the search

setDescription

(
  • description
)

Setter for alignment description

Parameters:

  • description String

    description to give this alignment

setName

(
  • name
)

Setter for alignment name

Parameters:

  • name String

    name to give this alignment