Package org.ametys.odf.data

Class EducationalPath

java.lang.Object

org.ametys.odf.data.EducationalPath

public class EducationalPath
extends Object

Class representing an educational path of a ProgramItem

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH_SEGMENT_SEPARATOR	The separator for path segment
static final String	PATH_SEGMENTS_IDENTIFIER	The program items identifier

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
List<String>	getProgramItemIds()	Retrieves the program item ids that are the segment of this path
List<ProgramItem>	getProgramItems(AmetysObjectResolver resolver)	Get ProgramItems that composed this educational path as an unmodifiable list
int	hashCode()
static EducationalPath	of(String... programItemIds)	Build a educational path
static EducationalPath	of(EducationalPath parentPath, String... programItemIds)	Build a educational path from a parent education path
static EducationalPath	of(EducationalPath parentPath, ProgramItem... programItem)	Build a educational path from a parent education path
static EducationalPath	of(ProgramItem... programItems)	Build a educational path
Stream<ProgramItem>	resolveProgramItems(AmetysObjectResolver resolver)	Resolve ProgramItems that composed this educational path
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

PATH_SEGMENTS_IDENTIFIER

public static final String PATH_SEGMENTS_IDENTIFIER

The program items identifier

See Also:

• Constant Field Values

PATH_SEGMENT_SEPARATOR

public static final String PATH_SEGMENT_SEPARATOR

The separator for path segment

See Also:

• Constant Field Values

Method Details

of

public static EducationalPath of(String... programItemIds)

Build a educational path

Parameters:

programItemIds - the ids of program items

Returns:

the educational path

of

public static EducationalPath of(EducationalPath parentPath,
 String... programItemIds)

Build a educational path from a parent education path

Parameters:

parentPath - The parent educational path

programItemIds - the ids of program items

Returns:

the educational path

of

public static EducationalPath of(EducationalPath parentPath,
 ProgramItem... programItem)

Build a educational path from a parent education path

Parameters:

parentPath - The parent educational path

programItem - the program items

Returns:

the educational path

of

public static EducationalPath of(ProgramItem... programItems)

Build a educational path

Parameters:

programItems - the program items

Returns:

the educational path

getProgramItemIds

public List<String> getProgramItemIds()

Retrieves the program item ids that are the segment of this path

Returns:

the program item ids

getProgramItems

public List<ProgramItem> getProgramItems(AmetysObjectResolver resolver)

Get ProgramItems that composed this educational path as an unmodifiable list

Parameters:

resolver - the ametys object resolver

Returns:

the ProgramItems of this path

resolveProgramItems

public Stream<ProgramItem> resolveProgramItems(AmetysObjectResolver resolver)

Resolve ProgramItems that composed this educational path

Parameters:

resolver - the ametys object resolver

Returns:

the ProgramItems of this path

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object