com.eduworks.schema.pebl.eXtension

Class ExtInstitution

java.lang.Object

org.json.ld.EcLinkedData

org.cassproject.schema.general.EcRemoteLinkedData

org.schema.Thing

org.schema.Organization

com.eduworks.schema.pebl.eXtension.ExtInstitution

public class ExtInstitution
extends Organization

Author:

debbie.brown@eduworks.com

Field Summary

Fields

Modifier and Type	Field and Description
String	communityLink
static String	EMPLOYEE_TYPE_ADMINISTRATOR
static String	EMPLOYEE_TYPE_ASSISTANT
static String	EMPLOYEE_TYPE_IT
String	legacyId ExtInstitution objects use the following elements from schema.org/Organization: - id - context - type - url - name - description - sameAs - address - telephone - faxNumber - areaServed (ECOP Region) - member (for administrators) - employee (for assistant) - contactPoint (for IT poc) - logo
String	locationState
String	memberCount

Fields inherited from class org.schema.Organization

address, aggregateRating, alumni, areaServed, award, awards, brand, contactPoint, contactPoints, department, dissolutionDate, duns, email, employee, employees, event, events, faxNumber, founder, founders, foundingDate, foundingLocation, funder, globalLocationNumber, hasOfferCatalog, hasPOS, isicV4, legalName, leiCode, location, logo, makesOffer, member, memberOf, members, naics, numberOfEmployees, owns, parentOrganization, review, reviews, seeks, serviceArea, sponsor, subOrganization, taxID, telephone, vatID

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
ExtInstitution() 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 institution from the server corresponding to its ID
void	addPOC(String type, String name, String title, String email, String phone, String fax, String addr1, String addr2, String addr3, String addrCityState, String addrZip) Adds a POC for the institution from raw contact information
static void	get(String id, org.stjs.javascript.functions.Callback1<ExtInstitution> success, org.stjs.javascript.functions.Callback1<String> failure) Retrieves the institution specified with the ID from the server
Person	getAdminPOC() Returns the administrative POC of the Institution
String	getAlternateName() Returns the alternate name of the Institution
Person	getAssistantPOC() Returns the assistant POC of the Institution
static ExtInstitution	getBlocking(String id) Retrieves a institution from the server synchronously, the call blocks until it is successful or an error occurs
String	getCommunityLink() Returns the institution's people community link
String	getDescription() Returns the description of the Institution
String	getFax() Returns the fax of the Institution
String	getId() Returns the ID of the Institution
ImageObject	getImage() Returns the thumbnail image URL of the institution
ContactPoint	getITPOC() Returns the IT POC of the Institution
String	getLegacyId() Returns the legacyId of the Institution
String	getLocationState() Returns the institution's location state
String	getMemberCount() Returns the institution's number of members
String	getName() Returns the name of the Institution
String	getPhone() Returns the telephone of the Institution
String	getRegion() Returns the institution's region
String	getUrl() Returns the institution object URL
String	getWebPage() Returns the institution's web page
String	save(org.stjs.javascript.functions.Callback1<String> success, org.stjs.javascript.functions.Callback1<String> failure) Saves this institution on the server corresponding to its ID
static void	search(EcRepository repo, String query, org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<ExtInstitution>> success, org.stjs.javascript.functions.Callback1<String> failure, Object paramObj) Searches the repository using the query and optional parameters provided
void	setAdminPOC(Person poc) Sets administrative POC for the Institution
void	setAlternateName(String name) Sets the alternate name of the Institution
void	setAssistantPOC(Person poc) Sets assistant POC for the Institution
void	setCommunityLink(String page) Sets the people community link of the Institution
void	setDescription(String desc) Sets the description of the Institution
void	setFax(String fax) Sets the fax number of the Institution
void	setId(String id) Sets the ID of the Institution
void	setImage(ImageObject image) Sets the thumbnail image URL of the institution
void	setITPOC(ContactPoint poc) Sets IT POC for the Institution
void	setLegacyId(String id) Sets the legacyId of the Institution
void	setLocationState(String state) Sets the location state of the Institution
void	setMemberCount(String count) Sets the member count for the Institution
void	setName(String name) Sets the first name of the Institution
void	setPhone(String phone) Sets the telephone number of the Institution
void	setRegion(String region) Sets the region of the Institution
void	setUrl(String url) Sets the institution object URL
void	setWebPage(String page) Sets the web page URL of the Institution

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

EMPLOYEE_TYPE_ADMINISTRATOR

public static String EMPLOYEE_TYPE_ADMINISTRATOR

EMPLOYEE_TYPE_ASSISTANT

public static String EMPLOYEE_TYPE_ASSISTANT

EMPLOYEE_TYPE_IT

public static String EMPLOYEE_TYPE_IT

legacyId

public String legacyId

ExtInstitution objects use the following elements from schema.org/Organization: - id - context - type - url - name - description - sameAs - address - telephone - faxNumber - areaServed (ECOP Region) - member (for administrators) - employee (for assistant) - contactPoint (for IT poc) - logo

locationState

public String locationState

memberCount

public String memberCount

communityLink

public String communityLink

Constructor Detail

ExtInstitution

public ExtInstitution()

Constructor, automatically sets @context and @type.

Method Detail

get

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

Retrieves the institution specified with the ID from the server

