org.cass.competency

Class EcAlignment

java.lang.Object

org.json.ld.EcLinkedData

org.cassproject.schema.general.EcRemoteLinkedData

org.schema.Thing

org.schema.CreativeWork

org.cassproject.schema.cass.competency.Relation

org.cass.competency.EcAlignment

public class EcAlignment
extends Relation

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

Author:

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

TODO: Test case where an absent relation is in the framework.

Field Summary

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

DESIRES, IS_ENABLED_BY, IS_EQUIVALENT_TO, IS_RELATED_TO, myType, NARROWS, relationType, REQUIRES, source, target, validFrom, validThrough

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

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 alignment from the server corresponding to its ID
static void	get(String id, org.stjs.javascript.functions.Callback1<EcAlignment> success, org.stjs.javascript.functions.Callback1<String> failure) Retrieves the alignment specified with the ID from the server
static EcAlignment	getBlocking(String id) Retrieves an alignment 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 alignment details on the server corresponding to its ID
static void	search(EcRepository repo, String query, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository using the query and optional parameters provided
static void	searchByCompetency(EcRepository repo, String competencyId, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository for alignments with a specific ID in the target field
static void	searchBySource(EcRepository repo, String sourceId, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository for alignments with a specific ID in the source field
static void	searchBySources(EcRepository repo, org.stjs.javascript.Array<String> sourceIds, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository for alignments with one of an array of IDs in the source field
void	setDescription(String description) Setter for alignment description
void	setName(String name) Setter for alignment name

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

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

EcAlignment

public EcAlignment()

Method Detail

get

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

Retrieves the alignment specified with the ID from the server

Parameters:

{String} - id ID of the alignment to retrieve

{Callback1} - success Callback triggered on successfully retrieving the alignment, returns the alignment

{Callback1} - [failure] Callback triggered if error while retrieving alignment

getBlocking

public static EcAlignment getBlocking(String id)

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

Parameters:

{String} - id ID of the alignment to retrieve

Returns:

EcAlignment The alignment retrieved

search

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

Searches the repository using the query and optional parameters provided

Parameters:

{EcRepository} - repo Repository to search using the query provided

{String} - query The query to send to the search

{Callback1>} - success Callback triggered on successful search return

{Callback1} - [failure] Callback triggered if error searching

{Object} - [paramObj] Parameters to include in the search

start -

size -

searchBySource

public static void searchBySource(EcRepository repo,
                                  String sourceId,
                                  org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> success,
                                  org.stjs.javascript.functions.Callback1<String> failure,
                                  Object paramObj)

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

Parameters:

{EcRepository} - repo Repository to search for alignments with the source specified

{String} - sourceId ID in the source field of the alignments to find

{Callback1>} - success Callback triggered on successful search return

{Callback1} - [failure] Callback triggered if error searching

{Object} - [paramObj] Parameters to include in the search

start -

size -

searchBySources

public static void searchBySources(EcRepository repo,
                                   org.stjs.javascript.Array<String> sourceIds,
                                   org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<EcAlignment>> success,
                                   org.stjs.javascript.functions.Callback1<String> failure,
                                   Object paramObj)

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

Parameters:

{EcRepository} - repo Repository to search for alignments with the source specified

{String} - sourceId ID in the source field of the alignments to find

{Callback1>} - success Callback triggered on successful search return

{Callback1} - [failure] Callback triggered if error searching

{Object} - [paramObj] Parameters to include in the search

start -

size -

searchByCompetency

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

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

Parameters:

{EcRepository} - repo Repository to search for alignments with the source specified

{String} - competencyId ID in the target field of the alignments to find

{Callback1>} - success Callback triggered on successful search return

{Callback1} - [failure] Callback triggered if error searching

{Object} - [paramObj] Parameters to include in the search

setName

public void setName(String name)

Setter for alignment name

Overrides:

setName in class org.schema.Thing

Parameters:

{String} - name name to give this alignment

setDescription

public void setDescription(String description)

Setter for alignment description

Overrides:

setDescription in class org.schema.Thing

Parameters:

{String} - description description to give this alignment

save

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

Saves this alignment details on the server corresponding to its ID

Parameters:

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

{Callback1} - [failure] Callback triggered if error while saving alignment

_delete

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

Deletes the alignment from the server corresponding to its ID

Parameters:

{Callback1} - success Callback triggered on successfully deleting the alignment

{Callback1} - [failure] Callback triggered if error while deleting alignment