com.eduworks.schema.cfd.competency

Class CfdAlignment

java.lang.Object

org.json.ld.EcLinkedData

org.cassproject.schema.general.EcRemoteLinkedData

org.schema.Thing

org.schema.Intangible

org.schema.AlignmentObject

com.eduworks.schema.cfd.competency.CfdAlignment

public class CfdAlignment
extends org.schema.AlignmentObject

Field Summary

Fields

Modifier and Type	Field and Description
static String	myType

Fields inherited from class org.schema.AlignmentObject

alignmentType, educationalFramework, targetDescription, targetName, targetUrl

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

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<CfdAlignment> success, org.stjs.javascript.functions.Callback1<String> failure) Retrieves the alignment specified with the ID from the server
static CfdAlignment	getBlocking(String id) Retrieves an alignment from it's server synchronously, the call blocks until it is successful or an error occurs
String	getEducationalFramework() Gets the AlignmentObject educationalFramework field of this alignment
String	getTargetUrl() Gets the AlignmentObject targetUrl field with the id of the competency it is aligned with
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<CfdAlignment>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository using the query and optional parameters provided
void	setAlignmentType(String type) Sets the AlignmentObject alignmentType field
void	setEducationalFramework(String frameworkId) Sets the AlignmentObject educationalFramework field with the id of the framework this competency is part of
void	setTargetUrl(String targetId) Sets the AlignmentObject targetUrl field with the id of the competency it is aligned with

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, equals, 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, recast, setContextAndType, toJson, upgrade

Methods inherited from class java.lang.Object

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

Field Detail

myType

public static final String myType

See Also:

Constant Field Values

Constructor Detail

CfdAlignment

public CfdAlignment()

Method Detail

get

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

getEducationalFramework

public String getEducationalFramework()

Gets the AlignmentObject educationalFramework field of this alignment

Parameters:

{String} - frameworkId ID of framework this Alignment is related to

setEducationalFramework

public void setEducationalFramework(String frameworkId)

Sets the AlignmentObject educationalFramework field with the id of the framework this competency is part of

Parameters:

{String} - frameworkId ID of framework this Alignment is related to

getTargetUrl

public String getTargetUrl()

Gets the AlignmentObject targetUrl field with the id of the competency it is aligned with

Returns:

{String} ID of the competency aligned with

setTargetUrl

public void setTargetUrl(String targetId)

Sets the AlignmentObject targetUrl field with the id of the competency it is aligned with

Parameters:

{String} - targetId ID of competency this Alignment is related to

setAlignmentType

public void setAlignmentType(String type)

Sets the AlignmentObject alignmentType field

Parameters:

{String} - type Alignment type for alignment. Recommended values include: 'assesses', 'teaches', 'requires', 'textComplexity', 'readingLevel', 'educationalSubject', and 'educationalLevel'.

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