Models¶
HiveModels¶
AnswersData¶
Asset¶
-
class Asset
¶ Following are the properties that the class Asset will contain.
Here are references to it’s properties:
-
String
Id
{ get; set; }¶ It is the unique string type Id of an asset that is used to uniquely identify the asset.
-
String
Assignment¶
-
class Assignment
¶ Following are the properties that the Assignment class contains.
Here are references to its properties:
-
String
User
{ get; set; }¶ It is the Id of the associated user that is selected at the time of assignment creation.
-
String
Project
{ get; set; }¶ It is the Id of the project that is selected at the time of the Assignment creation.
-
String
Task
{ get; set; }¶ It is the Id of the Task that is selected at the time of the Assignment creation.
-
Asset
Asset
{ get; set; }¶ It is the Id of the Asset that is selected at the time of the Assignment creation.
-
String
State
{ get; set; }¶ It indicates the status of an assignment either an assignment is finished or not.
-
SubmittedData
SubmittedData
{ get; set; }¶ It is an object that contains all data that is gotten from the android side on assignment completion and submission.
-
SubmittedAnswerData
SubmittedAnswerData
{ get; set; }¶ It is an object that contains only answer data that a user has submitted on completing a survey.
-
String
AssignmentCriteria¶
-
class AssignmentCriteria
¶ Following is the property that the class AssignmentCriteria contains.
Here are references to its properties:
-
SubmittedData
SubmittedData
{ get; set; }¶ It is used to contain the data submitted by a user during the survey.
-
SubmittedData
CompletionCriteria¶
CompletionCriteria -> Count¶
-
class Count
¶ Following are the properties that the class Count contains.
Here are references to its properties:
-
String
Assignments
{ get; set; }¶ It is the total number of assigments related to a specific project or a task etc.
-
Int32
finished
{ get; set; }¶ It is the total number of finished assigments related to a specific project or task etc.
-
String
CompletionCriteria -> SocialExperimentXML¶
CompletionCompletionCriteria -> submittedData¶
Metadata¶
MetaProperty¶
Project¶
-
class Project
¶ Following are the methods and properties that a project will contain on creation.
Here are references to its properties:
-
String
Id
{ get; set; }¶ It contains the unique Id of the project. It is created automatically using a timestamp so that the newly created project has a unique Id.
-
String
Name
{ get; set; }¶ It is the name of the Project provided by the user at the time of the project creation.
-
String
Description
{ get; set; }¶ It is an optional description of the project. You can skip this one.
-
Int32
AssetCount
{ get; set; }¶ It contains the total number of Assets associated with the specific project.
-
Int32
TaskCount
{ get; set; }¶ It contains the total number of Tasks associated with the specific project.
-
Int32
UserCount
{ get; set; }¶ It contains the total number of users associated with the specific project.
-
MetaProperty[]
MetaProperties
{ get; set; }¶
-
AssignmentCount
AssignmentCount
{ get; set; }¶ It contains the total number of Assignments associated with the specific project. It contains two values: ‘Total’ for the total assignments including finished or unfinished whereas the ‘Finished’ for the finished assignments count.
-
String
Project -> AssignmentCount¶
ProjectQuestionModel¶
-
class ProjectQuestionModel
¶ This is a ProjectQuestionModel class with properties, there is no method.
Here are references to its properties:
-
String
ProjectId
{ get; set; }¶ It is the Id of the project with which the question data is associated.
-
Questions
QuestionsModel
{ get; set; }¶ It is the Questions class object that has the questions data.
-
String
Record¶
SubmittedAnswerData¶
SubmittedData¶
Task¶
-
class Task
¶ Following are the properties that the class Task will contain.
Here are references to it’s properties:
-
String
Id
{ get; set; }¶ It is the unique Id of the Task created by the Hive Server at the time of task creation request.
-
String
CurrentState
{ get; set; }¶ It is the current state of the Task either it is available or not.
-
AssignmentCriteria
AssignmentCriteria
{ get; set; }¶ For details, you can view the AssignmentCriteria class.
-
CompletionCriteria
CompletionCriteria
{ get; set; }¶ For details, you can view the CompletionCriteria class.
-
String
User¶
-
class User
¶ This is an User class with properties, there is no method.
Here are references to its properties:
-
String
Id
{ get; set; }¶ It is the Id of the user i.e the unique device Id through which a user is completing an assignment.
-
String
QuestionModels¶
CombinationModel¶
-
class CombinationModel
¶ Following are the properties that the class CombinationModel contains.
Here are references to its properties
-
Int32
id
{ get; set; }¶ It is an autoincremented Id of the of choices i.e if user select two checkboxes then there will be two ids 1 and 2.
-
List<SelectionQuestionModel>
Selected
{ get; set; }¶ It is the List of the selected checkboxes.
-
Int32
jQueryDataTableParamModel¶
-
class jQueryDataTableParamModel
¶ Following are the properties that the class jQueryDataTableParamModel will contain.
Here are references to its properties
OptionModel¶
-
class OptionModel
¶ Following are the properties that the class OptionModel will contain.
Here are references to its properties
-
Int32
id
{ get; set; }¶ It is simply the Id of the option i.e if there are two option then their Ids will be 1 and 2.
-
String
Name
{ get; set; }¶ It is the text of the option i.e. the content that will be visible to the user as the option.
-
Int32
QuestionDataModel¶
-
class QuestionDataModel
¶ Following are the properties that the class QuestionDataModel contains.
Here are references to its properties
-
Int32
id
{ get; set; }¶ It is the id of the question i.e if there are two questions then their ids will be 1 and 2 respectively.
-
String
Question
{ get; set; }¶ It is the text of the question that will be visible to the user on an assignment.
-
String
Type
{ get; set; }¶ It is the type of question. It can be any one of the radio, checkbox, textbox or likertscale.
-
List<SensorModel>
Sensor
{ get; set; }¶ It is a list of the selected sensors associated with questions.
-
String
Mandatory
{ get; set; }¶ It is a check on the question either the question is compulsory to answer or not, for completion of the assignment.
-
List<OptionModel>
Option
{ get; set; }¶ It is the list of the options for the answer of the question.
-
List<CombinationModel>
Combination
{ get; set; }¶ It is the list of the checkboxes combination in case if the type of question is checkbox i.e if there are two checkboxes for a question then there are three possible combinations that allow a user to select either first checkbox or second or both.
-
Int32
Questions¶
-
class Questions
¶ Following are the properties that the class Questions contains.
Here are references to its properties
-
StartAndDestinationModel
StartAndDestinationModel
{ get; set; }¶ It conatins the start address, destination address, mode of asset and default credits.
-
List<QuestionDataModel>
SampleDataModel
{ get; set; }¶ It contains the question model.
-
StartAndDestinationModel
SelectionQuestionModel¶
SensorDataModel¶
-
class Questions
Following are the properties that the class SensorDataModel contains.
Here are references to its properties
SensorModel¶
StartAndDestinationModel¶
-
class StartAndDestinationModel
¶ Following are the properties that the class SensorModel will contain.
Here are references to it’s properties
-
String
StartLatitude
{ get; set; }¶ It is the latitude value of the start address on the map in case of sequence mode.
-
String
StartLongitude
{ get; set; }¶ It is the longitude value of the start address on the map in case of sequence mode.
-
String
DestinationLatitude
{ get; set; }¶ It is the latitude value of the destination address on the map in case of sequence mode.
-
String
DestinationLongitude
{ get; set; }¶ It is the longitude value of the destination address on the map in case of sequence mode.
-
String