org.ametys.odf.program

Class Container

java.lang.Object

org.ametys.plugins.repository.AbstractAmetysObject

org.ametys.plugins.repository.jcr.SimpleAmetysObject<F>

org.ametys.plugins.repository.jcr.DefaultAmetysObject<F>

org.ametys.cms.repository.DefaultContent<F>

org.ametys.cms.repository.ModifiableDefaultContent<F>

org.ametys.odf.program.AbstractProgramPart<F>

org.ametys.odf.program.AbstractTraversableProgramPart<ContainerFactory>

org.ametys.odf.program.Container

All Implemented Interfaces:

CommentableContent, Content, ModifiableContent, ModifiableWorkflowAwareContent, TagAwareAmetysObject, TaggableAmetysObject, WorkflowAwareContent, CDMEntity, CDMFRTagsConstants, CourseListContainer, ProgramPart, TraversableProgramPart, ProgramItem, ACLAmetysObject, AmetysObject, CopiableAmetysObject, DublinCoreAwareAmetysObject, ModifiableDublinCoreAwareAmetysObject, JCRAmetysObject, JCRTraversableAmetysObject, LockableAmetysObject, LockAwareAmetysObject, MetadataAwareAmetysObject, ModifiableMetadataAwareAmetysObject, ModifiableACLAmetysObject, ModifiableAmetysObject, ModifiableTraversableAmetysObject, RemovableAmetysObject, TraversableAmetysObject, MetadataAndVersionAwareAmetysObject, ModifiableMetadataAwareVersionableAmetysObject, VersionableAmetysObject, VersionAwareAmetysObject, WorkflowAwareAmetysObject

public class Container
extends AbstractTraversableProgramPart<ContainerFactory>
implements CourseListContainer

Container java object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CODE Constants for code metadata
static String	DESCRIPTION Constants for description metadata
static String	ECTS Constants for ects metadata
static String	NATURE Constants for nature metadata*
static String	PERIOD Constants for period metadata

Fields inherited from class org.ametys.cms.repository.DefaultContent

ATTACHMENTS_NODE_NAME, DEFAULT_CONTENT_LOCALE, METADATA_CONTENTTYPE, METADATA_CONTRIBUTOR, METADATA_CREATION, METADATA_CREATOR, METADATA_LANGUAGE, METADATA_LAST_MAJORVALIDATION, METADATA_LAST_VALIDATION, METADATA_MIXINCONTENTTYPES, METADATA_MODIFIED, METADATA_OUTGOING_REFERENCE_PROPERTY, METADATA_OUTGOING_REFERENCES, METADATA_OUTGOING_REFERENCES_PATH_PROPERTY, METADATA_ROOT_OUTGOING_REFERENCES, METADATA_TITLE

Fields inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

PROTECTED_PROPERTIES

Fields inherited from interface org.ametys.odf.program.TraversableProgramPart

METADATA_CHILD_PROGRAM_PARTS

Fields inherited from interface org.ametys.odf.program.ProgramPart

METADATA_PARENT_PROGRAM_PARTS

Fields inherited from interface org.ametys.odf.ProgramItem

METADATA_CATALOG, METADATA_CODE, PROGRAM_ITEM_CONTENT_TYPE

Fields inherited from interface org.ametys.odf.cdmfr.CDMEntity

CDM_CODE

Fields 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_TP

Constructor Summary

Constructors

Constructor and Description
Container(Node node, String parentPath, ContainerFactory factory) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	containsCourseList(String clId) Determines if this CourseListContainer contains the given course list as child
protected String	getCDMType() Get the type of this ProgramPart in CDM.
List<CourseList>	getCourseLists() Returns the child course lists
RichText	getDescription() Get the description
double	getEcts() Get the ECTS credits
String	getNature() Get the nature
String	getPeriod() Get the period
boolean	hasCourseLists() Determines if this CourseListContainer contains child course list

Methods inherited from class org.ametys.odf.program.AbstractTraversableProgramPart

