org.cass.competency

Class EcLevel

java.lang.Object

org.json.ld.EcLinkedData

org.cassproject.schema.general.EcRemoteLinkedData

org.schema.Thing

org.schema.CreativeWork

org.cassproject.schema.cass.competency.Level

org.cass.competency.EcLevel

public class EcLevel
extends Level

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

Author:

fritz.ray@eduworks.com, devlin.junker@eduworks.com

Field Summary

Fields inherited from class org.cassproject.schema.cass.competency.Level

competency, myType, performance, title

Fields inherited from class org.schema.CreativeWork

about, accessibilityAPI, accessibilityControl, accessibilityFeature, accessibilityHazard, accessibilitySummary, accessMode, accessModeSufficient, accountablePerson, aggregateRating, alternativeHeadline, associatedMedia, audience, audio, author, award, awards, character, citation, comment, commentCount, contentLocation, contentRating, contributor, copyrightHolder, copyrightYear, creator, dateCreated, dateModified, datePublished, discussionUrl, editor, educationalAlignment, educationalUse, encoding, encodings, exampleOfWork, fileFormat, funder, genre, hasPart, headline, inLanguage, interactionStatistic, interactivityType, isAccessibleForFree, isBasedOn, isBasedOnUrl, isFamilyFriendly, isPartOf, keywords, learningResourceType, license, locationCreated, mainEntity, material, mentions, offers, position, producer, provider, publication, publisher, publishingPrinciples, recordedAt, releasedEvent, review, reviews, schemaVersion, sourceOrganization, spatialCoverage, sponsor, temporalCoverage, text, thumbnailUrl, timeRequired, translator, typicalAgeRange, version, video, workExample

Fields inherited from class org.schema.Thing

additionalType, alternateName, description, disambiguatingDescription, identifier, image, mainEntityOfPage, name, potentialAction, sameAs, url

Fields inherited from class org.cassproject.schema.general.EcRemoteLinkedData

id, owner, reader, signature

Fields inherited from class org.json.ld.EcLinkedData

atProperties, context, type

Constructor Summary

Constructors

Constructor and Description
EcLevel()

Method Summary

Modifier and Type	Method and Description
void	_delete(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) Deletes the level from it's repository
void	addRelationship(EcLevel targetLevel, String alignmentType, EcPpk identity, String serverUrl, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, EcRepository repo) Adds a relationship between this level and a target level to define how they correspond to one another
static void	get(String id, org.stjs.javascript.functions.Callback1<EcLevel> success, org.stjs.javascript.functions.Callback1<String> failure) Retrieves a level from the server specified by its ID
static EcLevel	getBlocking(String id) Retrieves a level from it's server synchronously, the call blocks until it is successful or an error occurs
void	save(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, EcRepository repo) Saves this levels details to the server
static void	search(EcRepository repo, String query, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcLevel>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches for levels with a string query
static void	searchByCompetency(EcRepository repo, String competencyId, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcLevel>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches for levels using a competency that the results must be related to
void	setDescription(String description) Method to set the description of the level
void	setName(String name) Method to set the name of this level

Methods inherited from class org.cassproject.schema.cass.competency.Level

getTypes, upgrade

Methods inherited from class org.schema.Thing

getDescription, getDisplayStringFrom, getName

Methods inherited from class org.cassproject.schema.general.EcRemoteLinkedData

addOwner, addReader, asNQuads, asRdfXml, assignId, assignIdAndVersion, asTurtle, canEdit, canEditAny, generateId, generateShortId, getDottedType, getGuid, getSearchStringByType, getServerBaseUrl, getTimestamp, hasOwner, hasReader, invalid, isId, removeOwner, removeReader, shortId, signWith, toSignableJson, trimVersionFromUrl, updateTimestamp, verify, veryShortId

Methods inherited from class org.json.ld.EcLinkedData

atIfy, atIfyArray, atIfyObject, compact, copyFrom, deAtify, getFullType, isA, isAny, isAtProperty, isProbablyJson, setContextAndType, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EcLevel

public EcLevel()

Method Detail

get

public static void get(String id,
                       org.stjs.javascript.functions.Callback1<EcLevel> success,
                       org.stjs.javascript.functions.Callback1<String> failure)

Retrieves a level from the server specified by its ID

Parameters:

{String} - id ID of the level to retrieve

{Callback1} - success Callback triggered when successfully retrieving the level, returns the level

{Callback1} - failure Callback triggered if error occurs when retrieving the level

getBlocking

public static EcLevel getBlocking(String id)

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

Parameters:

{String} - id ID of the level to retrieve

Returns:

EcLevel The level retrieved

search

public static void search(EcRepository repo,
                          String query,
                          org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcLevel>> success,
                          org.stjs.javascript.functions.Callback1<String> failure,
                          Object paramObj)

Searches for levels with a string query

Parameters:

{EcRepository} - repo Repository to search for levels

{String} - query query string to use in search

{Callback1>} - success Callback triggered when searches successfully

{Callback1} - failure Callback triggered if an error occurs while searching

{Object} - paramObj Search parameters object to pass in

searchByCompetency

public static void searchByCompetency(EcRepository repo,
                                      String competencyId,
                                      org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcLevel>> success,
                                      org.stjs.javascript.functions.Callback1<String> failure,
                                      Object paramObj)

Searches for levels using a competency that the results must be related to

Parameters:

{EcRepository} - repo Repository to search for levels

{String} - competencyId competency ID that the levels are rleated to

{Callback1>} - success Callback triggered when searches successfully

{Callback1} - failure Callback triggered if an error occurs while searching

{Object} - paramObj Search parameters object to pass in

addRelationship

public void addRelationship(EcLevel targetLevel,
                            String alignmentType,
                            EcPpk identity,
                            String serverUrl,
                            org.stjs.javascript.functions.Callback1<String> success,
                            org.stjs.javascript.functions.Callback1<String> failure,
                            EcRepository repo)

Adds a relationship between this level and a target level to define how they correspond to one another

Parameters:

{EcLevel} - targetLevel Target level of the relationship

{String} - alignmentType Type of relationship

{EcPpk} - identity Private key that will own the new relationship

{String} - server URL Prefix of the new relationship ID (Server it will be saved on)

setName

public void setName(String name)

Method to set the name of this level

Overrides:

setName in class org.schema.Thing

Parameters:

{String} - name Name to set on the level

setDescription

public void setDescription(String description)

Method to set the description of the level

Overrides:

setDescription in class org.schema.Thing

Parameters:

{String} - description Description to set on the level

save

public void save(org.stjs.javascript.functions.Callback1<String> success,
                 org.stjs.javascript.functions.Callback1<String> failure,
                 EcRepository repo)

Saves this levels details to the server

Parameters:

{Callback1} - success Callback triggered on successfully saving the level to the server

{Callback1} - failure Callback triggered if error occurs while saving the level to the server

_delete

public void _delete(org.stjs.javascript.functions.Callback1<String> success,
                    org.stjs.javascript.functions.Callback1<String> failure)

Deletes the level from it's repository

Parameters:

{Callback1} - success Callback triggered when the level is successfully deleted from the server

{Callback1} - failure Callback triggered if an error occurs while deleting the level