public interface RequisiteLookupSession extends OsidSession
This session defines methods for retrieving requirements and requirement components.
This lookup session defines several views:
Requisites
with the Requisite
AdminSession.
The methods useFederatedCourseCatalogView()
and
useIsolatedCourseCatalogView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Requisites may have an additional records indicated by their
respective record types. The record may not be accessed through a cast of
the Requisite.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupRequisites()
Tests if this user can perform
Requisite and component
lookups. |
AssessmentRequirement |
getAssessmentRequirement(Id assessmentRequirementId)
Gets the
AssessmentRequirement specified by its
Id. |
AssessmentRequirementList |
getAssessmentRequirements()
Gets all
AssessmentRequirements. |
AssessmentRequirementList |
getAssessmentRequirementsByAltRequisite(Id requisiteId)
Gets an
AssessmentRequirementList with the given
Requisite. |
AssessmentRequirementList |
getAssessmentRequirementsByAssessment(Id assessmentId)
Gets an
AssessmentRequirementList containing the given
assessment. |
AssessmentRequirementList |
getAssessmentRequirementsByGenusType(Type assessmentRequirementGenusType)
Gets an
AssessmentRequirementList corresponding to the
given assessment requirement genus Type which does not
include assessment requirements of types derived from the specified
Type. |
AssessmentRequirementList |
getAssessmentRequirementsByIds(IdList assessmentRequirementIds)
Gets an
AssessmentRequirementList corresponding to the
given IdList. |
AssessmentRequirementList |
getAssessmentRequirementsByParentGenusType(Type assessmentRequirementGenusType)
Gets an
AssessmentRequirementList corresponding to the
given assessment requirement genus Type and include any
additional assessment requirements with genus types derived from the
specified Type. |
AssessmentRequirementList |
getAssessmentRequirementsByRecordType(Type assessmentRequirementRecordType)
Gets an
AssessmentRequirementList containing the given
assessment requirement record Type. |
AwardRequirement |
getAwardRequirement(Id awardRequirementId)
Gets the
AwardRequirement specified by its Id. |
AwardRequirementList |
getAwardRequirements()
Gets all
AwardRequirements. |
AwardRequirementList |
getAwardRequirementsByAltRequisite(Id requisiteId)
Gets an
AwardRequirementList with the given
Requisite. |
AwardRequirementList |
getAwardRequirementsByAward(Id awardId)
Gets an
AwardRequirementList containing the given
award. |
AwardRequirementList |
getAwardRequirementsByGenusType(Type awardRequirementGenusType)
Gets an
AwardRequirementList corresponding to the given
award requirement genus Type which does not include
award requirements of types derived from the specified Type. |
AwardRequirementList |
getAwardRequirementsByIds(IdList awardRequirementIds)
Gets an
AwardRequirementList corresponding to the given
IdList. |
AwardRequirementList |
getAwardRequirementsByParentGenusType(Type awardRequirementGenusType)
Gets an
AwardRequirementList corresponding to the given
award requirement genus Type and include any additional
award requirements with genus types derived from the specified
Type. |
AwardRequirementList |
getAwardRequirementsByRecordType(Type awardRequirementRecordType)
Gets an
AwardRequirementList containing the given award
requirement record Type. |
CourseCatalog |
getCourseCatalog()
Gets the
CourseCatalog associated with this session. |
Id |
getCourseCatalogId()
Gets the
CourseCatalog Id associated
with this session. |
CourseRequirement |
getCourseRequirement(Id courseRequirementId)
Gets the
CourseRequirement specified by its Id. |
CourseRequirementList |
getCourseRequirements()
Gets all
CourseRequirements. |
CourseRequirementList |
getCourseRequirementsByAltRequisite(Id requisiteId)
Gets a
CourseRequirementList with the given
Requisite. |
CourseRequirementList |
getCourseRequirementsByCourse(Id courseId)
Gets a
CourseRequirementList containing the given
course. |
CourseRequirementList |
getCourseRequirementsByGenusType(Type courseRequirementGenusType)
Gets a
CourseRequirementList corresponding to the given
course requirement genus Type which does not include
course requirements of types derived from the specified Type. |
CourseRequirementList |
getCourseRequirementsByIds(IdList courseRequirementIds)
Gets a
CourseRequirementList corresponding to the given
IdList. |
CourseRequirementList |
getCourseRequirementsByParentGenusType(Type courseRequirementGenusType)
Gets a
CourseRequirementList corresponding to the given
course requirement genus Type and include any
additional course requirements with genus types derived from the
specified Type. |
CourseRequirementList |
getCourseRequirementsByRecordType(Type courseRequirementRecordType)
Gets a
CourseRequirementList containing the given
course requirement record Type. |
CredentialRequirement |
getCredentialRequirement(Id credentialRequirementId)
Gets the
CredentialRequirement specified by its
Id. |
CredentialRequirementList |
getCredentialRequirements()
Gets all
CredentialRequirements. |
CredentialRequirementList |
getCredentialRequirementsByAltRequisite(Id requisiteId)
Gets a
CredentialRequirementList with the given
Requisite. |
CredentialRequirementList |
getCredentialRequirementsByCredential(Id credentialId)
Gets a
CredentialRequirementList containing the given
credential. |
CredentialRequirementList |
getCredentialRequirementsByGenusType(Type credentialRequirementGenusType)
Gets a
CredentialRequirementList corresponding to the
given credential requirement genus Type which does not
include credential requirements of types derived from the specified
Type. |
CredentialRequirementList |
getCredentialRequirementsByIds(IdList credentialRequirementIds)
Gets a
CredentialRequirementList corresponding to the
given IdList. |
CredentialRequirementList |
getCredentialRequirementsByParentGenusType(Type credentialRequirementGenusType)
Gets a
CredentialRequirementList corresponding to the
given credential requirement genus Type and include any
additional credential requirements with genus types derived from the
specified Type. |
CredentialRequirementList |
getCredentialRequirementsByRecordType(Type credentialRequirementRecordType)
Gets a
CredentialRequirementList containing the given
credential requirement record Type. |
LearningObjectiveRequirement |
getLearningObjectiveRequirement(Id learningObjectiveRequirementId)
Gets the
LearningObjectiveRequirement specified by its
Id. |
LearningObjectiveRequirementList |
getLearningObjectiveRequirements()
Gets all
LearningObjectiveRequirements. |
LearningObjectiveRequirementList |
getLearningObjectiveRequirementsByAltRequisite(Id requisiteId)
Gets a
LearningObjectiveRequirementList with the given
Requisite. |
LearningObjectiveRequirementList |
getLearningObjectiveRequirementsByGenusType(Type learningObjectiveRequirementGenusType)
Gets a
LearningObjectiveRequirementList corresponding
to the given learning objective requirement genus Type
which does not include learning objective requirements of types
derived from the specified Type. |
LearningObjectiveRequirementList |
getLearningObjectiveRequirementsByIds(IdList learningObjectiveRequirementIds)
Gets a
LearningObjectiveRequirementList corresponding
to the given IdList. |
LearningObjectiveRequirementList |
getLearningObjectiveRequirementsByObjective(Id objectiveId)
Gets a
LearningObjectiveRequirementList containing the
given learning objective. |
LearningObjectiveRequirementList |
getLearningObjectiveRequirementsByParentGenusType(Type learningObjectiveRequirementGenusType)
Gets a
LearningObjectiveRequirementList corresponding
to the given learning objective requirement genus Type
and include any additional learning objective requirements with genus
types derived from the specified Type. |
LearningObjectiveRequirementList |
getLearningObjectiveRequirementsByRecordType(Type learningObjectiveRequirementRecordType)
Gets a
LearningObjectiveRequirementList containing the
given learning objective requirement record Type. |
ProgramRequirement |
getProgramRequirement(Id programRequirementId)
Gets the
ProgramRequirement specified by its Id. |
ProgramRequirementList |
getProgramRequirements()
Gets all
ProgramRequirements. |
ProgramRequirementList |
getProgramRequirementsByAltRequisite(Id requisiteId)
Gets a
ProgramRequirementList with the given
Requisite. |
ProgramRequirementList |
getProgramRequirementsByGenusType(Type programRequirementGenusType)
Gets a
ProgramRequirementList corresponding to the
given program requirement genus Type which does not
include program requirements of types derived from the specified
Type. |
ProgramRequirementList |
getProgramRequirementsByIds(IdList programRequirementIds)
Gets a
ProgramRequirementList corresponding to the
given IdList. |
ProgramRequirementList |
getProgramRequirementsByParentGenusType(Type programRequirementGenusType)
Gets a
ProgramRequirementList corresponding to the
given program requirement genus Type and include any
additional program requirements with genus types derived from the
specified Type. |
ProgramRequirementList |
getProgramRequirementsByProgram(Id programId)
Gets a
ProgramRequirementList containing the given
program. |
ProgramRequirementList |
getProgramRequirementsByRecordType(Type programRequirementRecordType)
Gets a
ProgramRequirementList containing the given
program requirement record Type. |
Requisite |
getRequisite(Id requisiteId)
Gets the
Requisite specified by its Id. |
RequisiteList |
getRequisites()
Gets all
Requisites. |
RequisiteList |
getRequisitesByGenusType(Type requisiteGenusType)
Gets a
RequisiteList corresponding to the given
requisite genus Type which does not include requisites
of types derived from the specified Type. |
RequisiteList |
getRequisitesByIds(IdList requisiteIds)
Gets a
RequisiteList corresponding to the given
IdList. |
RequisiteList |
getRequisitesByParentGenusType(Type requisiteGenusType)
Gets a
RequisiteList corresponding to the given
requisite genus Type and include any additional
requisites with genus types derived from the specified Type. |
RequisiteList |
getRequisitesByRecordType(Type requisiteRecordType)
Gets a
RequisiteList containing the given requisite
record Type. |
RequisiteList |
getRequisitesForAssessmentRequirement(Id assessmentRequirementId)
Gets a
RequisiteList immediately containing the given
assessment requirement. |
RequisiteList |
getRequisitesForAwardRequirement(Id awardRequirementId)
Gets a
RequisiteList immediately containing the given
award requirement. |
RequisiteList |
getRequisitesForCourseRequirement(Id courseRequirementId)
Gets a
RequisiteList immediately containing the given
course requirement. |
RequisiteList |
getRequisitesForCredentialRequirement(Id credentialRequirementId)
Gets a
RequisiteList immediately containing the given
credential requirement. |
RequisiteList |
getRequisitesForLearningObjectiveRequirement(Id learningObjectiveRequirementId)
Gets a
RequisiteList immediately containing the given
learning objective requirement. |
RequisiteList |
getRequisitesForProgramRequirement(Id programRequirementId)
Gets a
RequisiteList immediately containing the given
program requirement. |
RequisiteList |
getRequisitesForRequisiteOption(Id requisiteOptionId)
Gets a
RequisiteList immediately containing the given
requisite option. |
void |
useActiveRequisiteView()
Only active requisites are returned by methods in this session.
|
void |
useAnyStatusRequisiteView()
All active and inactive requisites are returned by methods in this
session.
|
void |
useComparativeRequisiteView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useFederatedCourseCatalogView()
Federates the view for methods in this session.
|
void |
useIsolatedCourseCatalogView()
Isolates the view for methods in this session.
|
void |
usePlenaryRequisiteView()
A complete view of the
Requisite returns is desired. |
void |
useSequesteredRequisiteView()
The returns from the lookup methods omit sequestered requisites.
|
void |
useUnsequesteredRequisiteView()
All requisites are returned including sequestered requisites.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCourseCatalogId()
CourseCatalog
Id
associated
with this session. CourseCatalog Id
associated with this
sessionmandatory
- This method must be implemented. CourseCatalog getCourseCatalog() throws OperationFailedException, PermissionDeniedException
CourseCatalog
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupRequisites()
Requisite
and component
lookups. A return of true does not guarantee successful authorization.
A return of false indicates that it is known all methods in this
session will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may not offer lookup
operations to unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRequisiteView()
mandatory
- This method is must be implemented. void usePlenaryRequisiteView()
Requisite
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedCourseCatalogView()
mandatory
- This method is must be implemented. void useIsolatedCourseCatalogView()
mandatory
- This method is must be implemented. void useActiveRequisiteView()
mandatory
- This method is must be implemented. void useAnyStatusRequisiteView()
mandatory
- This method is must be implemented. void useSequesteredRequisiteView()
mandatory
- This method is must be implemented. void useUnsequesteredRequisiteView()
mandatory
- This method is must be implemented. Requisite getRequisite(Id requisiteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Requisite
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Requisite
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a Requisite
and retained for compatibility.
In active mode, requisites are returned that are currently active. In
any status mode, active and inactive requisites are returned.
In sequestered mode, no sequestered requisites are returned. In
unsequestered mode, all requisites are returned.requisiteId
- the Id
of the Requisite
to retrieve requisite
NotFoundException
- no Requisite
found
with the given Id
NullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesByIds(IdList requisiteIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
RequisiteList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
requisites specified in the Id
list, in the order of
the list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Requisites
may be omitted from the list
and may present the elements in any order including returning a unique
set.
In active mode, requisites are returned that are currently active. In
any status mode, active and inactive requisites are returned.
In sequestered mode, no sequestered requisites are returned. In
unsequestered mode, all requisites are returned.requisiteIds
- the list of Ids
to retrieve RequisiteList
NotFoundException
- an Id was
not foundNullArgumentException
- requisiteIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesByGenusType(Type requisiteGenusType) throws OperationFailedException, PermissionDeniedException
RequisiteList
corresponding to the given
requisite genus Type
which does not include requisites
of types derived from the specified Type.
In plenary mode, the returned list contains all known
requisites or an error results. Otherwise, the returned list may
contain only those requisites that are accessible through this
session.
In active mode, requisites are returned that are currently active. In
any status mode, active and inactive requisites are returned.
In sequestered mode, no sequestered requisites are returned. In
unsequestered mode, all requisites are returned.requisiteGenusType
- a requisite genus type RequisiteList
NullArgumentException
- requisiteGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesByParentGenusType(Type requisiteGenusType) throws OperationFailedException, PermissionDeniedException
RequisiteList
corresponding to the given
requisite genus Type
and include any additional
requisites with genus types derived from the specified Type.
In plenary mode, the returned list contains all known
requisites or an error results. Otherwise, the returned list may
contain only those requisites that are accessible through this
session.
In active mode, requisites are returned that are currently active. In
any status mode, active and inactive requisites are returned.
In sequestered mode, no sequestered requisites are returned. In
unsequestered mode, all requisites are returned.requisiteGenusType
- a requisite genus type RequisiteList
NullArgumentException
- requisiteGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesByRecordType(Type requisiteRecordType) throws OperationFailedException, PermissionDeniedException
RequisiteList
containing the given requisite
record Type.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, requisites are returned that are currently active. In
any status mode, active and inactive requisites are returned.
In sequestered mode, no sequestered requisites are returned. In
unsequestered mode, all requisites are returned.requisiteRecordType
- a requisite record type RequisiteList
listNullArgumentException
- requisiteRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesForRequisiteOption(Id requisiteOptionId) throws OperationFailedException, PermissionDeniedException
RequisiteList
immediately containing the given
requisite option.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, requisites are returned that are currently active. In
any status mode, active and inactive requisites are returned.
In sequestered mode, no sequestered requisites are returned. In
unsequestered mode, all requisites are returned.requisiteOptionId
- a requisite option Id
RequisiteList
NullArgumentException
- requisiteOptionId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisites() throws OperationFailedException, PermissionDeniedException
Requisites.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, requisites are returned that are currently active. In
any status mode, active and inactive requisites are returned.
In sequestered mode, no sequestered requisites are returned. In
unsequestered mode, all requisites are returned. Requisites
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseRequirement getCourseRequirement(Id courseRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseRequirement
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CourseRequirement
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a CourseRequirement
and retained for
compatibility.
In active mode, course requirements are returned that are currently
active. In any status mode, active and inactive course requirements
are returned.courseRequirementId
- the Id
of the
CourseRequirement
to retrieve CourseRequirement
NotFoundException
- no CourseRequirement
found with the given Id
NullArgumentException
- courseRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseRequirementList getCourseRequirementsByIds(IdList courseRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CourseRequirementList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
course requirements specified in the Id
list, in the
order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible CourseRequirements
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, course requirements are returned that are currently
active. In any status mode, active and inactive course requirements
are returned.courseRequirementIds
- the list of Ids
to
retrieve CourseRequirementList
listNotFoundException
- an Id was
not foundNullArgumentException
- courseRequirementIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseRequirementList getCourseRequirementsByGenusType(Type courseRequirementGenusType) throws OperationFailedException, PermissionDeniedException
CourseRequirementList
corresponding to the given
course requirement genus Type
which does not include
course requirements of types derived from the specified Type.
In plenary mode, the returned list contains all known
course requirements or an error results. Otherwise, the returned list
may contain only those course requirements that are accessible through
this session.
In active mode, course requirements are returned that are currently
active. In any status mode, active and inactive course requirements
are returned.courseRequirementGenusType
- a course requirement genus type CourseRequirementList
NullArgumentException
-
courseRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseRequirementList getCourseRequirementsByParentGenusType(Type courseRequirementGenusType) throws OperationFailedException, PermissionDeniedException
CourseRequirementList
corresponding to the given
course requirement genus Type
and include any
additional course requirements with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
course requirements or an error results. Otherwise, the returned list
may contain only those course requirements that are accessible through
this session.
In active mode, course requirements are returned that are currently
active. In any status mode, active and inactive course requirements
are returned.courseRequirementGenusType
- a course requirements genus type CourseRequirementList
NullArgumentException
-
courseRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseRequirementList getCourseRequirementsByRecordType(Type courseRequirementRecordType) throws OperationFailedException, PermissionDeniedException
CourseRequirementList
containing the given
course requirement record Type.
In plenary mode, the returned list contains all known course
requirements or an error results. Otherwise, the returned list may
contain only those course requirements that are accessible through
this session.
In active mode, course requirements are returned that are currently
active. In any status mode, active and inactive course requirements
are returned.courseRequirementRecordType
- a course requirement record type CourseRequirementList
NullArgumentException
-
courseRequirementRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseRequirementList getCourseRequirementsByCourse(Id courseId) throws OperationFailedException, PermissionDeniedException
CourseRequirementList
containing the given
course.
In plenary mode, the returned list contains all known course
requirements or an error results. Otherwise, the returned list may
contain only those course requirements that are accessible through
this session.
In active mode, course requirements are returned that are currently
active. In any status mode, active and inactive course requirements
are returned.courseId
- a course Id
CourseRequirementList
NullArgumentException
- courseId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseRequirementList getCourseRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
CourseRequirementList
with the given
Requisite.
In plenary mode, the returned list contains all known course
requirements or an error results. Otherwise, the returned list may
contain only those course requirements that are accessible through
this session.
In active mode, course requirements are returned that are currently
active. In any status mode, active and inactive course requirements
are returned.requisiteId
- a requisite Id
CourseRequirementList
NullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesForCourseRequirement(Id courseRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteList
immediately containing the given
course requirement.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, course requirements are processed and requisites are
returned that are currently active. In any status mode, active and
inactive requisites are returned.courseRequirementId
- a course requirement Id
RequisiteList
NullArgumentException
- courseRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CourseRequirementList getCourseRequirements() throws OperationFailedException, PermissionDeniedException
CourseRequirements.
In plenary mode, the returned list contains all known course
requirements or an error results. Otherwise, the returned list may
contain only those course requirements that are accessible through
this session.
In active mode, course requirements are returned that are currently
active. In any status mode, active and inactive course requirements
are returned. CourseRequirements
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramRequirement getProgramRequirement(Id programRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProgramRequirement
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
ProgramRequirement
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to a ProgramRequirement
and retained for
compatibility.
In active mode, program requirements are returned that are currently
active. In any status mode, active and inactive program requirements
are returned.programRequirementId
- the Id
of the
ProgramRequirement
to retrieve ProgramRequirement
NotFoundException
- no ProgramRequirement
found with the given Id
NullArgumentException
- programRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramRequirementList getProgramRequirementsByIds(IdList programRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
ProgramRequirementList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
program requirements specified in the Id
list, in the
order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible ProgramRequirements
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, program requirements are returned that are currently
active. In any status mode, active and inactive program requirements
are returned.programRequirementIds
- the list of Ids
to
retrieve ProgramRequirementList
listNotFoundException
- an Id was
not foundNullArgumentException
- programRequirementIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramRequirementList getProgramRequirementsByGenusType(Type programRequirementGenusType) throws OperationFailedException, PermissionDeniedException
ProgramRequirementList
corresponding to the
given program requirement genus Type
which does not
include program requirements of types derived from the specified
Type.
In plenary mode, the returned list contains all known
program requirements or an error results. Otherwise, the returned list
may contain only those program requirements that are accessible
through this session.
In active mode, program requirements are returned that are currently
active. In any status mode, active and inactive program requirements
are returned.programRequirementGenusType
- a program requirement genus type ProgramRequirementList
NullArgumentException
-
programRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramRequirementList getProgramRequirementsByParentGenusType(Type programRequirementGenusType) throws OperationFailedException, PermissionDeniedException
ProgramRequirementList
corresponding to the
given program requirement genus Type
and include any
additional program requirements with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
program requirements or an error results. Otherwise, the returned list
may contain only those program requirements that are accessible
through this session.
In active mode, program requirements are returned that are currently
active. In any status mode, active and inactive program requirements
are returned.programRequirementGenusType
- a program requirements genus type ProgramRequirementList
NullArgumentException
-
programRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramRequirementList getProgramRequirementsByRecordType(Type programRequirementRecordType) throws OperationFailedException, PermissionDeniedException
ProgramRequirementList
containing the given
program requirement record Type.
In plenary mode, the returned list contains all known program
requirements or an error results. Otherwise, the returned list may
contain only those program requirements that are accessible through
this session.
In active mode, program requirements are returned that are currently
active. In any status mode, active and inactive program requirements
are returned.programRequirementRecordType
- a program requirement record type ProgramRequirementList
NullArgumentException
-
programRequirementRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramRequirementList getProgramRequirementsByProgram(Id programId) throws OperationFailedException, PermissionDeniedException
ProgramRequirementList
containing the given
program.
In plenary mode, the returned list contains all known program
requirements or an error results. Otherwise, the returned list may
contain only those program requirements that are accessible through
this session.
In active mode, program requirements are returned that are currently
active. In any status mode, active and inactive program requirements
are returned.programId
- a program Id
ProgramRequirementList
NullArgumentException
- programId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramRequirementList getProgramRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
ProgramRequirementList
with the given
Requisite.
In plenary mode, the returned list contains all known program
requirements or an error results. Otherwise, the returned list may
contain only those program requirements that are accessible through
this session.
In active mode, program requirements are returned that are currently
active. In any status mode, active and inactive program requirements
are returned.requisiteId
- a requisite Id
ProgramRequirementList
NullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesForProgramRequirement(Id programRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteList
immediately containing the given
program requirement.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, program requirements are processed and requisites are
returned that are currently active. In any status mode, active and
inactive requisites are returned.programRequirementId
- a program requirement Id
RequisiteList
NullArgumentException
- programRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ProgramRequirementList getProgramRequirements() throws OperationFailedException, PermissionDeniedException
ProgramRequirements.
In plenary mode, the returned list contains all known program
requirements or an error results. Otherwise, the returned list may
contain only those program requirements that are accessible through
this session.
In active mode, program requirements are returned that are currently
active. In any status mode, active and inactive program requirements
are returned. ProgramRequirements
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialRequirement getCredentialRequirement(Id credentialRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
CredentialRequirement
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
CredentialRequirement
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a CredentialRequirement
and retained
for compatibility.
In active mode, credential requirements are returned that are
currently active. In any status mode, active and inactive credential
requirements are returned.credentialRequirementId
- the Id
of the
CredentialRequirement
to retrieve CredentialRequirement
NotFoundException
- no CredentialRequirement
found with the given Id
NullArgumentException
- credentialRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialRequirementList getCredentialRequirementsByIds(IdList credentialRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
CredentialRequirementList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
credential requirements specified in the Id
list, in
the order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible CredentialRequirements
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, credential requirements are returned that are
currently active. In any status mode, active and inactive credential
requirements are returned.credentialRequirementIds
- the list of Ids
to
retrieve CredentialRequirementList
listNotFoundException
- an Id was
not foundNullArgumentException
- credentialRequirementIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialRequirementList getCredentialRequirementsByGenusType(Type credentialRequirementGenusType) throws OperationFailedException, PermissionDeniedException
CredentialRequirementList
corresponding to the
given credential requirement genus Type
which does not
include credential requirements of types derived from the specified
Type.
In plenary mode, the returned list contains all known
credential requirements or an error results. Otherwise, the returned
list may contain only those credential requirements that are
accessible through this session.
In active mode, credential requirements are returned that are
currently active. In any status mode, active and inactive credential
requirements are returned.credentialRequirementGenusType
- a credential requirement genus
type CredentialRequirementList
NullArgumentException
-
credentialRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialRequirementList getCredentialRequirementsByParentGenusType(Type credentialRequirementGenusType) throws OperationFailedException, PermissionDeniedException
CredentialRequirementList
corresponding to the
given credential requirement genus Type
and include any
additional credential requirements with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
credential requirements or an error results. Otherwise, the returned
list may contain only those credential requirements that are
accessible through this session.
In active mode, credential requirements are returned that are
currently active. In any status mode, active and inactive credential
requirements are returned.credentialRequirementGenusType
- a credential requirements genus
type CredentialRequirementList
NullArgumentException
-
credentialRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialRequirementList getCredentialRequirementsByRecordType(Type credentialRequirementRecordType) throws OperationFailedException, PermissionDeniedException
CredentialRequirementList
containing the given
credential requirement record Type.
In plenary mode, the returned list contains all known credential
requirements or an error results. Otherwise, the returned list may
contain only those credential requirements that are accessible through
this session.
In active mode, credential requirements are returned that are
currently active. In any status mode, active and inactive credential
requirements are returned.credentialRequirementRecordType
- a credential requirement
record type CredentialRequirementList
NullArgumentException
-
credentialRequirementRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialRequirementList getCredentialRequirementsByCredential(Id credentialId) throws OperationFailedException, PermissionDeniedException
CredentialRequirementList
containing the given
credential.
In plenary mode, the returned list contains all known credential
requirements or an error results. Otherwise, the returned list may
contain only those credential requirements that are accessible through
this session.
In active mode, credential requirements are returned that are
currently active. In any status mode, active and inactive credential
requirements are returned.credentialId
- a credential Id
CredentialRequirementList
NullArgumentException
- credentialId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialRequirementList getCredentialRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
CredentialRequirementList
with the given
Requisite.
In plenary mode, the returned list contains all known credential
requirements or an error results. Otherwise, the returned list may
contain only those credential requirements that are accessible through
this session.
In active mode, credential requirements are returned that are
currently active. In any status mode, active and inactive credential
requirements are returned.requisiteId
- a requisite Id
CredentialRequirementList
NullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesForCredentialRequirement(Id credentialRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteList
immediately containing the given
credential requirement.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, credential requirements are processed and requisites
are returned that are currently active. In any status mode, active and
inactive requisites are returned.credentialRequirementId
- a credential requirement Id
RequisiteList
NullArgumentException
- credentialRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. CredentialRequirementList getCredentialRequirements() throws OperationFailedException, PermissionDeniedException
CredentialRequirements.
In plenary mode, the returned list contains all known credential
requirements or an error results. Otherwise, the returned list may
contain only those credential requirements that are accessible through
this session.
In active mode, credential requirements are returned that are
currently active. In any status mode, active and inactive credential
requirements are returned. CredentialRequirements
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LearningObjectiveRequirement getLearningObjectiveRequirement(Id learningObjectiveRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
LearningObjectiveRequirement
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
LearningObjectiveRequirement
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to a LearningObjectiveRequirement
and retained for compatibility.
In active mode, learning objective requirements are returned that are
currently active. In any status mode, active and inactive learning
objective requirements are returned.learningObjectiveRequirementId
- the Id
of the
LearningObjectiveRequirement
to retrieve LearningObjectiveRequirement
NotFoundException
- no
LearningObjectiveRequirement
found with the given
Id
NullArgumentException
-
learningObjectiveRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LearningObjectiveRequirementList getLearningObjectiveRequirementsByIds(IdList learningObjectiveRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
LearningObjectiveRequirementList
corresponding
to the given IdList.
In plenary mode, the returned list contains all of the
learning objective requirements specified in the Id
list, in the order of the list, including duplicates, or an error
results if an Id
in the supplied list is not found or
inaccessible. Otherwise, inaccessible
LearningObjectiveRequirements
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In active mode, learning objective requirements are returned that are
currently active. In any status mode, active and inactive learning
objective requirements are returned.learningObjectiveRequirementIds
- the list of Ids
to retrieve LearningObjectiveRequirement
listNotFoundException
- an Id was
not foundNullArgumentException
-
learningObjectiveRequirementIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LearningObjectiveRequirementList getLearningObjectiveRequirementsByGenusType(Type learningObjectiveRequirementGenusType) throws OperationFailedException, PermissionDeniedException
LearningObjectiveRequirementList
corresponding
to the given learning objective requirement genus Type
which does not include learning objective requirements of types
derived from the specified Type.
In plenary mode, the returned list contains all known
learning objective requirements or an error results. Otherwise, the
returned list may contain only those learning objective requirements
that are accessible through this session.
In active mode, learning objective requirements are returned that are
currently active. In any status mode, active and inactive learning
objective requirements are returned.learningObjectiveRequirementGenusType
- a learning objective
requirement genus type LearningObjectiveRequirementList
NullArgumentException
-
learningObjectiveRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LearningObjectiveRequirementList getLearningObjectiveRequirementsByParentGenusType(Type learningObjectiveRequirementGenusType) throws OperationFailedException, PermissionDeniedException
LearningObjectiveRequirementList
corresponding
to the given learning objective requirement genus Type
and include any additional learning objective requirements with genus
types derived from the specified Type.
In plenary mode, the returned list contains all known
learning objective requirements or an error results. Otherwise, the
returned list may contain only those learning objective requirements
that are accessible through this session.
In active mode, learning objective requirements are returned that are
currently active. In any status mode, active and inactive learning
objective requirements are returned.learningObjectiveRequirementGenusType
- a learning objective
requirements genus type LearningObjectiveRequirementList
NullArgumentException
-
learningObjectiveRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LearningObjectiveRequirementList getLearningObjectiveRequirementsByRecordType(Type learningObjectiveRequirementRecordType) throws OperationFailedException, PermissionDeniedException
LearningObjectiveRequirementList
containing the
given learning objective requirement record Type.
In plenary mode, the returned list contains all known learning
objective requirements or an error results. Otherwise, the returned
list may contain only those learning objective requirements that are
accessible through this session.
In active mode, learning objective requirements are returned that are
currently active. In any status mode, active and inactive learning
objective requirements are returned.learningObjectiveRequirementRecordType
- a learning objective
requirement record type LearningObjectiveRequirementList
NullArgumentException
-
learningObjectiverequirementRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LearningObjectiveRequirementList getLearningObjectiveRequirementsByObjective(Id objectiveId) throws OperationFailedException, PermissionDeniedException
LearningObjectiveRequirementList
containing the
given learning objective.
In plenary mode, the returned list contains all known learning
objective requirements or an error results. Otherwise, the returned
list may contain only those learning objective requirements that are
accessible through this session.
In active mode, learning objective requirements are returned that are
currently active. In any status mode, active and inactive learning
objective requirements are returned.objectiveId
- a learning objective Id
LearningObjectiveRequirementList
NullArgumentException
- objectiveId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LearningObjectiveRequirementList getLearningObjectiveRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
LearningObjectiveRequirementList
with the given
Requisite.
In plenary mode, the returned list contains all known learning
objective requirements or an error results. Otherwise, the returned
list may contain only those learning objective requirements that are
accessible through this session.
In active mode, learning objective requirements are returned that are
currently active. In any status mode, active and inactive learning
objective requirements are returned.requisiteId
- a requisite Id
LearningObjectiveRequirementList
NullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesForLearningObjectiveRequirement(Id learningObjectiveRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteList
immediately containing the given
learning objective requirement.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, learning objective requirements are processed and
requisites are returned that are currently active. In any status mode,
active and inactive requirements are returned.learningObjectiveRequirementId
- a learning objective
requirement Id
RequisiteList
NullArgumentException
-
learningObjectiveRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. LearningObjectiveRequirementList getLearningObjectiveRequirements() throws OperationFailedException, PermissionDeniedException
LearningObjectiveRequirements.
In plenary mode, the returned list contains all known learning
objective requirements or an error results. Otherwise, the returned
list may contain only those learning objective requirements that are
accessible through this session.
In active mode, learning objective requirements are returned that are
currently active. In any status mode, active and inactive learning
objective requirements are returned. LearningObjectiveRequirements
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentRequirement getAssessmentRequirement(Id assessmentRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentRequirement
specified by its
Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AssessmentRequirement
may have a different Id
than requested, such as the case where a duplicate Id
was assigned to an AssessmentRequirement
and retained
for compatibility.
In active mode, assessment requirements are returned that are
currently active. In any status mode, active and inactive assessment
requirements are returned.assessmentRequirementId
- the Id
of the
AssessmentRequirement
to retrieve AssessmentRequirement
NotFoundException
- no AssessmentRequirement
found with the given Id
NullArgumentException
- assessmentRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentRequirementList getAssessmentRequirementsByIds(IdList assessmentRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AssessmentRequirementList
corresponding to the
given IdList.
In plenary mode, the returned list contains all of the
assessment requirements specified in the Id
list, in
the order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible AssessmentlRequirements
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, assessment requirements are returned that are
currently active. In any status mode, active and inactive assessment
requirements are returned.assessmentRequirementIds
- the list of Ids
to
retrieve AssessmentRequirements
NotFoundException
- an Id was
not foundNullArgumentException
- assessmentRequirementIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentRequirementList getAssessmentRequirementsByGenusType(Type assessmentRequirementGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentRequirementList
corresponding to the
given assessment requirement genus Type
which does not
include assessment requirements of types derived from the specified
Type.
In plenary mode, the returned list contains all known
assessment requirements or an error results. Otherwise, the returned
list may contain only those assessment requirements that are
accessible through this session.
In active mode, assessment requirements are returned that are
currently active. In any status mode, active and inactive assessment
requirements are returned.assessmentRequirementGenusType
- an assessment requirement genus
type AssessmentRequirements
NullArgumentException
-
assessmentRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentRequirementList getAssessmentRequirementsByParentGenusType(Type assessmentRequirementGenusType) throws OperationFailedException, PermissionDeniedException
AssessmentRequirementList
corresponding to the
given assessment requirement genus Type
and include any
additional assessment requirements with genus types derived from the
specified Type.
In plenary mode, the returned list contains all known
assessment requirements or an error results. Otherwise, the returned
list may contain only those assessment requirements that are
accessible through this session.
In active mode, assessment requirements are returned that are
currently active. In any status mode, active and inactive assessment
requirements are returned.assessmentRequirementGenusType
- an assessment requirements
genus type AssessmentRequirements
NullArgumentException
-
assessmentRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentRequirementList getAssessmentRequirementsByRecordType(Type assessmentRequirementRecordType) throws OperationFailedException, PermissionDeniedException
AssessmentRequirementList
containing the given
assessment requirement record Type.
In plenary mode, the returned list contains all known assessment
requirements or an error results. Otherwise, the returned list may
contain only those assessment requirements that are accessible through
this session.
In active mode, assessment requirements are returned that are
currently active. In any status mode, active and inactive assessment
requirements are returned.assessmentRequirementRecordType
- an assessment requirement
record type AssessmentRequirements
NullArgumentException
-
assessmentRequirementRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentRequirementList getAssessmentRequirementsByAssessment(Id assessmentId) throws OperationFailedException, PermissionDeniedException
AssessmentRequirementList
containing the given
assessment. In plenary mode, the returned list contains all known
assessment requirements or an error results. Otherwise, the returned
list may contain only those assessment requirements that are
accessible through this session.assessmentId
- an assessment Id
AssessmentRequirements
NullArgumentException
- assessmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentRequirementList getAssessmentRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
AssessmentRequirementList
with the given
Requisite.
In plenary mode, the returned list contains all known assessment
requirements or an error results. Otherwise, the returned list may
contain only those assessment requirements that are accessible through
this session.
In active mode, assessment requirements are returned that are
currently active. In any status mode, active and inactive assessment
requirements are returned.requisiteId
- a requisite Id
AssessmentRequirements
NullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesForAssessmentRequirement(Id assessmentRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteList
immediately containing the given
assessment requirement.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, assessment requirements are processed and requisites
are returned that are currently active. In any status mode, active and
inactive assessment requirements are returned.assessmentRequirementId
- an assessment requirement Id
Requisites
NullArgumentException
- assessmentRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AssessmentRequirementList getAssessmentRequirements() throws OperationFailedException, PermissionDeniedException
AssessmentRequirements.
In plenary mode, the returned list contains all known assessment
requirements or an error results. Otherwise, the returned list may
contain only those assessment requirements that are accessible through
this session.
In active mode, assessment requirements are returned that are
currently active. In any status mode, active and inactive assessment
requirements are returned. AssessmentRequirements
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardRequirement getAwardRequirement(Id awardRequirementId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AwardRequirement
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
AwardRequirement
may have a different Id
than
requested, such as the case where a duplicate Id
was
assigned to an AwardRequirement
and retained for
compatibility.
In active mode, award requirements are returned that are currently
active. In any status mode, active and inactive award requirements are
returned.awardRequirementId
- the Id
of the
AwardRequirement
to retrieve AwardRequirement
NotFoundException
- no AwardRequirement
found with the given Id
NullArgumentException
- awardRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardRequirementList getAwardRequirementsByIds(IdList awardRequirementIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
AwardRequirementList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
award requirements specified in the Id
list, in the
order of the list, including duplicates, or an error results if an
Id
in the supplied list is not found or inaccessible.
Otherwise, inaccessible AwardlRequirements
may be
omitted from the list and may present the elements in any order
including returning a unique set.
In active mode, award requirements are returned that are currently
active. In any status mode, active and inactive award requirements are
returned.awardRequirementIds
- the list of Ids
to retrieve AwardRequirements
NotFoundException
- an Id was
not foundNullArgumentException
- awardRequirementIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardRequirementList getAwardRequirementsByGenusType(Type awardRequirementGenusType) throws OperationFailedException, PermissionDeniedException
AwardRequirementList
corresponding to the given
award requirement genus Type
which does not include
award requirements of types derived from the specified Type.
In plenary mode, the returned list contains all known
award requirements or an error results. Otherwise, the returned list
may contain only those award requirements that are accessible through
this session.
In active mode, award requirements are returned that are currently
active. In any status mode, active and inactive award requirements are
returned.awardRequirementGenusType
- an award requirement genus type AwardRequirements
NullArgumentException
-
awardRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardRequirementList getAwardRequirementsByParentGenusType(Type awardRequirementGenusType) throws OperationFailedException, PermissionDeniedException
AwardRequirementList
corresponding to the given
award requirement genus Type
and include any additional
award requirements with genus types derived from the specified
Type.
In plenary mode, the returned list contains all known
award requirements or an error results. Otherwise, the returned list
may contain only those award requirements that are accessible through
this session.
In active mode, award requirements are returned that are currently
active. In any status mode, active and inactive award requirements are
returned.awardRequirementGenusType
- an award requirements genus type AwardRequirements
NullArgumentException
-
awardRequirementGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardRequirementList getAwardRequirementsByRecordType(Type awardRequirementRecordType) throws OperationFailedException, PermissionDeniedException
AwardRequirementList
containing the given award
requirement record Type.
In plenary mode, the returned list contains all known award
requirements or an error results. Otherwise, the returned list may
contain only those award requirements that are accessible through this
session.
In active mode, award requirements are returned that are currently
active. In any status mode, active and inactive award requirements are
returned.awardRequirementRecordType
- an award requirement record type AwardRequirements
NullArgumentException
-
awardRequirementRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardRequirementList getAwardRequirementsByAward(Id awardId) throws OperationFailedException, PermissionDeniedException
AwardRequirementList
containing the given
award.
In plenary mode, the returned list contains all known award
requirements or an error results. Otherwise, the returned list may
contain only those award requirements that are accessible through this
session.
In active mode, award requirements are returned that are currently
active. In any status mode, active and inactive award requirements are
returned.awardId
- an award Id
AwardRequirements
NullArgumentException
- awardId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardRequirementList getAwardRequirementsByAltRequisite(Id requisiteId) throws OperationFailedException, PermissionDeniedException
AwardRequirementList
with the given
Requisite.
In plenary mode, the returned list contains all known award
requirements or an error results. Otherwise, the returned list may
contain only those award requirements that are accessible through this
session.
In active mode, award requirements are returned that are currently
active. In any status mode, active and inactive award requirements are
returned.requisiteId
- a requisite Id
AwardRequirements
NullArgumentException
- requisiteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RequisiteList getRequisitesForAwardRequirement(Id awardRequirementId) throws OperationFailedException, PermissionDeniedException
RequisiteList
immediately containing the given
award requirement.
In plenary mode, the returned list contains all known requisites or an
error results. Otherwise, the returned list may contain only those
requisites that are accessible through this session.
In active mode, award requirements are processed and requisites are
returned that are currently active. In any status mode, active and
inactive requisites are returned.awardRequirementId
- an award requirement Id
Requisites
NullArgumentException
- awardRequirementId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AwardRequirementList getAwardRequirements() throws OperationFailedException, PermissionDeniedException
AwardRequirements.
In plenary mode, the returned list contains all known award
requirements or an error results. Otherwise, the returned list may
contain only those award requirements that are accessible through this
session.
In active mode, award requirements are returned that are currently
active. In any status mode, active and inactive award requirements are
returned. AwardRequirements
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.