com.eduworks.schema.cfd.competency

Class CfdReference

java.lang.Object

org.json.ld.EcLinkedData

org.cassproject.schema.general.EcRemoteLinkedData

org.schema.Thing

org.schema.CreativeWork

com.eduworks.schema.cfd.competency.CfdReference

public class CfdReference
extends org.schema.CreativeWork

Competency is Under construction.

Working model of competency with CFD Reference extension.

Author:

debbie.brown@eduworks.com, devlin.junker@eduworks.com

Field Summary

Fields

Modifier and Type	Field and Description
static String	edUse
static String	myType

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

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<CfdReference> success, org.stjs.javascript.functions.Callback1<String> failure) Retrieves the alignment specified with the ID from the server
static CfdReference	getBlocking(String id) Retrieves an alignment from it's server synchronously, the call blocks until it is successful or an error occurs
CfdAlignment	getEducationalAlignment() Gets the educational alignment of the reference
String	getEducationalUse() Returns the Educational Use of the reference (Should be Reference)
String	getName() Returns the name of the reference
String	getUrl() Returns the URL of the reference
void	save(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) 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<CfdReference>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository using the query and optional parameters provided
static void	searchWithFramework(EcRepository repo, String framework, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<CfdReference>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository for references with the framework and optional parameters provided
void	setEducationalAlignment(CfdAlignment alignment) Sets the educational alignment of the reference
void	setName(String name) Sets the Name of the reference
void	setUrl(String url) Sets the URL of the reference

Methods inherited from class org.schema.Thing

getDescription, setDescription

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, getTypes, isA, isAny, isAtProperty, isProbablyJson, setContextAndType, toJson, upgrade

Methods inherited from class java.lang.Object

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

Field Detail

myType

public static final String myType

See Also:

Constant Field Values

edUse

public static final String edUse

See Also:

Constant Field Values

Constructor Detail

CfdReference

public CfdReference()

Method Detail

get

public static void get(String id,
                       org.stjs.javascript.functions.Callback1<CfdReference> 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 CfdReference 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<CfdReference>> 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 -

searchWithFramework

public static void searchWithFramework(EcRepository repo,
                                       String framework,
                                       org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<CfdReference>> success,
                                       org.stjs.javascript.functions.Callback1<String> failure,
                                       Object paramObj)

Searches the repository for references with the framework and optional parameters provided

Parameters:

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

{String} - Framework The Framework to search for References with EducationalAlignments too

{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 -

getName

public String getName()

Returns the name of the reference

Overrides:

getName in class org.schema.Thing

Returns:

{String} name of reference

setName

public void setName(String name)

Sets the Name of the reference

Overrides:

setName in class org.schema.Thing

Parameters:

{String} - name name of the reference

getUrl

public String getUrl()

Returns the URL of the reference

Returns:

{String} URL of reference

setUrl

public void setUrl(String url)

Sets the URL of the reference

Parameters:

{String} - URL URL the reference is pointing at

getEducationalAlignment

public CfdAlignment getEducationalAlignment()

Gets the educational alignment of the reference

Returns:

{CfdAlignment} Educational Alignment for reference

setEducationalAlignment

public void setEducationalAlignment(CfdAlignment alignment)

Sets the educational alignment of the reference

Parameters:

{CfdAlignment} - alignment Educational alignment for reference

getEducationalUse

public String getEducationalUse()

Returns the Educational Use of the reference (Should be Reference)

Returns:

{String} educational use

save

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

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