Package org.ametys.odf.courselist
Class CourseList
java.lang.Object
- All Implemented Interfaces:
ModelAwareDataAwareAmetysObject,ModifiableModelAwareDataAwareAmetysObject,IndexableDataHolder,ModifiableIndexableDataHolder,CommentableContent,CommentableAmetysObject,Content,ModifiableContent,ModifiableWorkflowAwareContent,ReactionableObject,ReportableObject,WorkflowAwareContent,CDMEntity,CDMFRTagsConstants,CourseContainer,ProgramPart,ProgramItem,ACLAmetysObject,AmetysObject,CopiableAmetysObject,DataAwareAmetysObject,ModelAwareDataAwareAmetysObject,ModifiableModelAwareDataAwareAmetysObject,DataHolder,ModelAwareDataHolder,ModifiableDataHolder,ModifiableModelAwareDataHolder,DublinCoreAwareAmetysObject,ModifiableDublinCoreAwareAmetysObject,JCRAmetysObject,JCRTraversableAmetysObject,LockableAmetysObject,LockAwareAmetysObject,MetadataAwareAmetysObject,ModifiableMetadataAwareAmetysObject,ModifiableACLAmetysObject,ModifiableAmetysObject,ModifiableTraversableAmetysObject,RemovableAmetysObject,TagAwareAmetysObject,TaggableAmetysObject,TraversableAmetysObject,DataAndVersionAwareAmetysObject,ModifiableDataAwareVersionableAmetysObject,VersionableAmetysObject,VersionAwareAmetysObject,WorkflowAwareAmetysObject
Class representing a list of
Course-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.ametys.cms.repository.Content
Content.ReferencingContentsSearchNested classes/interfaces inherited from interface org.ametys.cms.repository.ReactionableObject
ReactionableObject.ReactionType -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringConstants for child courses attributestatic final StringConstants for choice type attributestatic final StringConstants for maximum number of courses.static final StringConstants for minimum number of courses.static final StringName of the attribute holding the direct parent coursesFields inherited from class org.ametys.cms.repository.DefaultContent
_mixins, _types, ATTACHMENTS_NODE_NAME, DEFAULT_CONTENT_LOCALE, METADATA_CONTENTTYPE, METADATA_CONTRIBUTOR, METADATA_CREATION, METADATA_CREATOR, METADATA_FIRST_VALIDATION, METADATA_FIRST_VALIDATOR, METADATA_LANGUAGE, METADATA_LAST_MAJOR_VALIDATOR, METADATA_LAST_MAJORVALIDATION, METADATA_LAST_VALIDATION, METADATA_LAST_VALIDATOR, METADATA_MIXINCONTENTTYPES, METADATA_MODIFIED, METADATA_OUTGOING_REFERENCE_NODETYPE, METADATA_OUTGOING_REFERENCE_PROPERTY, METADATA_OUTGOING_REFERENCES, METADATA_OUTGOING_REFERENCES_PATH_PROPERTY, METADATA_ROOT_OUTGOING_REFERENCESFields inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject
PROTECTED_PROPERTIESFields inherited from interface org.ametys.odf.cdmfr.CDMFRTagsConstants
ATTRIBUTE_ACTIVITY_PART_STRUCTURE, ATTRIBUTE_BLOCK_LANG, ATTRIBUTE_BUILDING, ATTRIBUTE_CODE_SET, ATTRIBUTE_COMPETENCE_YIELDING, ATTRIBUTE_COUNTY_CODE, ATTRIBUTE_COURSE_STRUCTURE, ATTRIBUTE_CURRENCY, ATTRIBUTE_DATE, ATTRIBUTE_DEGREE, ATTRIBUTE_DEGREE_NOT_LMD, ATTRIBUTE_DIPLOMA_TYPE, ATTRIBUTE_DURATION, ATTRIBUTE_ECTS_CREDITS, ATTRIBUTE_EQUIV, ATTRIBUTE_HOURS_PER_WEEK, ATTRIBUTE_ID, ATTRIBUTE_ID_REF, ATTRIBUTE_IDENT, ATTRIBUTE_LANGUAGE, ATTRIBUTE_LEVEL, ATTRIBUTE_LIB_SET, ATTRIBUTE_LIMITED, ATTRIBUTE_METHOD, ATTRIBUTE_NATURE, ATTRIBUTE_ORG, ATTRIBUTE_ORG_TYPE, ATTRIBUTE_ORG_UNIT_KIND_CODE_VALUESET, ATTRIBUTE_PLACES, ATTRIBUTE_PRICE, ATTRIBUTE_REF, ATTRIBUTE_ROLE, ATTRIBUTE_ROOM, ATTRIBUTE_START, ATTRIBUTE_STUDY_PACE, ATTRIBUTE_TEACHING_LANG, ATTRIBUTE_TEACHING_START, ATTRIBUTE_TEACHING_TYPE, ATTRIBUTE_TEL_TYPE, ATTRIBUTE_TERM, ATTRIBUTE_TIME, ATTRIBUTE_TIME_OF_DAY, ATTRIBUTE_TOTAL_WORK_LOAD, ATTRIBUTE_USER_DEFINED, NAMESPACE_AMETYS_CDM, NAMESPACE_CDMFR, PHONE_TYPE_HOME, PHONE_TYPE_MOBILE, PHONE_TYPE_OFFICE, TAG_ACTIVITY_PARTS, TAG_ADDRESS, TAG_ADMISSION_DESCRIPTION, TAG_ADMISSION_INFO, TAG_AFFILIATION, TAG_ALT_LANG_BLOCK, TAG_BIBLIOGRAPHY, TAG_CANCEL_DEADLINE, TAG_CDM, TAG_CDM_DATE_TIME, TAG_CDM_LOCATION, TAG_COMPETENCE_DESC, TAG_COMPETENCE_VALIDITY, TAG_CONTACT_DATA, TAG_CONTACT_NAME, TAG_CONTACTS, TAG_COUNTRY, TAG_COURSE, TAG_COURSE_CODE, TAG_COURSE_CONTENTS, TAG_COURSE_DESCRIPTION, TAG_COURSE_ID, TAG_COURSE_NAME, TAG_CREDITS, TAG_CRITERIA, TAG_DATE_FROM, TAG_DATE_TO, TAG_DEGREE, TAG_DEGREE_NAME, TAG_DIGIT_PROD_PERC, TAG_DIGIT_PROD_UNT_PERC, TAG_DIGITAL_USE, TAG_DIPLOMA, TAG_ECTS_REQUIRED, TAG_EMAIL, TAG_END, TAG_EVALUATION_DEADLINE, TAG_EXAM, TAG_EXAM_DURATION, TAG_EXAM_END, TAG_EXAM_KIND, TAG_EXAM_LOCATION, TAG_EXAM_NAME, TAG_EXAM_PARTS, TAG_EXAM_START, TAG_EXAM_STRUCTURE, TAG_EXISTS, TAG_EXPENSES, TAG_EXTADR, TAG_EXTENSION_BLOCK, TAG_FAMILY_NAME, TAG_FAX, TAG_FORM_OF_ASSESSMENT, TAG_FORM_OF_TEACHING, TAG_FORMAL_PREREQUISITES, TAG_GIVEN_NAME, TAG_GLOBAL_VOLUME, TAG_HABILITATION, TAG_HABILITATION_ID, TAG_HEADER, TAG_HREF, TAG_INFO_BLOCK, TAG_INSTRUCTION_LANGUAGE, TAG_LCMS, TAG_LEARNING_OBJECTIVES, TAG_LEVEL, TAG_LEVEL_CODE, TAG_LINK_NAME, TAG_LOCALITY, TAG_NAME, TAG_OCCURRENCE_RULE, TAG_ORDINARY_NAME, TAG_ORG_UNIT, TAG_ORG_UNIT_ACRONYM, TAG_ORG_UNIT_CODE, TAG_ORG_UNIT_DESCRIPTION, TAG_ORG_UNIT_ID, TAG_ORG_UNIT_KIND, TAG_ORG_UNIT_NAME, TAG_OVERLAP, TAG_PART_STRUCTURE, TAG_PCODE, TAG_PERC_OF_USE, TAG_PERCENTAGE, TAG_PERSON, TAG_PERSON_ID, TAG_PHONE, TAG_PLACE, TAG_POBOX, TAG_PPAL_TEACHING_LANGUAGE, TAG_PROD_PEDA, TAG_PROFESS_FIELD, TAG_PROFESSION, TAG_PROFESSIONAL_DIPLOMA, TAG_PROGRAM, TAG_PROGRAM_CODE, TAG_PROGRAM_DESCRIPTION, TAG_PROGRAM_DURATION, TAG_PROGRAM_ID, TAG_PROGRAM_NAME, TAG_PROGRAM_STRUCTURE, TAG_QUALIFICATION, TAG_QUALIFICATION_DESCRIPTION, TAG_QUALIFICATION_NAME, TAG_RECOMMANDED_PREREQUISITES, TAG_REF_COURSE, TAG_REF_ORG_UNIT, TAG_REF_PERSON, TAG_REF_PROGRAM, TAG_REGION, TAG_REGISTRATION_DEADLINE, TAG_REGISTRATION_DETAIL, TAG_REGISTRATION_MODALITIES, TAG_REGISTRATION_PROCESS, TAG_REGISTRATION_START, TAG_REGULATIONS, TAG_REOCCURRING_EVENTS, TAG_RESOURCE_MGT, TAG_ROLE, TAG_ROME_DATA, TAG_SEARCH_WORD, TAG_SECT_CNU, TAG_SINGLE_EVENT, TAG_START, TAG_STATISTICS, TAG_STREET, TAG_STUDENT_FACILITIES, TAG_STUDENT_PLACES, TAG_STUDENT_STATUS, TAG_STUDY_ABROAD, TAG_STUDY_FIELD, TAG_STUDY_QUALIFICATION, TAG_SUB_BLOCK, TAG_SUB_PROGRAM, TAG_SYLLABUS, TAG_TARGET_GROUP, TAG_TEACHING_ACTIVITY, TAG_TEACHING_ACTIVITY_ID, TAG_TEACHING_ACTIVITY_NAME, TAG_TEACHING_ACTIVITY_STRUCTURE, TAG_TEACHING_PLACE, TAG_TEACHING_START, TAG_TEACHING_TERM, TAG_TEXT, TAG_TIME_FROM, TAG_TIME_OF_DAY, TAG_TIME_TO, TAG_TIMETABLE_ELEMENT, TAG_TITLE, TAG_UNIVERSAL_ADJUSTMENT, TAG_WEB_LINK, VALUE_A_CHOIX, VALUE_APPRENTICESHIP, VALUE_AREA, VALUE_AS_DEGREE, VALUE_ASSOCIATED_LABORITORIES, VALUE_ASSOCIATED_SCHOOLS, VALUE_CITE97, VALUE_COMPLEMENTARY_INFORMATIONS, VALUE_COMPONENT, VALUE_CONTINUE, VALUE_COURSE_STRUCTURE, VALUE_DEGREE, VALUE_DES, VALUE_DIP, VALUE_DISTANCE, VALUE_DOWNLOADING, VALUE_DUREE, VALUE_EC, VALUE_EDUCATION_TYPE, VALUE_ERASMUS, VALUE_FACULTATIVE, VALUE_FINALITE, VALUE_FORMCONTNONDIP, VALUE_FR_FR, VALUE_FRENCHLANGUAGE, VALUE_INIT, VALUE_INTERNATIONAL, VALUE_INTERNSHIP, VALUE_KNOWLEDGES, VALUE_KNOWMORELINK, VALUE_MENTION, VALUE_OBJECTIVES, VALUE_OBLIGATOIRE, VALUE_ORG_UNIT_PARENT, VALUE_PRESENCE, VALUE_PRESENTATION, VALUE_PRO, VALUE_PROFESSIONAL, VALUE_PROFESSIONAL_OBJECTIVES, VALUE_PURSUING, VALUE_RNCP, VALUE_SCHOOLPATH, VALUE_SISE, VALUE_SPECIALITY, VALUE_STAGE, VALUE_SUBPROG_TYPE, VALUE_TYPE, VALUE_UE, VALUE_UECONTAINER, VALUE_UEGROUP, VALUE_UNIVERSITY, VALUE_UNRLR, VALUE_VOLUME_HORAIRE, VALUE_VOLUME_HORAIRE_COURS, VALUE_VOLUME_HORAIRE_TD, VALUE_VOLUME_HORAIRE_TPFields inherited from interface org.ametys.cms.repository.Content
ATTRIBUTE_TITLE, METADATA_TITLEFields inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder
ALTERNATIVE_SUFFIX, COMMENTS_SUFFIX, STATUS_SUFFIXFields inherited from interface org.ametys.odf.ProgramItem
CATALOG, CODE, EDUCATIONAL_BOOKLETS, PROGRAM_ITEM_CONTENT_TYPE, PUBLISHABLEFields inherited from interface org.ametys.odf.program.ProgramPart
PARENT_PROGRAM_PARTS -
Constructor Summary
ConstructorsConstructorDescriptionCourseList(javax.jcr.Node node, String parentPath, CourseListFactory factory) Constructor -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsCourse(String courseId) Determines if the container contains a coursesprotected StringGet the type of thisProgramPartin CDM.Get the list of childCourselongIf this set of teaching unit element is a type of choice this method return the maximum number of teaching unit element that this set of teaching unit element must contains else -1.longIf this set of teaching unit element is a type of choice this method return the minimum number of teaching unit elements that the student must choose else -1.Get the ids of parent coursesgetType()Indicates whether the teaching unit elements contained are mandatory, optional or a choice.booleanDetermines if the container contains coursesMethods inherited from class org.ametys.odf.program.AbstractProgramPart
getCatalog, getCdmCode, getCDMId, getCode, getProgramPartParents, isPublishable, setCatalog, setCdmCode, setCode, setPublishableMethods inherited from class org.ametys.cms.repository.ModifiableDefaultContent
createComment, createComment, fillContent, getComment, getComments, getCurrentStepId, getDataHolder, getLockOwner, getProposalDate, getWorkflowId, isLocked, lock, remove, setCreationDate, setCreator, setCurrentStepId, setDCContributor, setDCCoverage, setDCCreator, setDCDate, setDCDescription, setDCFormat, setDCIdentifier, setDCLanguage, setDCPublisher, setDCRelation, setDCRights, setDCSource, setDCSubject, setDCTitle, setDCType, setFirstValidationDate, setFirstValidator, setLastContributor, setLastMajorValidationDate, setLastMajorValidator, setLastModified, setLastValidationDate, setLastValidator, setOutgoingReferences, setProposalDate, setTitle, setTitle, setWorkflowId, tag, unlock, untagMethods inherited from class org.ametys.cms.repository.DefaultContent
addReaction, addReport, clearReports, copyTo, copyTo, copyTo, copyTo, createChild, getChild, getChildren, getCreationDate, getCreator, getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCType, getFirstValidationDate, getFirstValidator, getInternalDataHolder, getLanguage, getLastContributor, getLastMajorValidationDate, getLastMajorValidator, getLastModified, getLastValidationDate, getLastValidator, getMixinTypes, getOutgoingReferences, getReactionUsers, getReferencingContents, getReportsCount, getRootAttachments, getSystemPropertyExtensionPoint, getTags, getTitle, getTitle, getTypes, hasChild, hasReferencingContents, removeReaction, searchReferencingContents, setLanguage, setMixinTypes, setReportsCount, setType, setTypes, toSAXMethods inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject
addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, addLabel, checkpoint, copyNode, disallowInheritance, getAllLabels, getAllRevisions, getBaseNode, getBaseVersion, getLabels, getLabels, getNode, getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, getRevision, getRevisionTimestamp, getRevisionTimestamp, getUnversionedDataHolder, getVersionHistory, isInheritanceDisallowed, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers, removeLabel, restoreFromLabel, restoreFromNode, restoreFromRevision, switchToLabel, switchToRevisionMethods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject
_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getParent, getParentPath, getPath, needsSave, rename, revertChanges, saveChangesMethods inherited from class org.ametys.plugins.repository.AbstractAmetysObject
equals, hashCode, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.ametys.plugins.repository.ACLAmetysObject
getProfilesForAnonymousAndAnyConnectedUser, getProfilesForGroups, getProfilesForUsers, isInheritanceDisallowedMethods inherited from interface org.ametys.plugins.repository.AmetysObject
equals, getId, getName, getParent, getParentPath, getPath, hashCodeMethods inherited from interface org.ametys.odf.cdmfr.CDMEntity
getLanguageMethods inherited from interface org.ametys.cms.repository.Content
getCreationDate, getCreator, getFirstValidationDate, getFirstValidator, getInternalDataHolder, getLanguage, getLastContributor, getLastMajorValidationDate, getLastMajorValidator, getLastModified, getLastValidationDate, getLastValidator, getMixinTypes, getOutgoingReferences, getReferencingContents, getRootAttachments, getTitle, getTitle, getTypes, hasReferencingContents, searchReferencingContents, setLanguage, setMixinTypes, setType, setTypes, toSAXMethods inherited from interface org.ametys.plugins.repository.data.ametysobject.DataAwareAmetysObject
copyTo, dataToJSON, dataToJSON, dataToSAX, dataToSAXMethods inherited from interface org.ametys.plugins.repository.dublincore.DublinCoreAwareAmetysObject
getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCTypeMethods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject
getNodeMethods inherited from interface org.ametys.cms.data.ametysobject.ModelAwareDataAwareAmetysObject
getComposite, getExternalComposite, getExternalRepeater, getLocalComposite, getLocalRepeater, getParentDataHolder, getRepeater, getRootDataHolder, getSystemPropertyExtensionPoint, indexData, indexDataMethods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModelAwareDataAwareAmetysObject
dataToJSON, dataToJSONForEdition, dataToMap, dataToSAX, dataToSAXForEdition, getComments, getDataNames, getDefinition, getExternalValue, getLocalValue, getModel, getStatus, getValue, getValue, hasComments, hasDefinition, hasExternalValue, hasExternalValueOrEmpty, hasLocalValue, hasLocalValueOrEmpty, hasValue, hasValueOrEmptyMethods inherited from interface org.ametys.plugins.repository.data.holder.ModelAwareDataHolder
commentsToSAX, dataToJSON, dataToJSON, dataToJSON, dataToMap, dataToMap, dataToMap, dataToSAX, dataToSAX, dataToSAX, getDataNames, getType, getValue, hasValue, hasValueOrEmpty, isMultipleMethods inherited from interface org.ametys.plugins.repository.ModifiableACLAmetysObject
addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, disallowInheritance, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsersMethods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject
needsSave, rename, revertChanges, saveChangesMethods inherited from interface org.ametys.plugins.repository.data.holder.ModifiableDataHolder
getRepositoryDataMethods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject
getMetadataHolderMethods inherited from interface org.ametys.cms.data.ametysobject.ModifiableModelAwareDataAwareAmetysObject
getComposite, getComposite, getExternalComposite, getExternalComposite, getExternalRepeater, getExternalRepeater, getLocalComposite, getLocalComposite, getLocalRepeater, getLocalRepeater, getParentDataHolder, getRepeater, getRepeater, getRootDataHolderMethods inherited from interface org.ametys.plugins.repository.data.ametysobject.ModifiableModelAwareDataAwareAmetysObject
getRepositoryData, removeExternalizableMetadataIfExists, removeExternalValue, removeLocalValue, removeValue, setComments, setExternalValue, setLocalValue, setStatus, setValue, synchronizeValues, synchronizeValues, synchronizeValues, synchronizeValuesMethods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject
removeMethods inherited from interface org.ametys.plugins.repository.tag.TagAwareAmetysObject
getTagsMethods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject
getChildAt, getChildPosition
-
Field Details
-
CHOICE_TYPE
Constants for choice type attribute- See Also:
-
MIN_COURSES
Constants for minimum number of courses. This attribute is valued only if type isCourseList.ChoiceType.CHOICE- See Also:
-
MAX_COURSES
Constants for maximum number of courses. This attribute is valued only if type isCourseList.ChoiceType.CHOICE- See Also:
-
CHILD_COURSES
Constants for child courses attribute- See Also:
-
PARENT_COURSES
Name of the attribute holding the direct parent courses- See Also:
-
-
Constructor Details
-
CourseList
Constructor- Parameters:
node- The JCR nodeparentPath- The parent pathfactory- the factory
-
-
Method Details
-
getCourses
Description copied from interface:CourseContainerGet the list of childCourse- Specified by:
getCoursesin interfaceCourseContainer- Returns:
- the courses id in a List
-
containsCourse
Description copied from interface:CourseContainerDetermines if the container contains a courses- Specified by:
containsCoursein interfaceCourseContainer- Parameters:
courseId- id of theCourseto test- Returns:
- true if the course exists
-
hasCourses
Description copied from interface:CourseContainerDetermines if the container contains courses- Specified by:
hasCoursesin interfaceCourseContainer- Returns:
- true if the container contains at least one course
-
getMinNumberOfCourses
If this set of teaching unit element is a type of choice this method return the minimum number of teaching unit elements that the student must choose else -1.- Returns:
- the minimum number of teaching unit element that the student must choose. 0 if not set
-
getMaxNumberOfCourses
If this set of teaching unit element is a type of choice this method return the maximum number of teaching unit element that this set of teaching unit element must contains else -1.- Returns:
- the maximum number of teaching unit element that this set of teaching unit element must contains.
-
getType
Indicates whether the teaching unit elements contained are mandatory, optional or a choice.- Returns:
- the type of the teaching unit elements contained.
-
getParentCourses
Get the ids of parent courses- Returns:
- the ids of parent courses
-
getCDMType
Description copied from class:AbstractProgramPartGet the type of thisProgramPartin CDM. This type compose the CDM identifier- Specified by:
getCDMTypein classAbstractProgramPart<CourseListFactory>- Returns:
- the type
-