containsProgramPart, getProgramPartChildren, hasProgramPartChildren

Methods inherited from class org.ametys.odf.program.AbstractProgramPart

getCatalog, getCdmCode, getCDMId, getCode, getProgramPartParents, getRootPrograms, setCatalog, setCdmCode, setCode

Methods inherited from class org.ametys.cms.repository.ModifiableDefaultContent

createComment, getComment, getComments, getCurrentStepId, getLockOwner, getProposalDate, getWorkflowId, isLocked, lock, remove, setCreationDate, setCreator, setCurrentStepId, setDCContributor, setDCCoverage, setDCCreator, setDCDate, setDCDescription, setDCFormat, setDCIdentifier, setDCLanguage, setDCPublisher, setDCRelation, setDCRights, setDCSource, setDCSubject, setDCTitle, setDCType, setLanguage, setLastContributor, setLastMajorValidationDate, setLastModified, setLastValidationDate, setMixinTypes, setOutgoingReferences, setProposalDate, setTitle, setTitle, setTypes, setWorkflowId, tag, unlock, untag

Methods inherited from class org.ametys.cms.repository.DefaultContent

copyTo, copyTo, copyTo, copyTo, copyTo, createChild, getChild, getChildren, getCreationDate, getCreator, getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCType, getLanguage, getLastContributor, getLastMajorValidationDate, getLastModified, getLastValidationDate, getMixinTypes, getOutgoingReferences, getReferencingContents, getRootAttachments, getTags, getTitle, getTitle, getTypes, hasChild, hasReferencingContents

Methods inherited from class org.ametys.plugins.repository.jcr.DefaultAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, addLabel, checkpoint, copyNode, getAllLabels, getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getAllRevisions, getBaseNode, getBaseVersion, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers, getLabels, getLabels, getNode, getRevision, getRevisionTimestamp, getRevisionTimestamp, getUnversionedMetadataHolder, getVersionHistory, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers, removeLabel, restoreFromLabel, restoreFromNode, restoreFromRevision, switchToLabel, switchToRevision

Methods inherited from class org.ametys.plugins.repository.jcr.SimpleAmetysObject

_getFactory, _invalidateName, _invalidateParentPath, getId, getMetadataHolder, getName, getParent, getParentPath, getPath, needsSave, rename, revertChanges, saveChanges

Methods inherited from class org.ametys.plugins.repository.AbstractAmetysObject

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.ametys.odf.program.ProgramPart

getProgramPartParents

Methods inherited from interface org.ametys.plugins.repository.jcr.JCRAmetysObject

getNode

Methods inherited from interface org.ametys.plugins.repository.metadata.ModifiableMetadataAwareAmetysObject

getMetadataHolder

Methods inherited from interface org.ametys.plugins.repository.ModifiableAmetysObject

needsSave, rename, revertChanges, saveChanges

Methods inherited from interface org.ametys.plugins.repository.AmetysObject

equals, getId, getName, getParent, getParentPath, getPath, hashCode

Methods inherited from interface org.ametys.plugins.repository.RemovableAmetysObject

remove

Methods inherited from interface org.ametys.odf.ProgramItem

getCatalog, getCode, getRootPrograms, setCatalog, setCode

Methods inherited from interface org.ametys.odf.cdmfr.CDMEntity

getCdmCode, getCDMId, getLanguage, setCdmCode

Methods inherited from interface org.ametys.cms.repository.Content

getCreationDate, getCreator, getLanguage, getLastContributor, getLastMajorValidationDate, getLastModified, getLastValidationDate, getMixinTypes, getOutgoingReferences, getReferencingContents, getRootAttachments, getTitle, getTitle, getTypes, hasReferencingContents

Methods inherited from interface org.ametys.plugins.repository.dublincore.DublinCoreAwareAmetysObject

