API Docs for: 1.3.12
Show:

EcFramework Class

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

Methods

_delete

(
  • success
  • failure
)

Deletes this framework from the server specified by it's ID

Parameters:

  • success Callback1

    Callback triggered if successfully deleted framework

  • failure Callback1

    Callback triggered if error occurs when deleting the framework

addCompetency

(
  • id
)

Adds the competency ID specified to the frameworks list of competency IDs

Parameters:

  • id String

    ID of the competency to add

addLevel

(
  • id
)

Adds a level ID to the framework's list of levels

Parameters:

  • id String

    ID of the level to add to framework's list

addRelation

(
  • id
)

Adds a relation ID to the framework's list of relations

Parameters:

  • id String

    ID to add to the framework's relation list

addRollupRule

(
  • id
)

Adds a rollup rule ID to the framework's list of rollup rules

Parameters:

  • id String

    ID of the rollup rule to add

get

(
  • id
  • success
  • failure
)
static

Retrieves a framework from the server, specified by the ID

Parameters:

  • id String

    ID of the framework to retrieve

  • success Callback1

    Callback triggered after successfully retrieving the framework, returns the retrieved framework

  • failure Callback1

    Callback triggered if an error occurs while retrieving the framework

getBlocking

(
  • id
  • success
  • failure
)
static

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

Parameters:

  • id String

    ID of the framework to retrieve

  • success Callback1

    Callback triggered after successfully retrieving the framework, returns the retrieved framework

  • failure Callback1

    Callback triggered if an error occurs while retrieving the framework

removeCompetency

(
  • id
  • success
  • failure
)

Removes a competency ID from the framework's list, also removes any levels and relations associated with that competency

TODO: remove rollup rules? should we add flag to remove these extras

Parameters:

  • id String

    ID of the competency to remove

  • success Callback1

    Callback triggered after succesfully removing the competency and levels and relationships

  • failure Callback1

    Callback triggered if error occurs when removing competency and levels and relationships

removeCompetency

(
  • id
)

Removes a relation ID from the framework's list of relations

Parameters:

  • id String

    ID to remove from the framework's relation list

removeLevel

(
  • id
)

Removes a level ID from the framework's list of levels

Parameters:

  • id String

    ID to remove from framework's level list

removeLevelsThatInclude

(
  • id
  • i
  • success
  • failure
)
private

Helper method to remove levels associated with a competency from this framework

Parameters:

  • id String

    ID of the competency being removed, to find levels on

  • i Int

    recursive index parameter

  • success Callback1

    Callback triggered after all levels in the framework have been checked

  • failure Callback1

    Callback triggered if error occurs looking through levels

removeRelationshipsThatInclude

(
  • id
  • i
  • success
  • failure
)
private

Helper method to remove relationships associated with a competency from this framework

Parameters:

  • id String

    ID of the competency being removed, to find relationships on

  • i Int

    recursive index parameter

  • success Callback1

    Callback triggered after all relationships in the framework have been checked

  • failure Callback1

    Callback triggered if error occurs looking through relationships

removeRollupRule

(
  • id
)

Removes a rollup rule ID from the framework's list of rollup rules

Parameters:

  • id String

    ID to remove from rollup rule list

save

(
  • success
  • failure
)

Saves this frameworks details on the server specified by it's ID

Parameters:

  • success Callback1

    Callback triggered after successfully saving the framework

  • failure Callback1

    Callback triggered if error occurs while saving the framework