com.eduworks.schema.pebl.eXtension

Class ExtResource

java.lang.Object

org.json.ld.EcLinkedData

org.cassproject.schema.general.EcRemoteLinkedData

org.schema.Thing

org.schema.CreativeWork

com.eduworks.schema.pebl.eXtension.ExtResource

public class ExtResource
extends CreativeWork

Author:

debbie.brown@eduworks.com

Field Summary

Fields

Modifier and Type	Field and Description
String	legacyId

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
ExtResource() Constructor, automatically sets @context and @type.

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 resource from the server corresponding to its ID
static void	get(String id, org.stjs.javascript.functions.Callback1<ExtResource> success, org.stjs.javascript.functions.Callback1<String> failure) Retrieves the resource specified with the ID from the server
String	getAdditionalType() Returns the additionalType of the resource
Person	getAuthor() Returns the author of the resource
Product	getAuthoringURL() Returns the resource's authoring URL
static ExtResource	getBlocking(String id) Retrieves a resource from the server synchronously, the call blocks until it is successful or an error occurs
String	getCategory() Returns the genre/category of the resource
Organization	getCommunity() Returns the community of the resource
String	getDescription() Returns the description of the resource
String	getId() Returns the ID of the resource
Person	getInstitution() Returns the institution of the resource
String	getKeywords() Returns the keywords of the resource
String	getLaunchURL() Returns the resource's launch URL
String	getLegacyId() Returns the legacyId of the resource
String	getText() Returns the text of the resource
String	getTitle() Returns the title of the resource
String	getUrl() Returns the resource object URL
String	save(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) Saves this resource on the server corresponding to its ID
static void	search(EcRepository repo, String query, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<ExtResource>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository using the query and optional parameters provided
void	setAdditionalType(String name) Sets the additionalType of the resource
void	setAuthor(Person creator) Sets the author of the resource
void	setAuthoringURL(Product page) Sets the authoring URL of the resource
void	setCategory(String name) Sets the genre/category of the resource
void	setCommunity(Organization community) Sets the community of the resource
void	setDescription(String description) Sets the description of the resource
void	setId(String id) Sets the ID of the resource
void	setInstitution(Person institution) Sets the institution of the resource
void	setKeywords(String name) Sets the keywords of the resource
void	setLaunchURL(String page) Sets the launch URL of the resource
void	setLegacyId(String id) Sets the legacyId of the resource
void	setText(String text) Sets the text of the resource
void	setTitle(String title) Sets the title of the resource
void	setUrl(String url) Sets the resource object URL

Methods inherited from class org.schema.Thing

getDisplayStringFrom, getName, 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, 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

legacyId

public String legacyId

Constructor Detail

ExtResource

public ExtResource()

Constructor, automatically sets @context and @type.

Method Detail

get

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

Retrieves the resource specified with the ID from the server

Parameters:

{String} - id ID of the resource to retrieve

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

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

getBlocking

public static ExtResource getBlocking(String id)

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

Parameters:

{String} - id ID of the resource to retrieve

Returns:

ExtResource The resource retrieved

search

public static void search(EcRepository repo,
                          String query,
                          org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<ExtResource>> 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 -

save

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

Saves this resource on the server corresponding to its ID

Parameters:

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

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

Returns:

{ExtResource}

_delete

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

Deletes the resource from the server corresponding to its ID

Parameters:

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

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

getId

public String getId()

Returns the ID of the resource

Returns:

{String} ID of resource

setId

public void setId(String id)

Sets the ID of the resource

Parameters:

{String} - id ID of the resource

getLegacyId

public String getLegacyId()

Returns the legacyId of the resource

Returns:

{String} legacyId of resource

setLegacyId

public void setLegacyId(String id)

Sets the legacyId of the resource

Parameters:

{String} - id legacyId of the resource

getAuthor

public Person getAuthor()

Returns the author of the resource

Returns:

{Person} author of resource

setAuthor

public void setAuthor(Person creator)

Sets the author of the resource

Parameters:

{Person} - creator

getTitle

public String getTitle()

Returns the title of the resource

Returns:

{String} title of resource

setTitle

public void setTitle(String title)

Sets the title of the resource

Parameters:

{String} - title title of the resource

getDescription

public String getDescription()

Returns the description of the resource

Overrides:

getDescription in class Thing

Returns:

{String} description of resource

setDescription

public void setDescription(String description)

Sets the description of the resource

Overrides:

setDescription in class Thing

Parameters:

{String} - description description of the resource

getText

public String getText()

Returns the text of the resource

Returns:

{String} text of resource

setText

public void setText(String text)

Sets the text of the resource

Parameters:

{String} - text text of the resource

getCategory

public String getCategory()

Returns the genre/category of the resource

Returns:

{String} genre of resource

setCategory

public void setCategory(String name)

Sets the genre/category of the resource

Parameters:

{String} - name category of the resource

getAdditionalType

public String getAdditionalType()

Returns the additionalType of the resource

Returns:

{String} additionalType of resource

setAdditionalType

public void setAdditionalType(String name)

Sets the additionalType of the resource

Parameters:

{String} - name additionalType of the resource

getKeywords

public String getKeywords()

Returns the keywords of the resource

Returns:

{String} keywords of resource

setKeywords

public void setKeywords(String name)

Sets the keywords of the resource

Parameters:

{String} - name keywords of the resource

getInstitution

public Person getInstitution()

Returns the institution of the resource

Returns:

{Person} publisher of resource

setInstitution

public void setInstitution(Person institution)

Sets the institution of the resource

Parameters:

{Organization} - institution institution of the resource

getCommunity

public Organization getCommunity()

Returns the community of the resource

Returns:

{Organization} community of resource

setCommunity

public void setCommunity(Organization community)

Sets the community of the resource

Parameters:

{Organization} - community community of the resource

getLaunchURL

public String getLaunchURL()

Returns the resource's launch URL

Returns:

{String} launch url of resource

setLaunchURL

public void setLaunchURL(String page)

Sets the launch URL of the resource

Parameters:

{String} - page Launch url of the resource

getAuthoringURL

public Product getAuthoringURL()

Returns the resource's authoring URL

Returns:

{Product} authoring url of resource

setAuthoringURL

public void setAuthoringURL(Product page)

Sets the authoring URL of the resource

Parameters:

{String} - page Authoring url of the resource

getUrl

public String getUrl()

Returns the resource object URL

Returns:

{String} url of resource object

setUrl

public void setUrl(String url)

Sets the resource object URL

Parameters:

{String} - url url of the resource object