org.cass.competency

Class EcCompetency

java.lang.Object

org.json.ld.EcLinkedData

org.cassproject.schema.general.EcRemoteLinkedData

org.schema.Thing

org.schema.CreativeWork

org.cassproject.schema.cass.competency.Competency

org.cass.competency.EcCompetency

public class EcCompetency
extends Competency

Implementation of a Competency 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.Competency

myType, scope

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

Method Summary

Modifier and Type	Method and Description
void	_delete(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, EcRepository repo) Deletes the competency from the server
EcAlignment	addAlignment(EcCompetency target, String alignmentType, EcPpk owner, String serverUrl, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, EcRepository repo) Adds a new alignment on the server specified with this competency as its source and the specified target competency
EcLevel	addLevel(String name, String description, EcPpk owner, String serverUrl, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, EcRepository repo) Adds a new level on the server specified for this competency.
EcRollupRule	addRollupRule(String name, String description, EcPpk owner, String serverUrl, org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, EcRepository repo) Adds a new rollup rule on the server specified for this competency
static void	get(String id, org.stjs.javascript.functions.Callback1<EcCompetency> success, org.stjs.javascript.functions.Callback1<String> failure) Retrieves a competency from it's server asynchronously
static EcCompetency	getBlocking(String id) Retrieves a competency from it's server synchronously, the call blocks until it is successful or an error occurs
void	levels(EcRepository repo, org.stjs.javascript.functions.Callback1<EcLevel> success, org.stjs.javascript.functions.Callback1<String> failure, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcLevel>> successAll) Searches the repository given for any levels of this competency
void	relations(EcRepository repo, org.stjs.javascript.functions.Callback1<EcAlignment> eachSuccess, org.stjs.javascript.functions.Callback1<String> failure, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> successAll) Searches the repository given for any relationships that contain this competency
void	relationships(EcRepository repo, org.stjs.javascript.functions.Callback1<EcAlignment> eachSuccess, org.stjs.javascript.functions.Callback1<String> failure, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> successAll) Deprecated.
void	rollupRules(EcRepository repo, org.stjs.javascript.functions.Callback1<EcRollupRule> success, org.stjs.javascript.functions.Callback1<String> failure, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcRollupRule>> successAll) Searches the repository given for any rollup rules of this competency
void	save(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure, EcRepository repo) Saves the competency details to the server
static void	search(EcRepository repo, String query, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcCompetency>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches a repository for competencies that match the search query
void	setScope(String scope) Method to set competency scope

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

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

Constructor Detail

EcCompetency

public EcCompetency()

Method Detail

get

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

Retrieves a competency from it's server asynchronously

Parameters:

{String} - id ID of the competency to retrieve from the server

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

{Callback1} - failure Callback triggered if error retrieving competency

getBlocking

public static EcCompetency getBlocking(String id)

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

Parameters:

{String} - id ID of the competency to retrieve

Returns:

EcCompetency The competency retrieved

search

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

Searches a repository for competencies that match the search query

Parameters:

{EcRepository} - repo Repository to search using the query

{String} - query Query string to pass to the search web service

{Callback1> - success Callback triggered after completing the search, returns the results

{Callback1} - failure Callback triggered if error searching

{Object} - paramObj Parameter object for search

start -

size -

addAlignment

public EcAlignment addAlignment(EcCompetency target,
                                String alignmentType,
                                EcPpk owner,
                                String serverUrl,
                                org.stjs.javascript.functions.Callback1<String> success,
                                org.stjs.javascript.functions.Callback1<String> failure,
                                EcRepository repo)

Adds a new alignment on the server specified with this competency as its source and the specified target competency

Parameters:

{EcCompetency} - target Competency to be related with

{String} - alignmentType String defining the relationship type

{EcPpk} - owner Private Key that will own the relationship created

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

{Callback1} - success Callback triggered after successfully creating and saving the relationship

{Callback1} - [failure] Callback triggered if error creating and saving relationship

Returns:

EcAlignment Created relationship

relations

public void relations(EcRepository repo,
                      org.stjs.javascript.functions.Callback1<EcAlignment> eachSuccess,
                      org.stjs.javascript.functions.Callback1<String> failure,
                      org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> successAll)

Searches the repository given for any relationships that contain this competency

Parameters:

{EcRepository} - repo Repository to search for relationships

{Callback1} - eachSuccess Callback triggered for each relationship found

{Callback1} - failure Callback triggered if an error finding relationships

{Callback1>} - successAll Callback triggered once all of the relationships have been found

relationships

@Deprecated
public void relationships(EcRepository repo,
                                      org.stjs.javascript.functions.Callback1<EcAlignment> eachSuccess,
                                      org.stjs.javascript.functions.Callback1<String> failure,
                                      org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> successAll)

Deprecated.

Searches the repository given for any relationships that contain this competency

Parameters:

{EcRepository} - repo Repository to search for relationships

{Callback1} - eachSuccess Callback triggered for each relationship found

{Callback1} - failure Callback triggered if an error finding relationships

{Callback1>} - successAll Callback triggered once all of the relationships have been found

addLevel

public EcLevel addLevel(String name,
                        String description,
                        EcPpk owner,
                        String serverUrl,
                        org.stjs.javascript.functions.Callback1<String> success,
                        org.stjs.javascript.functions.Callback1<String> failure,
                        EcRepository repo)

Adds a new level on the server specified for this competency.

Parameters:

{String} - name Name of the new level to create

{String} - description Description of the new level to create

{String} - owner Private key of the owner of the new level

{String} - server URL Prefix for the new level's ID (Server saved on)

{Callback1} - success Callback triggered after successfully creating and saving the level

{Callback1} - failure Callback triggered if an error creating and saving the level

Returns:

EcLevel Level created

levels

public void levels(EcRepository repo,
                   org.stjs.javascript.functions.Callback1<EcLevel> success,
                   org.stjs.javascript.functions.Callback1<String> failure,
                   org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcLevel>> successAll)

Searches the repository given for any levels of this competency

Parameters:

{EcRepository} - repo Repository to search for levels

{Callback1} - success Callback triggered for each level found

{Callback1} - failure Callback triggered if an error finding levels

{Callback1>} - successAll Callback triggered once all of the levels have been found

addRollupRule

public EcRollupRule addRollupRule(String name,
                                  String description,
                                  EcPpk owner,
                                  String serverUrl,
                                  org.stjs.javascript.functions.Callback1<String> success,
                                  org.stjs.javascript.functions.Callback1<String> failure,
                                  EcRepository repo)

Adds a new rollup rule on the server specified for this competency

Parameters:

{String} - name Name of the rollup rule to create

{String} - description Description of the rollup rule to create

{EcPpk} - owner Private key that will own the new rollup rule

{String} - server URL Prefix for the new rollup rule's ID (Server that it will be saved on)

{Callback1} - success Callback triggered if successfully save the rollup rule

{Callback1} - failure Callback triggered fi error during save of rollup rule

Returns:

EcRollupRule Created rollup rule

rollupRules

public void rollupRules(EcRepository repo,
                        org.stjs.javascript.functions.Callback1<EcRollupRule> success,
                        org.stjs.javascript.functions.Callback1<String> failure,
                        org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcRollupRule>> successAll)

Searches the repository given for any rollup rules of this competency

Parameters:

{EcRepository} - repo Repository to search for levels

{Callback1} - success Callback triggered for each rollup rule found

{Callback1} - failure Callback triggered if an error finding rollup rule

{Callback1} - successAll Callback triggered once all of the rollup rules have been found

setScope

public void setScope(String scope)

Method to set competency scope

Parameters:

{String} - scope Scope to set for its competency

save

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

Saves the competency details to the server

Parameters:

{Callback1} - success Callback triggered on successfully saving the competency

{Callback1} - failure Callback triggered if error saving competency

_delete

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

Deletes the competency from the server

TODO: Delete rollup rules?

Parameters:

{Callback1} - success Callback triggered on successful deleting the competency

{Callback1} - failure Callback triggered if error deleting the competency

{EcRepository} - repo Repository to delete from and to check for levels or relationships to delete