org.cass.competency

Class EcFramework

java.lang.Object

org.json.ld.EcLinkedData

org.cassproject.schema.general.EcRemoteLinkedData

org.schema.Thing

org.schema.CreativeWork

org.cassproject.schema.cass.competency.Framework

org.cass.competency.EcFramework

public class EcFramework
extends Framework

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

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static Object	template

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

competency, level, myType, relation, rollupRule

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
EcFramework()

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 this framework from the server specified by it's ID
void	addCompetency(String id) Adds the competency ID specified to the frameworks list of competency IDs
void	addLevel(String id) Adds a level ID to the framework's list of levels
void	addRelation(String id) Adds a relation ID to the framework's list of relations
void	addRollupRule(String id) Adds a rollup rule ID to the framework's list of rollup rules
void	asAsnJson(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, String fallbackServerUrl)
static void	get(String id, org.stjs.javascript.functions.Callback1<EcFramework> success, org.stjs.javascript.functions.Callback1<String> failure) Retrieves a framework from the server, specified by the ID
static EcFramework	getBlocking(String id) Retrieves a framework from the server in a blocking fashion, specified by the ID
void	removeCompetency(String id, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) Removes a competency ID from the framework's list, also removes any levels and relations associated with that competency
void	removeLevel(String id) Removes a level ID from the framework's list of levels
void	removeRelation(String id) Removes a relation ID from the framework's list of relations
void	removeRollupRule(String id) Removes a rollup rule ID from the framework's list of rollup rules
void	save(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, EcRepository repo) Saves this frameworks details on the server specified by it's ID
static void	search(EcRepository repo, String query, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcFramework>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository given for frameworks using the query passed in

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

getTypes, upgrade

Methods inherited from class org.schema.Thing

getDescription, getDisplayStringFrom, getName, setDescription, setName

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

Field Detail

template

public static Object template

Constructor Detail

EcFramework

public EcFramework()

Method Detail

get

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

Retrieves a framework from the server, specified by the ID

Parameters:

{String} - id ID of the framework to retrieve

{Callback1} - success Callback triggered after successfully retrieving the framework, returns the retrieved framework

{Callback1} - failure Callback triggered if an error occurs while retrieving the framework

getBlocking

public static EcFramework getBlocking(String id)

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

Parameters:

{String} - id ID of the framework to retrieve

{Callback1} - success Callback triggered after successfully retrieving the framework, returns the retrieved framework

{Callback1} - failure Callback triggered if an error occurs while retrieving the framework

search

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

Searches the repository given for frameworks using the query passed in

Parameters:

{EcRepository} - repo Repository to search for frameworks

{String} - query Query string used to search for a framework

{Callback1} - success Callback triggered when the search successfully returns, returns search results

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

{Object} - paramObj Parameter object for search

addCompetency

public void addCompetency(String id)

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

Parameters:

{String} - id ID of the competency to add

removeCompetency

public void removeCompetency(String id,
                             org.stjs.javascript.functions.Callback1<String> success,
                             org.stjs.javascript.functions.Callback1<String> 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:

{String} - id ID of the competency to remove

{Callback1} - success Callback triggered after succesfully removing the competency and levels and relationships

{Callback1} - failure Callback triggered if error occurs when removing competency and levels and relationships

addRelation

public void addRelation(String id)

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

Parameters:

{String} - id ID to add to the framework's relation list

removeRelation

public void removeRelation(String id)

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

Parameters:

{String} - id ID to remove from the framework's relation list

addLevel

public void addLevel(String id)

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

Parameters:

{String} - id ID of the level to add to framework's list

removeLevel

public void removeLevel(String id)

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

Parameters:

{String} - id ID to remove from framework's level list

addRollupRule

public void addRollupRule(String id)

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

Parameters:

{String} - id ID of the rollup rule to add

removeRollupRule

public void removeRollupRule(String id)

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

Parameters:

{String} - id ID to remove from rollup rule list

save

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

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

Parameters:

{Callback1} - success Callback triggered after successfully saving the framework

{Callback1} - failure Callback triggered if error occurs while saving the framework

_delete

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

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

Parameters:

{Callback1} - success Callback triggered if successfully deleted framework

{Callback1} - failure Callback triggered if error occurs when deleting the framework

asAsnJson

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