API Docs for: 1.3.12
Show:

CredentialAlignmentObject Class

credentialengine.org/CredentialAlignmentObject Entity describing an affiliation or association between an entity such as a credential, learning opportunity or assessment and another entity in a structured framework such as a concept scheme, enumerated list, or competency framework.

Methods

getDescription

() String
Returns the description of the thing

Returns:

String: description of Thing

getName

() String
Returns the name of the thing

Returns:

String: name of Thing

setDescription

(
  • description
)
Method to set Thing description

Parameters:

  • description String
    Description to set for its Thing

setName

(
  • name
)
Method to set Thing name

Parameters:

  • name String
    Name to set for this Thing

Properties

additionalType

URL
Schema.org/additionalType An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.

alignmentDate

Date

http://purl.org/ctdl/terms/alignmentDate The date the alignment was made.

alignmentType

String

http://purl.org/ctdl/terms/alignmentType Type of relationship between two entities. In CTDL, the alignment type value is definitively identified by the property for which the AlignmentObject is the rdfs:range; therefore, use of this property is generally redundant.

alternateName

Text
Schema.org/alternateName An alias for the item.

codedNotation

String

http://purl.org/ctdl/terms/codedNotation Set of alpha-numeric symbols that uniquely identifies an item and supports its discovery and use. Examples include the alpha-numeric code "CCSS.MATH.CONTENT.HSA.CED.A.2" identifying a node in the U.S. Common Core State Standards on creating equations in algebra, or, the code "8021" in the U.S. Standard Industrial Classification (SIC) for identifying the occupational context for "Offices and Clinics of Dentists".

description

Text
Schema.org/description A description of the item.

disambiguatingDescription

Text
Schema.org/disambiguatingDescription A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.

educationalFramework

Text
Schema.org/educationalFramework The framework to which the resource being described is aligned.

framework

AnyURI

http://purl.org/ctdl/terms/framework Credential framework to which the entity is aligned. Frameworks may include, but are not limited to, competency frameworks and concept schemes such as industry, occupation, and instructional program codes.

frameworkName

LangString

identifier

Schema, URL | schema,Text | schema,PropertyValue
Schema.org/identifier The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.

image

Schema, URL | schema,ImageObject
Schema.org/image An image of the item. This can be a [[URL]] or a fully described [[ImageObject]].

mainEntityOfPage

Schema, URL | schema,CreativeWork
Schema.org/mainEntityOfPage Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See [background notes](/docs/datamodel.html#mainEntityBackground) for details.

name

Text
Schema.org/name The name of the item.

potentialAction

Action
Schema.org/potentialAction Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.

sameAs

URL
Schema.org/sameAs URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.

targetDescription

Text
Schema.org/targetDescription The description of a node in an established educational framework.

targetName

Text
Schema.org/targetName The name of a node in an established educational framework.

targetNode

AnyURI

http://purl.org/ctdl/terms/targetNode Individual entry in a formally defined framework such as a competency or an industry, instructional program, or occupation code. The target node returned must be the exact competency or concept being described and no other competency or concept. References to data or a document that returns all of the competencies or concepts in the framework to which the target node belongs should use the ceterms:framework property.

targetNodeDescription

LangString

http://purl.org/ctdl/terms/targetNodeDescription Textual description of an individual concept or competency in a formally defined framework.

targetNodeName

LangString

http://purl.org/ctdl/terms/targetNodeName Name of an individual concept or competency in a formally defined framework.

targetUrl

URL
Schema.org/targetUrl The URL of a node in an established educational framework.

url

URL
Schema.org/url URL of the item.

weight

Float

http://purl.org/ctdl/terms/weight Measurement of the weight, degree, percent, or strength of a recommendation, requirement, or comparison.