Parameters:

{String} - id ID of the institution to retrieve

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

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

getBlocking

public static ExtInstitution getBlocking(String id)

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

Parameters:

{String} - id ID of the institution to retrieve

Returns:

ExtInstitution The institution retrieved

search

public static void search(EcRepository repo,
                          String query,
                          org.stjs.javascript.functions.Callback1<org.stjs.javascript.Array<ExtInstitution>> 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 institution on the server corresponding to its ID

Parameters:

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

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

Returns:

{ExtInstitution}

_delete

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

Deletes the institution from the server corresponding to its ID

Parameters:

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

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

getId

public String getId()

Returns the ID of the Institution

Returns:

{String} ID of institution

setId

public void setId(String id)

Sets the ID of the Institution

Parameters:

{String} - id ID of the Institution

getLegacyId

public String getLegacyId()

Returns the legacyId of the Institution

Returns:

{String} legacyId of institution

setLegacyId

public void setLegacyId(String id)

Sets the legacyId of the Institution

Parameters:

{String} - id legacyId of the Institution

getName

public String getName()

Returns the name of the Institution

Overrides:

getName in class Thing

Returns:

{String} name of institution

setName

public void setName(String name)

Sets the first name of the Institution

Overrides:

setName in class Thing

Parameters:

{String} - name first name of the Institution

getAlternateName

public String getAlternateName()

Returns the alternate name of the Institution

Returns:

{String} alternate name of institution

setAlternateName

public void setAlternateName(String name)

Sets the alternate name of the Institution

Parameters:

{String} - name alternate name of the Institution

getPhone

public String getPhone()

Returns the telephone of the Institution

Returns:

{String} telephone of institution

setPhone

public void setPhone(String phone)

Sets the telephone number of the Institution

Parameters:

{String} - phone telephone of the Institution

getFax

public String getFax()

Returns the fax of the Institution

Returns:

{String} fax of institution

setFax

public void setFax(String fax)

Sets the fax number of the Institution

Parameters:

{String} - fax fax of the Institution

getDescription

public String getDescription()

Returns the description of the Institution

Overrides:

getDescription in class Thing

Returns:

{String} description of institution

setDescription

public void setDescription(String desc)

Sets the description of the Institution

Overrides:

setDescription in class Thing

Parameters:

{String} - desc description of the Institution

getWebPage

public String getWebPage()

Returns the institution's web page

Returns:

{String} web page url of institution

setWebPage

public void setWebPage(String page)

Sets the web page URL of the Institution

Parameters:

{String} - page web page url of the Institution

getCommunityLink

public String getCommunityLink()

Returns the institution's people community link

Returns:

{String} people community link of institution

setCommunityLink

public void setCommunityLink(String page)

Sets the people community link of the Institution

Parameters:

{String} - page people community link of the Institution

getUrl

public String getUrl()

Returns the institution object URL

Returns:

{String} url of institution object

setUrl

public void setUrl(String url)

Sets the institution object URL

Parameters:

{String} - url url of the Institution object

getLocationState

public String getLocationState()

Returns the institution's location state

Returns:

{String} location state of institution

setLocationState

public void setLocationState(String state)

Sets the location state of the Institution

Parameters:

{String} - state location state of the Institution

getImage

public ImageObject getImage()

Returns the thumbnail image URL of the institution

Returns:

{ImageObject} image url of institution

setImage

public void setImage(ImageObject image)

Sets the thumbnail image URL of the institution

Parameters:

{ImageObject} - image image object of the institution

getRegion

public String getRegion()

Returns the institution's region

Returns:

{String} region of institution

setRegion

public void setRegion(String region)

Sets the region of the Institution

Parameters:

{String} - region region of the Institution

getMemberCount

public String getMemberCount()

Returns the institution's number of members

Returns:

{} number of members at institution

setMemberCount

public void setMemberCount(String count)

Sets the member count for the Institution

Parameters:

{String} - count member count at the Institution

getAssistantPOC

public Person getAssistantPOC()

Returns the assistant POC of the Institution

Returns:

{Person} assistant poc of institution

setAssistantPOC

public void setAssistantPOC(Person poc)

Sets assistant POC for the Institution

Parameters:

{Person} - poc assistant POC at the Institution

getAdminPOC

public Person getAdminPOC()

Returns the administrative POC of the Institution

Returns:

{Person} administrative poc of institution

setAdminPOC

public void setAdminPOC(Person poc)

Sets administrative POC for the Institution

Parameters:

{Person} - poc administrativePOC at the Institution

getITPOC

public ContactPoint getITPOC()

Returns the IT POC of the Institution

Returns:

{ContactPoint} IT poc of institution

setITPOC

public void setITPOC(ContactPoint poc)

Sets IT POC for the Institution

Parameters:

{ContactPoint} - poc IT POC at the Institution

addPOC

public void addPOC(String type,
                   String name,
                   String title,
                   String email,
                   String phone,
                   String fax,
                   String addr1,
                   String addr2,
                   String addr3,
                   String addrCityState,
                   String addrZip)

Adds a POC for the institution from raw contact information

Parameters:

{String} - type

{String} - name

{String} - title

{String} - email

{String} - phone

{String} - fax

{String} - addr1

{String} - addr2

{String} - addrCityState

{String} - addrZip