com.rusticisoftware.tincan

Interface LRS

All Known Implementing Classes:

RemoteLRS

public interface LRS

Define the interface that must be satisfied to talk to an LRS

Method Summary

Modifier and Type	Method and Description
AboutLRSResponse	about()
LRSResponse	clearState(Activity activity, Agent agent, UUID registration)
LRSResponse	deleteActivityProfile(ActivityProfileDocument profile)
LRSResponse	deleteAgentProfile(AgentProfileDocument profile)
LRSResponse	deleteState(StateDocument state)
StatementsResultLRSResponse	moreStatements(String moreURL)
StatementsResultLRSResponse	queryStatements(StatementsQueryInterface query)
ActivityLRSResponse	retrieveActivity(Activity activity)
ActivityProfileLRSResponse	retrieveActivityProfile(String id, Activity activity)
ProfileKeysLRSResponse	retrieveActivityProfileIds(Activity activity)
AgentProfileLRSResponse	retrieveAgentProfile(String id, Agent agent)
ProfileKeysLRSResponse	retrieveAgentProfileIds(Agent agent)
PersonLRSResponse	retrievePerson(Agent agent)
StateLRSResponse	retrieveState(String id, Activity activity, Agent agent, UUID registration)
ProfileKeysLRSResponse	retrieveStateIds(Activity activity, Agent agent, UUID registration)
StatementLRSResponse	retrieveStatement(String id)
StatementLRSResponse	retrieveStatement(String id, boolean attachments)
StatementLRSResponse	retrieveVoidedStatement(String id)
StatementLRSResponse	retrieveVoidedStatement(String id, boolean attachments)
LRSResponse	saveActivityProfile(ActivityProfileDocument profile)
LRSResponse	saveAgentProfile(AgentProfileDocument profile)
LRSResponse	saveState(StateDocument state)
StatementLRSResponse	saveStatement(Statement statement)
StatementsResultLRSResponse	saveStatements(List<Statement> statements)
LRSResponse	updateActivityProfile(ActivityProfileDocument profile)
LRSResponse	updateAgentProfile(AgentProfileDocument profile)
LRSResponse	updateState(StateDocument state)

Method Detail

about

AboutLRSResponse about()

saveStatement

StatementLRSResponse saveStatement(Statement statement)

saveStatements

StatementsResultLRSResponse saveStatements(List<Statement> statements)

retrieveStatement

StatementLRSResponse retrieveStatement(String id)

retrieveVoidedStatement

StatementLRSResponse retrieveVoidedStatement(String id)

retrieveStatement

StatementLRSResponse retrieveStatement(String id,
                                       boolean attachments)

retrieveVoidedStatement

StatementLRSResponse retrieveVoidedStatement(String id,
                                             boolean attachments)

queryStatements

StatementsResultLRSResponse queryStatements(StatementsQueryInterface query)

moreStatements

StatementsResultLRSResponse moreStatements(String moreURL)

retrieveStateIds

ProfileKeysLRSResponse retrieveStateIds(Activity activity,
                                        Agent agent,
                                        UUID registration)

retrieveState

StateLRSResponse retrieveState(String id,
                               Activity activity,
                               Agent agent,
                               UUID registration)

saveState

LRSResponse saveState(StateDocument state)

updateState

LRSResponse updateState(StateDocument state)

deleteState

LRSResponse deleteState(StateDocument state)

clearState

LRSResponse clearState(Activity activity,
                       Agent agent,
                       UUID registration)

retrieveActivity

ActivityLRSResponse retrieveActivity(Activity activity)

retrieveActivityProfileIds

ProfileKeysLRSResponse retrieveActivityProfileIds(Activity activity)

retrieveActivityProfile

ActivityProfileLRSResponse retrieveActivityProfile(String id,
                                                   Activity activity)

saveActivityProfile

LRSResponse saveActivityProfile(ActivityProfileDocument profile)

updateActivityProfile

LRSResponse updateActivityProfile(ActivityProfileDocument profile)

deleteActivityProfile

LRSResponse deleteActivityProfile(ActivityProfileDocument profile)

retrievePerson

PersonLRSResponse retrievePerson(Agent agent)

retrieveAgentProfileIds

ProfileKeysLRSResponse retrieveAgentProfileIds(Agent agent)

retrieveAgentProfile

AgentProfileLRSResponse retrieveAgentProfile(String id,
                                             Agent agent)

saveAgentProfile

LRSResponse saveAgentProfile(AgentProfileDocument profile)

updateAgentProfile

LRSResponse updateAgentProfile(AgentProfileDocument profile)

deleteAgentProfile

LRSResponse deleteAgentProfile(AgentProfileDocument profile)