getDCContributor, getDCCoverage, getDCCreator, getDCDate, getDCDescription, getDCFormat, getDCIdentifier, getDCLanguage, getDCPublisher, getDCRelation, getDCRights, getDCSource, getDCSubject, getDCTitle, getDCType

Methods inherited from interface org.ametys.cms.repository.TagAwareAmetysObject

getTags

Methods inherited from interface org.ametys.plugins.repository.ModifiableACLAmetysObject

addAllowedGroups, addAllowedProfilesForAnonymous, addAllowedProfilesForAnyConnectedUser, addAllowedUsers, addDeniedGroups, addDeniedProfilesForAnonymous, addDeniedProfilesForAnyConnectedUser, addDeniedUsers, removeAllowedGroups, removeAllowedGroups, removeAllowedProfilesForAnonymous, removeAllowedProfilesForAnyConnectedUser, removeAllowedUsers, removeAllowedUsers, removeDeniedGroups, removeDeniedGroups, removeDeniedProfilesForAnonymous, removeDeniedProfilesForAnyConnectedUser, removeDeniedUsers, removeDeniedUsers

Methods inherited from interface org.ametys.plugins.repository.ACLAmetysObject

getAllowedGroups, getAllowedProfilesForAnonymous, getAllowedProfilesForAnyConnectedUser, getAllowedProfilesForGroups, getAllowedProfilesForUser, getAllowedProfilesForUsers, getAllowedUsers, getDeniedGroups, getDeniedProfilesForAnonymous, getDeniedProfilesForAnyConnectedUser, getDeniedProfilesForGroups, getDeniedProfilesForUser, getDeniedProfilesForUsers, getDeniedUsers

Methods inherited from interface org.ametys.plugins.repository.TraversableAmetysObject

getChildAt, getChildPosition

Field Detail

CODE

public static final String CODE

Constants for code metadata

See Also:

Constant Field Values

ECTS

public static final String ECTS

Constants for ects metadata

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Constants for description metadata

See Also:

Constant Field Values

PERIOD

public static final String PERIOD

Constants for period metadata

See Also:

Constant Field Values

NATURE

public static final String NATURE

Constants for nature metadata*

See Also:

Constant Field Values

Constructor Detail

Container

public Container(Node node,
                 String parentPath,
                 ContainerFactory factory)

Constructor

Parameters:

node - The JCR node

parentPath - The parent path

factory - the ametys object factory

Method Detail

getEcts

public double getEcts()
               throws AmetysRepositoryException

Get the ECTS credits

Returns:

the ECTS credits

Throws:

AmetysRepositoryException - if an error occurred

getDescription

public RichText getDescription()

Get the description

Returns:

the description or null if not set

getPeriod

public String getPeriod()
                 throws AmetysRepositoryException

Get the period

Returns:

the period

Throws:

AmetysRepositoryException - if an error occurs

getNature

public String getNature()
                 throws AmetysRepositoryException

Get the nature

Returns:

the nature

Throws:

AmetysRepositoryException - if an error occurs

getCourseLists

public List<CourseList> getCourseLists()

Description copied from interface: CourseListContainer

Returns the child course lists

Specified by:

getCourseLists in interface CourseListContainer

Returns:

the child course lists

containsCourseList

public boolean containsCourseList(String clId)

Description copied from interface: CourseListContainer

Determines if this CourseListContainer contains the given course list as child

Specified by:

containsCourseList in interface CourseListContainer

Parameters:

clId - id of the CourseList to test

Returns:

true if the course list is part of this CourseListContainer

hasCourseLists

public boolean hasCourseLists()

Description copied from interface: CourseListContainer

Determines if this CourseListContainer contains child course list

Specified by:

hasCourseLists in interface CourseListContainer

Returns:

true if this CourseListContainer contains at least a child course list

getCDMType

protected String getCDMType()

Description copied from class: AbstractProgramPart

Get the type of this ProgramPart in CDM. This type compose the CDM identifier

Specified by:

getCDMType in class AbstractProgramPart<ContainerFactory>

Returns:

the type