Package dev.learning.xapi.model

Class Verb

java.lang.Object
dev.learning.xapi.model.Verb
public class Verb extends Object
The Verb defines the action between an Actor and an Activity.
Author:
Thomas Turrell-Croft, István Rátkai (Selindek)
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Verb.Builder
    Builder for Verb.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Verb
    ABANDONED
    Indicates that the AU session was abnormally terminated by a learner's action (or due to a system failure).
    static final Verb
    ANSWERED
    Indicates the actor replied to a question, where the object is generally an activity representing the question.
    static final Verb
    ASKED
    Indicates an inquiry by an actor with the expectation of a response or answer to a question.
    static final Verb
    ATTEMPTED
    Indicates the actor made an effort to access the object.
    static final Verb
    ATTENDED
    Indicates the actor was present at a virtual or physical event or activity.
    static final Verb
    COMMENTED
    Indicates the actor provided digital or written annotations on or about an object.
    static final Verb
    COMPLETED
    Indicates the actor finished or concluded the activity normally.
    static final Verb
    EXITED
    Indicates the actor intentionally departed from the activity or object.
    static final Verb
    EXPERIENCED
    Indicates the actor only encountered the object, and is applicable in situations where a specific achievement or completion is not required.
    static final Verb
    FAILED
    Indicates the actor did not successfully pass an activity to a level of predetermined satisfaction.
    static final Verb
    IMPORTED
    Indicates the actor introduced an object into a physical or virtual location.
    static final Verb
    INITIALIZED
    Indicates the activity provider has determined that the actor successfully started an activity.
    static final Verb
    INTERACTED
    Indicates the actor engaged with a physical or virtual object.
    static final Verb
    LAUNCHED
    Indicates the actor attempted to start an activity.
    static final Verb
    LOGGED_IN
    Indicates the actor gained access to a system or service by identifying and authenticating with the credentials provided by the actor.
    static final Verb
    LOGGED_OUT
    Indicates the actor either lost or discontinued access to a system or service.
    static final Verb
    MASTERED
    Indicates the highest level of comprehension or competence the actor performed in an activity.
    static final Verb
    PASSED
    Indicates the actor successfully passed an activity to a level of predetermined satisfaction.
    static final Verb
    PREFERRED
    Indicates the selected choices, favoured options or settings of an actor in relation to an object or activity.
    static final Verb
    PROGRESSED
    Indicates a value of how much of an actor has advanced or moved through an activity.
    static final Verb
    REGISTERED
    Indicates the actor is officially enrolled or inducted in an activity.
    static final Verb
    RESPONDED
    Indicates an actor reacted or replied to an object.
    static final Verb
    RESUMED
    Indicates the application has determined that the actor continued or reopened a suspended attempt on an activity.
    static final Verb
    SATISFIED
    Indicates that the authority or activity provider determined the actor has fulfilled the criteria of the object or activity.
    static final Verb
    SCORED
    Indicates a numerical value related to an actor's performance on an activity.
    static final Verb
    SHARED
    Indicates the actor's intent to openly provide access to an object of common interest to other actors or groups.
    static final Verb
    SUSPENDED
    Indicates the status of a temporarily halted activity when an actor's intent is returning to the or object activity at a later time.
    static final Verb
    TERMINATED
    Indicates that the actor successfully ended an activity.
    static final Verb
    VOIDED
    A special reserved verb used by a LRS or application to mark a statement as invalid.
    static final Verb
    WAIVED
    Indicates that the learning activity requirements were met by means other than completing the activity.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Verb(String id)
    Constructs a new verb.
    Verb(String id, String name)
    Constructs a new verb with id and default name for the verb.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isVoided()
    Returns true if verb is voided.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • ANSWERED

      public static final Verb ANSWERED
      Indicates the actor replied to a question, where the object is generally an activity representing the question. The text of the answer will often be included in the response inside result.
      See Also:

    • ASKED

      public static final Verb ASKED
      Indicates an inquiry by an actor with the expectation of a response or answer to a question.
      See Also:

    • ATTEMPTED

      public static final Verb ATTEMPTED
      Indicates the actor made an effort to access the object. An attempt statement without additional activities could be considered incomplete in some cases.
      See Also:

    • ATTENDED

      public static final Verb ATTENDED
      Indicates the actor was present at a virtual or physical event or activity.
      See Also:

    • COMMENTED

      public static final Verb COMMENTED
      Indicates the actor provided digital or written annotations on or about an object.
      See Also:

    • EXITED

      public static final Verb EXITED
      Indicates the actor intentionally departed from the activity or object.
      See Also:

    • EXPERIENCED

      public static final Verb EXPERIENCED
      Indicates the actor only encountered the object, and is applicable in situations where a specific achievement or completion is not required.
      See Also:

    • IMPORTED

      public static final Verb IMPORTED
      Indicates the actor introduced an object into a physical or virtual location.
      See Also:

    • INTERACTED

      public static final Verb INTERACTED
      Indicates the actor engaged with a physical or virtual object.
      See Also:

    • LAUNCHED

      public static final Verb LAUNCHED
      Indicates the actor attempted to start an activity.
      See Also:

    • MASTERED

      public static final Verb MASTERED
      Indicates the highest level of comprehension or competence the actor performed in an activity.
      See Also:

    • PREFERRED

      public static final Verb PREFERRED
      Indicates the selected choices, favoured options or settings of an actor in relation to an object or activity.
      See Also:

    • PROGRESSED

      public static final Verb PROGRESSED
      Indicates a value of how much of an actor has advanced or moved through an activity.
      See Also:

    • REGISTERED

      public static final Verb REGISTERED
      Indicates the actor is officially enrolled or inducted in an activity.
      See Also:

    • SHARED

      public static final Verb SHARED
      Indicates the actor's intent to openly provide access to an object of common interest to other actors or groups.
      See Also:

    • VOIDED

      public static final Verb VOIDED
      A special reserved verb used by a LRS or application to mark a statement as invalid. See the xAPI specification for details on Voided statements.
      See Also:

    • LOGGED_IN

      public static final Verb LOGGED_IN
      Indicates the actor gained access to a system or service by identifying and authenticating with the credentials provided by the actor.
      See Also:

    • LOGGED_OUT

      public static final Verb LOGGED_OUT
      Indicates the actor either lost or discontinued access to a system or service.
      See Also:

    • COMPLETED

      public static final Verb COMPLETED
      Indicates the actor finished or concluded the activity normally.
      See Also:

    • FAILED

      public static final Verb FAILED
      Indicates the actor did not successfully pass an activity to a level of predetermined satisfaction.
      See Also:

    • INITIALIZED

      public static final Verb INITIALIZED
      Indicates the activity provider has determined that the actor successfully started an activity.
      See Also:

    • PASSED

      public static final Verb PASSED
      Indicates the actor successfully passed an activity to a level of predetermined satisfaction.
      See Also:

    • RESPONDED

      public static final Verb RESPONDED
      Indicates an actor reacted or replied to an object.
      See Also:

    • RESUMED

      public static final Verb RESUMED
      Indicates the application has determined that the actor continued or reopened a suspended attempt on an activity.
      See Also:

    • SCORED

      public static final Verb SCORED
      Indicates a numerical value related to an actor's performance on an activity.
      See Also:

    • SUSPENDED

      public static final Verb SUSPENDED
      Indicates the status of a temporarily halted activity when an actor's intent is returning to the or object activity at a later time.
      See Also:

    • TERMINATED

      public static final Verb TERMINATED
      Indicates that the actor successfully ended an activity.
      See Also:

    • ABANDONED

      public static final Verb ABANDONED
      Indicates that the AU session was abnormally terminated by a learner's action (or due to a system failure).
      See Also:

    • WAIVED

      public static final Verb WAIVED
      Indicates that the learning activity requirements were met by means other than completing the activity. A waived statement is used to indicate that the activity may be skipped by the actor.
      See Also:

    • SATISFIED

      public static final Verb SATISFIED
      Indicates that the authority or activity provider determined the actor has fulfilled the criteria of the object or activity.
      See Also:

  • Constructor Details

    • Verb

      public Verb(String id)
      Constructs a new verb.
      Parameters:
      id - the id

    • Verb

      public Verb(String id, String name)
      Constructs a new verb with id and default name for the verb.
      Parameters:
      id - the id
      name - the human readable representation of the Verb

  • Method Details

    • isVoided

      public boolean isVoided()
      Returns true if verb is voided.
      Returns:
      true if the verb is voided